Pure1 Reference
Client
Pure1 REST Client Factory Method
Importable as
from pypureclient.pure1 import Client
- pypureclient.pure1.client.Client(version: str = '1.7', app_id: str = None, id_token: str = None, private_key_file: str = None, private_key_password: str = None, retries: int = 5, timeout: Union[int, Tuple[float, float]] = 15.0, configuration: Configuration = None, model_attribute_error_on_none: bool = True)
Initialize a Pure1 Client.
- Parameters
version (str, optional) – REST API version to use. Defaults to the most recent version.
app_id (str, optional) – The registered App ID for Pure1 to use. Defaults to the set environment variable under PURE1_APP_ID.
id_token (str, optional) – The ID token to use. Overrides given App ID and private key. Defaults to environment variable set under PURE1_ID_TOKEN.
private_key_file (str, optional) – The path of the private key to use. Defaults to the set environment variable under PURE1_PRIVATE_KEY_FILE.
private_key_password (str, optional) – The password of the private key, if encrypted. Defaults to the set environment variable under PURE1_PRIVATE_KEY_PASSWORD. Defaults to None.
retries (int, optional) – The number of times to retry an API call if it failed for a non-blocking reason. Defaults to 5.
timeout (int or (float, float), optional) – The timeout duration in seconds, either in total time or (connect and read) times. Defaults to 15 total.
configuration (Configuration, optional) – configuration object to use.
model_attribute_error_on_none (bool, optional) – Controls model instance behaviour with regard to accessing attributes with None value. raise an AttributeError if attribute value is None, otherwise returns None. Defaults to True for backward compatibility with older versions of the SDK.
- Raises
PureError – If it could not create an ID or access token
Pure1 REST 1.7 Client
- class pypureclient.pure1.Pure1_1_7.client.Client(configuration: Configuration, app_id: str = None, id_token: str = None, private_key_file: str = None, private_key_password: str = None, retries: int = None, timeout: Union[int, Tuple[float, float]] = None, user_agent=None)
A client for making REST API calls to Pure1.
- __init__(configuration: Configuration, app_id: str = None, id_token: str = None, private_key_file: str = None, private_key_password: str = None, retries: int = None, timeout: Union[int, Tuple[float, float]] = None, user_agent=None)
Initialize a Pure1 Client.
- Parameters
configuration (Configuration) – configuration object
app_id (str, optional) – The registered App ID for Pure1 to use. Defaults to the set environment variable under PURE1_APP_ID.
id_token (str, optional) – The ID token to use. Overrides given App ID and private key. Defaults to environment variable set under PURE1_ID_TOKEN.
private_key_file (str, optional) – The path of the private key to use. Defaults to the set environment variable under PURE1_PRIVATE_KEY_FILE.
private_key_password (str, optional) – The password of the private key, if encrypted. Defaults to the set environment variable under PURE1_PRIVATE_KEY_PASSWORD. Defaults to None.
retries (int, optional) – The number of times to retry an API call if it failed for a non-blocking reason. Defaults to 5.
timeout (float or (float, float), optional) – The timeout duration in seconds, either in total time or (connect and read) times. Defaults to 15.0 total.
user_agent (str, optional) – User-Agent request header to use.
- Raises
PureError – If it could not create an ID or access token
- delete_arrays_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Delete array tags
Deletes array tags from Pure1.
- Parameters
resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
keys (List[str]) – A comma-separated list of tag keys. Single quotes are required around all strings.
namespaces (List[str]) – A comma-separated list of namespaces. Single quotes are required around all strings.
resource_ids (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.
resource_names (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_access_token(refresh=False)
Get the last used access token.
- Parameters
refresh (bool, optional) – Whether to retrieve a new access token. Defaults to False.
- Returns
str
- Raises
PureError – If there was an error retrieving an access token.
- get_alerts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get alerts
Retrieves information about alerts generated by Pure1-monitored appliances.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_arrays(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, fqdns: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get arrays
Retrieves information about FlashArray and FlashBlade storage appliances.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
fqdns (List[str]) – A comma-separated list of resource FQDNs. If there is not at least one resource that matches each fqdn element, an error is returned. Single quotes are required around all strings.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_arrays_support_contracts(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, offset: Optional[ConstrainedIntValue] = None, resource_fqdns: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get array support contracts
Retrieves the support contracts associated with arrays.
- Parameters
resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
offset (int) – The offset of the first resource to return from a collection.
resource_fqdns (List[str]) – A comma-separated list of resource FQDNs. If there is not at least one resource that matches each resource_fqdn element, an error is returned. Single quotes are required around all strings.
resource_ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.
resource_names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_arrays_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get array tags
Retrieves the tags associated with specified arrays.
- Parameters
resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
keys (List[str]) – A comma-separated list of tag keys. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
namespaces (List[str]) – A comma-separated list of namespaces. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
resource_ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.
resource_names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_assessment_security_anomalies(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get security anomalies
Retrieves security anomalies detected on Pure Storage appliances. Results can be filtered by id, type, and status, and sorted by any of those fields.
- Parameters
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_assessment_security_cves(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get common vulnerabilities and exposures
Retrieves common vulnerabilities and exposures (CVEs) and their details, including description, severity, affected and fixed versions, affected appliances, and link to additional information. Results can be filtered by id, severity, and cvss_score, and sorted by any of those fields.
- Parameters
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_assessment_security_insights_arrays(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get appliance security insights information.
Retrieves information about FlashArray and FlashBlade insights connected to security assessment.
- Parameters
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_assessment_sustainability_arrays(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, fqdns: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get appliance sustainability information.
Retrieves information about FlashArray and FlashBlade size, power consumption, heat generation and its sustainability assessment.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
fqdns (List[str]) – A comma-separated list of resource FQDNs. If there is not at least one resource that matches each fqdn element, an error is returned. Single quotes are required around all strings.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_assessment_sustainability_insights_arrays(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get appliance sustainability insights information.
Retrieves information about FlashArray and FlashBlade insights connected to sustainability assessment.
- Parameters
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_audits(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get audits
Retrieves audit objects.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_blades(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get blades
Retrieves information about FlashBlade blades.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_bucket_replica_links(targets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, target_ids: Optional[ConstrainedListValue[StrictStr]] = None, target_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get bucket replica links
Retrieves information about bucket replica links.
- Parameters
targets (ReferenceType or List[ReferenceType], optional) – A list of targets to query for. Overrides target_ids and target_names keyword arguments.
sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A list of member IDs. Member IDs separated by a + indicate that both members must be present in each element. Member IDs separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member IDs separated by a + must be entered in the same item cell.
member_names (List[str]) – A list of member names. Member names separated by a + indicate that both members must be present in each element. Member names separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member names separated by a + must be entered in the same item cell.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids (List[str]) – A list of source IDs. Source IDs separated by a + indicate that both sources must be present in each element. Source IDs separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source IDs separated by a + must be entered in the same item cell.
source_names (List[str]) – A list of source names. Source names separated by a + indicate that both sources must be present in each element. Source names separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source names separated by a + must be entered in the same item cell.
target_ids (List[str]) – A list of target IDs. Target IDs separated by a + indicate that both targets must be present in each element. Target IDs separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target IDs separated by a + must be entered in the same item cell.
target_names (List[str]) – A list of target names. Target names separated by a + indicate that both targets must be present in each element. Target names separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target names separated by a + must be entered in the same item cell.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_buckets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get buckets
Retrieves buckets.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_controllers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get controllers
Retrieves information about controllers.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_directories(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get managed directories
Retrieves information about FlashArray managed directory objects.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
file_system_ids (List[str]) – Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The file_system_ids and file_system_names parameters cannot be provided together. Single quotes are required around all strings.
file_system_names (List[str]) – Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, filesystem1,filesystem2. The file_system_ids and file_system_names parameters cannot be provided together. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_drives(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get drives
Retrieves information about FlashArray drives.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_file_system_replica_links(targets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, target_ids: Optional[ConstrainedListValue[StrictStr]] = None, target_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get FlashBlade file system replica links
Retrieves information about FlashBlade file system replica links.
- Parameters
targets (ReferenceType or List[ReferenceType], optional) – A list of targets to query for. Overrides target_ids and target_names keyword arguments.
sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A list of member IDs. Member IDs separated by a + indicate that both members must be present in each element. Member IDs separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member IDs separated by a + must be entered in the same item cell.
member_names (List[str]) – A list of member names. Member names separated by a + indicate that both members must be present in each element. Member names separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member names separated by a + must be entered in the same item cell.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids (List[str]) – A list of source IDs. Source IDs separated by a + indicate that both sources must be present in each element. Source IDs separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source IDs separated by a + must be entered in the same item cell.
source_names (List[str]) – A list of source names. Source names separated by a + indicate that both sources must be present in each element. Source names separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source names separated by a + must be entered in the same item cell.
target_ids (List[str]) – A list of target IDs. Target IDs separated by a + indicate that both targets must be present in each element. Target IDs separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target IDs separated by a + must be entered in the same item cell.
target_names (List[str]) – A list of target names. Target names separated by a + indicate that both targets must be present in each element. Target names separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target names separated by a + must be entered in the same item cell.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_file_system_replica_links_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get FlashBlade file system replica link / policy pairs
Retrieves pairs of FlashBlade file system replica link members and their policies.
- Parameters
policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.
policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_file_system_snapshots(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get FlashBlade file system snapshots
Retrieves snapshots of FlashBlade file systems.
- Parameters
sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids (List[str]) – A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings.
source_names (List[str]) – A comma-separated list of names for the source of the object. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_file_system_snapshots_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get FlashBlade file system snapshot / policy pairs
Retrieves pairs of FlashBlade file system snapshot members and their policies.
- Parameters
policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.
policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_file_systems(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get FlashArray and FlashBlade file systems
Retrieves information about FlashArray and FlashBlade file system objects.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_file_systems_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get FlashBlade file system / policy pairs
Retrieves pairs of FlashBlade file system members and their policies.
- Parameters
policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.
policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_fleets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get fleets
Retrieves information about the fleets known to the organization.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_fleets_members(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, fleets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get fleet / member pairs
Retrieves pairs of fleet references and their members.
- Parameters
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
fleets (ReferenceType or List[ReferenceType], optional) – A list of fleets to query for. Overrides fleet_ids and fleet_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
fleet_ids (List[str]) – A comma-separated list of fleet IDs. If there is not at least one resource that matches each fleet_id element, an error is returned. The fleet_ids and fleet_names parameters cannot be set together. Single quotes are required around all strings.
fleet_names (List[str]) – A comma-separated list of fleet names. If there is not at least one resource that matches each fleet_name element, an error is returned. The fleet_ids and fleet_names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_hardware(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get hardware
Retrieves information about hardware components.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_hardware_connectors(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get hardware connectors
Retrieves information about FlashBlade hardware connectors.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_invoices(subscriptions: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, offset: Optional[ConstrainedIntValue] = None, partner_purchase_orders: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, subscription_ids: Optional[ConstrainedListValue[StrictStr]] = None, subscription_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get invoices
Retrieves information about Pure1 subscription invoices.
- Parameters
subscriptions (ReferenceType or List[ReferenceType], optional) – A list of subscriptions to query for. Overrides subscription_ids and subscription_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
offset (int) – The offset of the first resource to return from a collection.
partner_purchase_orders (List[str]) – A comma-separated list of partner purchase order numbers. If there is not at least one resource that matches each partner_purchase_order element, an error is returned. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
subscription_ids (List[str]) – A comma-separated list of subscription IDs. If there is not at least one resource that matches each subscription.id element, an error is returned. Single quotes are required around all strings.
subscription_names (List[str]) – A comma-separated list of subscription names. If there is not at least one resource that matches each subscription.name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_metrics(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_types: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get metrics
Retrieves information about metrics that can be queried for.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
resource_types (List[str]) – The resource types to list the available metrics. Valid values are arrays, buckets, directories, file-systems, pods, subscription-licenses and volumes. A metric can belong to a combination of resources, e.g., write-iops from array to pod. In that case, query by [‘arrays’, ‘pods’]. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_metrics_history(aggregation: StrictStr, end_time: StrictInt, resolution: StrictInt, start_time: StrictInt, resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get metrics history
Retrieves historical metric data for resources. This endpoint supports batching: Up to 32 time series can be retrieved in one call. It can be multiple metrics for one resource, (e.g., load and bandwidth for one array - 2 time series), one metric for multiple resource (e.g., load for arrayA and arrayB - 2 time series), or a combination of both, multiple metrics for multiple resources, (e.g., load and bandwidth for arrayA and arrayB - 4 time series).
- Parameters
aggregation (str) – Aggregation needed on the metric data. Valid values are avg and max. Single quotes are required around all strings. Latency metrics averages are weighted by the IOPS. (required)
end_time (int) – Timestamp of when the time window ends. Measured in milliseconds since the UNIX epoch. (required)
resolution (int) – The duration of time between individual data points, in milliseconds. (required)
start_time (int) – Timestamp of when the time window starts. Measured in milliseconds since the UNIX epoch. (required)
resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
ids (List[str]) – REQUIRED: either ids or names. A comma-separated list of object IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.
names (List[str]) – REQUIRED: either names or ids. A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.
resource_ids (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.
resource_names (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_network_interfaces(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get network interfaces
Retrieves information about physical and virtual network interface objects.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_object_store_accounts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get object store accounts
Retrieves object store accounts.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_pod_replica_links(targets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, target_ids: Optional[ConstrainedListValue[StrictStr]] = None, target_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get pod replica links
Retrieves information about pod replica links.
- Parameters
targets (ReferenceType or List[ReferenceType], optional) – A list of targets to query for. Overrides target_ids and target_names keyword arguments.
sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A list of member IDs. Member IDs separated by a + indicate that both members must be present in each element. Member IDs separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member IDs separated by a + must be entered in the same item cell.
member_names (List[str]) – A list of member names. Member names separated by a + indicate that both members must be present in each element. Member names separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member names separated by a + must be entered in the same item cell.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids (List[str]) – A list of source IDs. Source IDs separated by a + indicate that both sources must be present in each element. Source IDs separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source IDs separated by a + must be entered in the same item cell.
source_names (List[str]) – A list of source names. Source names separated by a + indicate that both sources must be present in each element. Source names separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source names separated by a + must be entered in the same item cell.
target_ids (List[str]) – A list of target IDs. Target IDs separated by a + indicate that both targets must be present in each element. Target IDs separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target IDs separated by a + must be entered in the same item cell.
target_names (List[str]) – A list of target names. Target names separated by a + indicate that both targets must be present in each element. Target names separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target names separated by a + must be entered in the same item cell.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_pods(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get pods
Retrieves information about pod objects.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get policies
Retrieves policies and their rules.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_policies_file_system_replica_links(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get policy / FlashBlade file system replica link pairs
Retrieves pairs of policy references and their FlashBlade file system replica link members.
- Parameters
policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.
policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_policies_file_system_snapshots(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get policy / FlashBlade file system snapshot pairs
Retrieves pairs of policy references and their FlashBlade file system snapshot members.
- Parameters
policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.
policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_policies_file_systems(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get policy / FlashBlade file system pairs
Retrieves pairs of policy references and their FlashBlade file system members.
- Parameters
policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.
policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get policy / member pairs
Retrieves pairs of policy references and their members.
- Parameters
policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.
policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_ports(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get ports
Retrieves information about FlashArray ports.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_protection_group_snapshots(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get protection group snapshots
Retrieves information about snapshots of protection groups
- Parameters
sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids (List[str]) – A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings.
source_names (List[str]) – A comma-separated list of names for the source of the object. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_protection_group_snapshots_transfer(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get protection group snapshots with transfer statistics
Retrieves information about snapshots of protection groups
- Parameters
sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids (List[str]) – A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings.
source_names (List[str]) – A comma-separated list of names for the source of the object. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_recommendations(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, sort: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get recommendations
Retrieves proactive recommendations for Everpure assets across all recommendation types. Each item includes a recommendation_type field that identifies the type-specific endpoint for enriched details: /recommendations/flasharray-hardware-upgrade, /recommendations/license-upgrade, or /recommendations/support-contract-renewal.
- Parameters
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters. Filterable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id. Subsequent requests with a continuation token must be used with the same filter parameters as the original request.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). Sortable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id, created_at, _as_of. Subsequent requests with a continuation token must be used with the same sort parameters as the original request.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_recommendations_flasharray_hardware_upgrade(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, sort: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get FlashArray hardware upgrade recommendations
Retrieves FlashArray hardware upgrade recommendations. Response items include all base recommendation fields plus FlashArray hardware upgrade type-specific payload fields in a flat structure. Documented in the flasharray-hardware-upgrade-recommendation schema.
- Parameters
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters. Filterable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id. Subsequent requests with a continuation token must be used with the same filter parameters as the original request.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). Sortable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id, created_at, _as_of. Subsequent requests with a continuation token must be used with the same sort parameters as the original request.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_recommendations_license_upgrade(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, sort: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get license upgrade recommendations
Retrieves Evergreen//One license upgrade recommendations. Response items include all base recommendation fields plus license upgrade type-specific payload fields in a flat structure. Documented in the license-upgrade-recommendation schema.
- Parameters
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters. Filterable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id. Subsequent requests with a continuation token must be used with the same filter parameters as the original request.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). Sortable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id, created_at, _as_of. Subsequent requests with a continuation token must be used with the same sort parameters as the original request.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_recommendations_support_contract_renewal(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[StrictInt] = None, sort: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get support contract renewal recommendations
Retrieves support contract renewal recommendations. Response items include all base recommendation fields plus support contract renewal type-specific payload fields in a flat structure. Documented in the support-contract-renewal-recommendation schema.
- Parameters
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters. Filterable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id. Subsequent requests with a continuation token must be used with the same filter parameters as the original request.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). Sortable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id, created_at, _as_of. Subsequent requests with a continuation token must be used with the same sort parameters as the original request.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_subscription_assets(subscriptions: Optional[Union[ReferenceType, List[ReferenceType]]] = None, licenses: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, advanced_space: Optional[StrictBool] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, license_ids: Optional[ConstrainedListValue[StrictStr]] = None, license_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, subscription_ids: Optional[ConstrainedListValue[StrictStr]] = None, subscription_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get subscription assets
Retrieves information about Pure1 subscription assets.
- Parameters
subscriptions (ReferenceType or List[ReferenceType], optional) – A list of subscriptions to query for. Overrides subscription_ids and subscription_names keyword arguments.
licenses (ReferenceType or List[ReferenceType], optional) – A list of licenses to query for. Overrides license_ids and license_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
advanced_space (bool) – If true, returns the advanced_space field containing physical and effective space information.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
license_ids (List[str]) – A comma-separated list of subscriptionLicense IDs. If there is not at least one resource that matches each license.id element, an error is returned. Single quotes are required around all strings.
license_names (List[str]) – A comma-separated list of subscriptionLicense names. If there is not at least one resource that matches each license.name element, an error is returned. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
subscription_ids (List[str]) – A comma-separated list of subscription IDs. If there is not at least one resource that matches each subscription.id element, an error is returned. Single quotes are required around all strings.
subscription_names (List[str]) – A comma-separated list of subscription names. If there is not at least one resource that matches each subscription.name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_subscription_licenses(subscriptions: Optional[Union[ReferenceType, List[ReferenceType]]] = None, marketplace_partner_references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, marketplace_partner_reference_ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, subscription_ids: Optional[ConstrainedListValue[StrictStr]] = None, subscription_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get subscription licenses
Retrieves information about Pure1 subscription licenses.
- Parameters
subscriptions (ReferenceType or List[ReferenceType], optional) – A list of subscriptions to query for. Overrides subscription_ids and subscription_names keyword arguments.
marketplace_partner_references (ReferenceType or List[ReferenceType], optional) – A list of marketplace_partner_references to query for. Overrides marketplace_partner_reference_ids keyword argument.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
marketplace_partner_reference_ids (List[str]) – A comma-separated list of marketplace partner reference IDs. If there is not at least one resource that matches each marketplace_partner.reference_id element, an error is returned. Single quotes are required around all strings.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
subscription_ids (List[str]) – A comma-separated list of subscription IDs. If there is not at least one resource that matches each subscription.id element, an error is returned. Single quotes are required around all strings.
subscription_names (List[str]) – A comma-separated list of subscription names. If there is not at least one resource that matches each subscription.name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_subscriptions(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get subscriptions
Retrieves information about Pure1 subscriptions.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_targets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get targets
Retrieves information about targets.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_topology_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, fleets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, list_all_parents: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get topology groups
Retrieves information about the topology groups known to the organization.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
fleets (ReferenceType or List[ReferenceType], optional) – A list of fleets to query for. Overrides fleet_ids and fleet_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
fleet_ids (List[str]) – A comma-separated list of fleet IDs. If there is not at least one resource that matches each fleet_id element, an error is returned. The fleet_ids and fleet_names parameters cannot be set together. Single quotes are required around all strings.
fleet_names (List[str]) – A comma-separated list of fleet names. If there is not at least one resource that matches each fleet_name element, an error is returned. The fleet_ids and fleet_names parameters cannot be set together. Single quotes are required around all strings.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
list_all_parents (bool) – If set to true, expands the results to include all ancestors of every topology group that matches the specified ids or names. This parameter can only be specified if ids or names is also specified. If not specified, defaults to false.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_topology_groups_arrays(topology_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, fleets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, topology_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, topology_group_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get topology group / array pairs
Lists arrays that are members of topology groups. Select topology groups and members via query parameters.
- Parameters
topology_groups (ReferenceType or List[ReferenceType], optional) – A list of topology_groups to query for. Overrides topology_group_ids and topology_group_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
fleets (ReferenceType or List[ReferenceType], optional) – A list of fleets to query for. Overrides fleet_ids and fleet_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
fleet_ids (List[str]) – A comma-separated list of fleet IDs. If there is not at least one resource that matches each fleet_id element, an error is returned. The fleet_ids and fleet_names parameters cannot be set together. Single quotes are required around all strings.
fleet_names (List[str]) – A comma-separated list of fleet names. If there is not at least one resource that matches each fleet_name element, an error is returned. The fleet_ids and fleet_names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
topology_group_ids (List[str]) – A comma-separated list of topology group IDs. If there is not at least one resource that matches each topology_group_id element, an error is returned. The topology_group_ids and topology_group_names parameters cannot be set together. Single quotes are required around all strings.
topology_group_names (List[str]) – A comma-separated list of topology group names. If there is not at least one resource that matches each topology_group_name element, an error is returned. The topology_group_ids and topology_group_names parameters cannot be set together. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_topology_groups_members(topology_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, fleets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, recursive: Optional[StrictBool] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, topology_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, topology_group_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get topology group / member pairs
Retrieves pairs of topology group references and their members.
- Parameters
topology_groups (ReferenceType or List[ReferenceType], optional) – A list of topology_groups to query for. Overrides topology_group_ids and topology_group_names keyword arguments.
members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.
fleets (ReferenceType or List[ReferenceType], optional) – A list of fleets to query for. Overrides fleet_ids and fleet_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
fleet_ids (List[str]) – A comma-separated list of fleet IDs. If there is not at least one resource that matches each fleet_id element, an error is returned. The fleet_ids and fleet_names parameters cannot be set together. Single quotes are required around all strings.
fleet_names (List[str]) – A comma-separated list of fleet names. If there is not at least one resource that matches each fleet_name element, an error is returned. The fleet_ids and fleet_names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. The member_ids and member_names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
recursive (bool) – The flag that, when set to true, recursively includes all members of a specified topology group. This parameter must be used in conjunction with topology_group_names or topology_group_ids. If not specified, this value defaults to false.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
topology_group_ids (List[str]) – A comma-separated list of topology group IDs. If there is not at least one resource that matches each topology_group_id element, an error is returned. The topology_group_ids and topology_group_names parameters cannot be set together. Single quotes are required around all strings.
topology_group_names (List[str]) – A comma-separated list of topology group names. If there is not at least one resource that matches each topology_group_name element, an error is returned. The topology_group_ids and topology_group_names parameters cannot be set together. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_volume_snapshots(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get volume snapshots
Retrieves information about snapshots of volumes.
- Parameters
sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids (List[str]) – A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings.
source_names (List[str]) – A comma-separated list of names for the source of the object. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- get_volumes(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Get volumes
Retrieves information about FlashArray volume objects.
- Parameters
references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.
filter (Union[str, Filter]) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.
ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.
names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. The ids and names parameters cannot be set together. Single quotes are required around all strings.
offset (int) – The offset of the first resource to return from a collection.
sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- post_arrays_simulations(planning_simulation_post: PlanningSimulationPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Evaluate planning simulation
Evaluates projected load and capacity for a caller-specified set of arrays. Arrays are listed in the request resources field; each array in resources that is not targeted by a simulation step receives baseline projections, and each array targeted by one or more steps receives simulated projections that reflect the applied steps. Arrays referenced only inside a step but not listed in resources participate in the simulation as input and do not appear in the response. A missing or empty resources array is rejected, as are simulations/volumes/move steps that reference volumes belonging to a stretched pod. The valid step actions are simulations/volumes/move and simulations/activecluster/failover. This request computes results synchronously and does not create a persistent simulation object.
- Parameters
planning_simulation_post (PlanningSimulationPost) – (required)
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
- put_arrays_tags(tag_put: ConstrainedListValue[models.TagPut], resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) Union[ValidResponse, ErrorResponse]
Create or update array tags
Creates or updates array tags contextual to Pure1 only.
- Parameters
tag_put (List[TagPut]) – (required)
resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.
authorization (str) – Deprecated. Please use Client level authorization
x_request_id (str) – Supplied by client during request or generated by server.
namespaces (List[str]) – A comma-separated list of namespaces. Single quotes are required around all strings.
resource_ids (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.
resource_names (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.
- Return type
Union[ValidResponse, ErrorResponse]
- Raises
PureError: If calling the API fails.
- Raises
ValueError: If a parameter is of an invalid type.
- Raises
TypeError: If invalid or missing parameters are used.
Models
Alert
- pydantic model pypureclient.pure1.Alert(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, actual: Optional[StrictStr] = None, category: Optional[StrictStr] = None, closed: Optional[StrictInt] = None, code: Optional[StrictInt] = None, component_name: Optional[StrictStr] = None, component_type: Optional[StrictStr] = None, created: Optional[StrictInt] = None, description: Optional[StrictStr] = None, expected: Optional[StrictStr] = None, knowledge_base_url: Optional[StrictStr] = None, notified: Optional[StrictInt] = None, origin: Optional[StrictStr] = None, severity: Optional[StrictStr] = None, state: Optional[StrictStr] = None, summary: Optional[StrictStr] = None, updated: Optional[StrictInt] = None)
- field actual: Optional[StrictStr] = None
Actual condition at the time of the alert.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field category: Optional[StrictStr] = None
Category of the alert. Valid values are array, hardware, and software.
- field closed: Optional[StrictInt] = None
Time when the alert was closed, in milliseconds since UNIX epoch.
- field code: Optional[StrictInt] = None
Code associated with the alert.
- field component_name: Optional[StrictStr] = None
Name of the component alerted about.
- field component_type: Optional[StrictStr] = None
Type of the component alerted about.
- field created: Optional[StrictInt] = None
Time when the alert was created, in milliseconds since UNIX epoch.
- field description: Optional[StrictStr] = None
Short description of the alert.
- field expected: Optional[StrictStr] = None
Expected state/threshold under normal conditions.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field knowledge_base_url: Optional[StrictStr] = None
URL of the relevant Knowledge Base page.
- field name: Optional[StrictStr] = None
A modifiable, locally unique name chosen by the user.
- field notified: Optional[StrictInt] = None
Time when the user was notified of the alert, in milliseconds since UNIX epoch.
- field origin: Optional[StrictStr] = None
Origin of the alert. Valid values are array and Pure1.
- field severity: Optional[StrictStr] = None
Current severity level. Valid values are info, warning, critical, and hidden.
- field state: Optional[StrictStr] = None
Current state of the alert. Valid values are open, closing, and closed.
- field summary: Optional[StrictStr] = None
Summary of the alert.
- field updated: Optional[StrictInt] = None
Time when the alert was last updated, in milliseconds since UNIX epoch.
AlertsGetResponse
- pydantic model pypureclient.pure1.AlertsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Alert]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
AlertsResponse
Anomaly
- pydantic model pypureclient.pure1.Anomaly(*, _as_of: Optional[StrictInt] = None, description: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, id: Optional[StrictStr] = None, resources: Optional[ConstrainedListValue[AnomalyResource]] = None, start_time: Optional[StrictInt] = None, status: Optional[StrictStr] = None, type: Optional[StrictStr] = None)
A security anomaly detected on a Pure Storage appliance.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field description: Optional[StrictStr] = None
Human-readable description of the anomaly type and what it detects.
- field end_time: Optional[StrictInt] = None
End time of the anomaly, in milliseconds since UNIX epoch. If an anomaly is ongoing, this value may be updated to a more recent time.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field resources: Optional[ConstrainedListValue[AnomalyResource]] = None
The storage resources associated with this anomaly. For single-dimension anomalies this contains one object; for multi-dimensional or fleet anomalies there may be multiple objects across one or more arrays.
- field start_time: Optional[StrictInt] = None
Start time of the anomaly, in milliseconds since UNIX epoch.
- field status: Optional[StrictStr] = None
Current status of the anomaly. Valid values are open and closed. An anomaly is open if its end_time is less than one week old.
- field type: Optional[StrictStr] = None
The category of the anomaly. Valid values are drr, total_latency, iops, bandwidth, capacity, volume_count, volume_snapshot_count, multi_dimensional_admin_activity, multi_dimensional_system_metrics, and failed_and_unusual_logins.
AnomalyAdditionalDataCommands
AnomalyAdditionalDataLoginPattern
- pydantic model pypureclient.pure1.AnomalyAdditionalDataLoginPattern(*, unusual_patterns: ConstrainedListValue[StrictStr])
Additional data for the login_pattern metric.
- field unusual_patterns: ConstrainedListValue[StrictStr] [Required]
List of unusual login pattern signals detected. Valid values are unusual_time, unusual_high_number, unusual_interface, and unusual_ip.
AnomalyAdditionalDataMetric
- pydantic model pypureclient.pure1.AnomalyAdditionalDataMetric(*, value_change_percentage: Union[ConstrainedFloatValue, ConstrainedIntValue])
Additional data for the drr, capacity, total_latency, iops, bandwidth, volume_count, and volume_snapshot_count metrics.
- field value_change_percentage: Union[ConstrainedFloatValue, ConstrainedIntValue] [Required]
Fractional change in the metric value that triggered the anomaly.
AnomalyGetResponse
- pydantic model pypureclient.pure1.AnomalyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Anomaly]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
AnomalyMetricReference
- pydantic model pypureclient.pure1.AnomalyMetricReference(*, additional_data: Optional[AnomalyMetricReferenceAdditionalData] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)
A metric reference associated with a resource in an anomaly.
- field additional_data: Optional[AnomalyMetricReferenceAdditionalData] = None
- field name: Optional[StrictStr] = None
The name of the metric. For example, capacity or data-protection.
- field resource_type: Optional[StrictStr] = None
The resource type for this metric reference. Typically metrics, or null for metrics that do not have a backing resource type (e.g., array_admin_activities, array_login_pattern).
AnomalyMetricReferenceAdditionalData
- pydantic model pypureclient.pure1.AnomalyMetricReferenceAdditionalData(*args, anyof_schema_1_validator: Optional[AnomalyAdditionalDataMetric] = None, anyof_schema_2_validator: Optional[AnomalyAdditionalDataCommands] = None, anyof_schema_3_validator: Optional[AnomalyAdditionalDataLoginPattern] = None, anyof_schema_4_validator: Optional[Dict[str, Any]] = None, actual_instance: Any = None, any_of_schemas: List[str] = ['AnomalyAdditionalDataCommands', 'AnomalyAdditionalDataLoginPattern', 'AnomalyAdditionalDataMetric', 'object'])
Additional type-specific information about this contributing metric. The shape varies by metric type (e.g., a value_change_percentage for capacity or data-protection metrics, a list of commands for admin-activities metrics, or a list of unusual_patterns for login-pattern metrics). Absent for metrics that carry no supplementary data.
- Validators
actual_instance_must_validate_anyof»actual_instance
- field actual_instance: Any = None
- Validated by
actual_instance_must_validate_anyof
- field any_of_schemas: List[str] = ['AnomalyAdditionalDataCommands', 'AnomalyAdditionalDataLoginPattern', 'AnomalyAdditionalDataMetric', 'object']
- Constraints
const = [‘AnomalyAdditionalDataCommands’, ‘AnomalyAdditionalDataLoginPattern’, ‘AnomalyAdditionalDataMetric’, ‘object’]
- field anyof_schema_1_validator: Optional[AnomalyAdditionalDataMetric] = None
- field anyof_schema_2_validator: Optional[AnomalyAdditionalDataCommands] = None
- field anyof_schema_3_validator: Optional[AnomalyAdditionalDataLoginPattern] = None
- field anyof_schema_4_validator: Optional[Dict[str, Any]] = None
Additional, metric-dependent information explaining why the identified data was anomalous. Fallback for additional data types introduced in newer API versions.
- validator actual_instance_must_validate_anyof » actual_instance
AnomalyResource
- pydantic model pypureclient.pure1.AnomalyResource(*, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, id: Optional[StrictStr] = None, metrics: Optional[ConstrainedListValue[AnomalyMetricReference]] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)
A storage resource associated with a security anomaly, such as a volume, bucket, file system, directory, admin user, or array.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The arrays on which this resource resides.
- field id: Optional[StrictStr] = None
The unique identifier of the resource.
- field metrics: Optional[ConstrainedListValue[AnomalyMetricReference]] = None
The metrics that contributed to anomaly detection for this resource.
- field name: Optional[StrictStr] = None
The name of the resource.
- field resource_type: Optional[StrictStr] = None
The REST endpoint type of the resource. Valid values are buckets, file-systems, volumes, directories, admins, and arrays.
AnomalyResponse
Array
- pydantic model pypureclient.pure1.Array(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, fleet: Optional[FixedReference] = None, fqdn: Optional[StrictStr] = None, model: Optional[StrictStr] = None, os: Optional[StrictStr] = None, topology_group: Optional[FixedReference] = None, version: Optional[StrictStr] = None)
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field fleet: Optional[FixedReference] = None
A reference to the fleet that the array is a member of, if any.
- field fqdn: Optional[StrictStr] = None
The fully qualified domain name of the array.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field model: Optional[StrictStr] = None
Model of the array.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field os: Optional[StrictStr] = None
Valid values are Elasticity, Purity, Purity//FA and Purity//FB.
- field topology_group: Optional[FixedReference] = None
A reference to the topology group that the array is a direct child of, if any.
- field version: Optional[StrictStr] = None
ArrayGetResponse
- pydantic model pypureclient.pure1.ArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Array]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
ArrayResponse
Arrays
- pydantic model pypureclient.pure1.Arrays(*, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
ArraysBuiltIn
- pydantic model pypureclient.pure1.ArraysBuiltIn(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None)
A built-in resource that exists on one or multiple arrays.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
ArraysResource
- pydantic model pypureclient.pure1.ArraysResource(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None)
A built-in resource that exists on one or multiple arrays.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A modifiable, locally unique name chosen by the user.
AssetAddress
- pydantic model pypureclient.pure1.AssetAddress(*, city: Optional[StrictStr] = None, country: Optional[StrictStr] = None, state: Optional[StrictStr] = None, street_address: Optional[StrictStr] = None)
- field city: Optional[StrictStr] = None
- field country: Optional[StrictStr] = None
- field state: Optional[StrictStr] = None
The state or province.
- field street_address: Optional[StrictStr] = None
AssetOrg
AssetSpace
- pydantic model pypureclient.pure1.AssetSpace(*, capacity: Optional[CurrentMetric] = None, total_used: Optional[CurrentMetric] = None, total_used_ratio: Optional[AssetSpaceTotalUsedRatio] = None)
- field capacity: Optional[CurrentMetric] = None
The usable capacity of the appliance.
- field total_used: Optional[CurrentMetric] = None
The total space contributed by customer data.
- field total_used_ratio: Optional[AssetSpaceTotalUsedRatio] = None
AssetSpaceTotalUsedRatio
- pydantic model pypureclient.pure1.AssetSpaceTotalUsedRatio(*, data: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, metric: Optional[FixedReference] = None, unit: Optional[StrictStr] = None)
The ratio of total_used to the capacity. This represents how full the appliance is.
- field data: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None
- field metric: Optional[FixedReference] = None
A reference to the metric this data measures.
- field unit: Optional[StrictStr] = None
The unit of the metric.
AssetUpgradeDetails
- pydantic model pypureclient.pure1.AssetUpgradeDetails(*, action_needed: Optional[StrictStr] = None, commitment_date: Optional[StrictInt] = None, upgrade_eligibility_date: Optional[StrictInt] = None)
- field action_needed: Optional[StrictStr] = None
The action required to obtain the next free upgrade under your Evergreen//Forever subscription.
- field commitment_date: Optional[StrictInt] = None
The date until which you need to commit to an Evergreen//Forever subscription to be eligible for the next Ever Modern Upgrade.
- field upgrade_eligibility_date: Optional[StrictInt] = None
The date on which controllers/blades will be eligible for an Ever Modern Upgrade if you renew your Evergreen//Forever subscription to the required Forever (FVR) Commitment date.
Audit
- pydantic model pypureclient.pure1.Audit(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, arguments: Optional[StrictStr] = None, command: Optional[StrictStr] = None, origin: Optional[StrictStr] = None, subcommand: Optional[StrictStr] = None, time: Optional[StrictInt] = None, user: Optional[StrictStr] = None)
- field arguments: Optional[StrictStr] = None
Arguments provided to the command.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field command: Optional[StrictStr] = None
The command that was executed.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A modifiable, locally unique name chosen by the user.
- field origin: Optional[StrictStr] = None
Origin of the action. Valid values are array and Pure1.
- field subcommand: Optional[StrictStr] = None
The subcommand that was executed.
- field time: Optional[StrictInt] = None
Time at which the command was run in milliseconds since UNIX epoch.
- field user: Optional[StrictStr] = None
The user who ran the command.
AuditsGetResponse
- pydantic model pypureclient.pure1.AuditsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Audit]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
AuditsResponse
BaseAddress
- pydantic model pypureclient.pure1.BaseAddress(*, city: Optional[StrictStr] = None, country: Optional[StrictStr] = None, state: Optional[StrictStr] = None)
- field city: Optional[StrictStr] = None
- field country: Optional[StrictStr] = None
- field state: Optional[StrictStr] = None
The state or province.
Blade
- pydantic model pypureclient.pure1.Blade(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[BladeArrayStatus]] = None, details: Optional[StrictStr] = None, raw_capacity: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None)
- field arrays: Optional[ConstrainedListValue[BladeArrayStatus]] = None
A list of arrays that contain this blade. Each blade should only exist on one array.
- Constraints
minItems = 1
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field details: Optional[StrictStr] = None
Extra details about the blade. Will be null if none exist.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field raw_capacity: Optional[Union[StrictFloat, StrictInt]] = None
The raw storage capacity of the blade.
- field status: Optional[StrictStr] = None
Valid values are critical, evacuated, evacuating, healthy, identifying, unclaimed, unhealthy, unknown, unrecognized.
BladeArrayStatus
- pydantic model pypureclient.pure1.BladeArrayStatus(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, fqdn: Optional[StrictStr] = None, total_blades: Optional[StrictInt] = None, used_blades: Optional[StrictInt] = None)
- field fqdn: Optional[StrictStr] = None
The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.
- field id: Optional[StrictStr] = None
The opaque and unique id of this resource.
- field name: Optional[StrictStr] = None
The name of this resource.
- field resource_type: Optional[StrictStr] = None
The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.
- field total_blades: Optional[StrictInt] = None
Count of total blade slots in the array.
- field used_blades: Optional[StrictInt] = None
Count of used blade slots in the array.
BladeGetResponse
- pydantic model pypureclient.pure1.BladeGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Blade]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
BladeResponse
Bucket
- pydantic model pypureclient.pure1.Bucket(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, account: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, object_count: Optional[StrictInt] = None, versioning: Optional[StrictStr] = None)
- field account: Optional[FixedReference] = None
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created: Optional[StrictInt] = None
Creation time of the bucket, in milliseconds since Unix epoch.
- field destroyed: Optional[StrictBool] = None
Returns a value of true if the bucket is destroyed, but not yet eradicated.
- Constraints
type = boolean
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A modifiable, locally unique name chosen by the user.
- field object_count: Optional[StrictInt] = None
The number of objects contained within the bucket.
- field versioning: Optional[StrictStr] = None
The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.
BucketGetResponse
- pydantic model pypureclient.pure1.BucketGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Bucket]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
BucketReplicaLink
- pydantic model pypureclient.pure1.BucketReplicaLink(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, paused: Optional[StrictBool] = None, recovery_point: Optional[StrictInt] = None, status: Optional[StrictStr] = None, members: Optional[ConstrainedListValue[ResourceWithLocation]] = None, sources: Optional[ConstrainedListValue[ResourceWithLocation]] = None, status_details: Optional[StrictStr] = None, targets: Optional[ConstrainedListValue[ResourceWithLocation]] = None)
A replica link between two buckets.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field lag: Optional[StrictInt] = None
Duration, in milliseconds, which represents how far behind the replication target is from the source.
- field members: Optional[ConstrainedListValue[ResourceWithLocation]] = None
The union of source and target buckets in the replica link.
- field paused: Optional[StrictBool] = None
Returns true if the replica link is paused.
- Constraints
type = boolean
- field recovery_point: Optional[StrictInt] = None
Time when the last piece of data was replicated, in milliseconds since the UNIX epoch, and the recovery point of the bucket.
- field sources: Optional[ConstrainedListValue[ResourceWithLocation]] = None
The source buckets in the replica link.
- field status: Optional[StrictStr] = None
Status of the replica link. Values include replicating, idle, and unhealthy.
- field status_details: Optional[StrictStr] = None
Detailed information about the status of the replica link when it is unhealthy.
- field targets: Optional[ConstrainedListValue[ResourceWithLocation]] = None
The target buckets in the replica link.
BucketReplicaLinkGetResponse
- pydantic model pypureclient.pure1.BucketReplicaLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[BucketReplicaLink]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[BucketReplicaLink]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
BucketReplicaLinkResponse
- pydantic model pypureclient.pure1.BucketReplicaLinkResponse(*, items: Optional[ConstrainedListValue[BucketReplicaLink]] = None)
- field items: Optional[ConstrainedListValue[BucketReplicaLink]] = None
BucketResponse
BuiltInAsOf
- pydantic model pypureclient.pure1.BuiltInAsOf(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can’t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs).
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
Company
Controller
- pydantic model pypureclient.pure1.Controller(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, mode: Optional[StrictStr] = None, model: Optional[StrictStr] = None, status: Optional[StrictStr] = None, type: Optional[StrictStr] = None, version: Optional[StrictStr] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field mode: Optional[StrictStr] = None
Mode of the controller. Values include not present, offline, primary, and secondary.
- field model: Optional[StrictStr] = None
Model of the controller.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field status: Optional[StrictStr] = None
Status of the controller. Values include not ready, ready, unknown, and updating.
- field type: Optional[StrictStr] = None
Type of the controller. Values include array_controller and shelf_controller.
- field version: Optional[StrictStr] = None
Version of the controller.
ControllerGetResponse
- pydantic model pypureclient.pure1.ControllerGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Controller]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[Controller]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
ControllerResponse
- pydantic model pypureclient.pure1.ControllerResponse(*, items: Optional[ConstrainedListValue[Controller]] = None)
- field items: Optional[ConstrainedListValue[Controller]] = None
CurrentMetric
- pydantic model pypureclient.pure1.CurrentMetric(*, data: Optional[Union[StrictFloat, StrictInt]] = None, metric: Optional[FixedReference] = None, unit: Optional[StrictStr] = None)
- field data: Optional[Union[StrictFloat, StrictInt]] = None
The data value.
- field metric: Optional[FixedReference] = None
A reference to the metric this data measures.
- field unit: Optional[StrictStr] = None
The unit of the metric.
Cve
- pydantic model pypureclient.pure1.Cve(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, affected_resources: Optional[ConstrainedListValue[CveResource]] = None, affected_versions: Optional[ConstrainedListValue[CveVersion]] = None, cvss_score: Optional[Union[StrictFloat, StrictInt]] = None, description: Optional[StrictStr] = None, detected_at: Optional[StrictInt] = None, fixed_in_patches: Optional[ConstrainedListValue[CvePatch]] = None, fixed_in_versions: Optional[ConstrainedListValue[CveVersion]] = None, kb_article: Optional[StrictStr] = None, severity: Optional[StrictStr] = None, updated_at: Optional[StrictInt] = None)
CVE details and affected Pure Storage appliances.
- field affected_resources: Optional[ConstrainedListValue[CveResource]] = None
The list of affected resources.
- field affected_versions: Optional[ConstrainedListValue[CveVersion]] = None
The list of affected versions.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field cvss_score: Optional[Union[StrictFloat, StrictInt]] = None
The CVSS score of the CVE.
- field description: Optional[StrictStr] = None
Human-readable description of the CVE.
- field detected_at: Optional[StrictInt] = None
The time when a record for this CVE was created in Pure1, in milliseconds since UNIX epoch.
- field fixed_in_patches: Optional[ConstrainedListValue[CvePatch]] = None
The list of patches that fix the CVE.
- field fixed_in_versions: Optional[ConstrainedListValue[CveVersion]] = None
The list of versions that fix the CVE.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field kb_article: Optional[StrictStr] = None
A link to Pure’s KB article for the CVE.
- field severity: Optional[StrictStr] = None
The severity of the CVE. Valid values are low, medium, high, critical, and none.
- field updated_at: Optional[StrictInt] = None
The most recent time when this CVE’s record in Pure1 was modified, in milliseconds since UNIX epoch.
CveGetResponse
- pydantic model pypureclient.pure1.CveGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Cve]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
CvePatch
- pydantic model pypureclient.pure1.CvePatch(*, name: Optional[StrictStr] = None, os: Optional[StrictStr] = None)
Software patch to be installed on the array.
- field name: Optional[StrictStr] = None
name of the patch.
- field os: Optional[StrictStr] = None
The operating system. Valid values are: Purity//FA, Purity//FB.
CveResource
- pydantic model pypureclient.pure1.CveResource(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, fqdn: Optional[StrictStr] = None, os: Optional[StrictStr] = None, version: Optional[StrictStr] = None)
- field fqdn: Optional[StrictStr] = None
The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.
- field id: Optional[StrictStr] = None
The opaque and unique id of this resource.
- field name: Optional[StrictStr] = None
The name of this resource.
- field os: Optional[StrictStr] = None
The operating system. Valid values are Purity//FA and Purity//FB.
- field resource_type: Optional[StrictStr] = None
The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.
- field version: Optional[StrictStr] = None
The version of the software.
CveResponse
CveVersion
- pydantic model pypureclient.pure1.CveVersion(*, os: Optional[StrictStr] = None, version: Optional[StrictStr] = None)
Software version.
- field os: Optional[StrictStr] = None
The operating system. Valid values are Purity//FA and Purity//FB.
- field version: Optional[StrictStr] = None
The version of the software.
Directory
- pydantic model pypureclient.pure1.Directory(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, directory_name: Optional[StrictStr] = None, file_system: Optional[FixedReference] = None, path: Optional[StrictStr] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created: Optional[StrictInt] = None
Creation time in milliseconds since UNIX epoch.
- field destroyed: Optional[StrictBool] = None
Is the managed directory destroyed?
- Constraints
type = boolean
- field directory_name: Optional[StrictStr] = None
The managed directory name without the file system name prefix. A managed directory full name is constructed in the form of FILE_SYSTEM:DIR where FILE_SYSTEM is the file system name and DIR is the value of this field. On FlashArray versions below 6.0.2, the value is always null.
- field file_system: Optional[FixedReference] = None
The file system that this managed directory is in.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field path: Optional[StrictStr] = None
Absolute path of the managed directory in the file system.
DirectoryGetResponse
- pydantic model pypureclient.pure1.DirectoryGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Directory]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
DirectoryResponse
Drive
- pydantic model pypureclient.pure1.Drive(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[DriveArrayStatus]] = None, capacity: Optional[Union[StrictFloat, StrictInt]] = None, details: Optional[StrictStr] = None, protocol: Optional[StrictStr] = None, status: Optional[StrictStr] = None, type: Optional[StrictStr] = None)
- field arrays: Optional[ConstrainedListValue[DriveArrayStatus]] = None
A list of arrays that contain this drive. Each drive should only exist on one array.
- Constraints
minItems = 1
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field capacity: Optional[Union[StrictFloat, StrictInt]] = None
Physical storage capacity of the module (in bytes).
- field details: Optional[StrictStr] = None
Details about the status of the module if status is not healthy.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field protocol: Optional[StrictStr] = None
Storage protocol of the module. Values include NVMe and SAS.
- field status: Optional[StrictStr] = None
Current status of the module. Values include empty, failed, healthy, identifying, missing, recovering, unadmitted, unhealthy, unrecognized, and updating.
- field type: Optional[StrictStr] = None
The type of the module. Values include cache, NVRAM, SSD, and virtual.
DriveArrayStatus
- pydantic model pypureclient.pure1.DriveArrayStatus(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, drive_count: Optional[StrictInt] = None, fqdn: Optional[StrictStr] = None, total_capacity: Optional[StrictInt] = None)
- field drive_count: Optional[StrictInt] = None
Count of drives in the array.
- field fqdn: Optional[StrictStr] = None
The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.
- field id: Optional[StrictStr] = None
The opaque and unique id of this resource.
- field name: Optional[StrictStr] = None
The name of this resource.
- field resource_type: Optional[StrictStr] = None
The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.
- field total_capacity: Optional[StrictInt] = None
The total capacity of all drives in the array.
DriveGetResponse
- pydantic model pypureclient.pure1.DriveGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Drive]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
DriveResponse
EolComponent
- pydantic model pypureclient.pure1.EolComponent(*, component_type: Optional[StrictStr] = None, end_of_life: Optional[StrictInt] = None, protocol: Optional[StrictStr] = None)
Details about a hardware component that has reached or is approaching end-of-life.
- field component_type: Optional[StrictStr] = None
Type of the hardware component (e.g. CONTROLLER, CHASSIS, SHELF, DRIVE).
- field end_of_life: Optional[StrictInt] = None
End-of-life date in epoch milliseconds (UTC).
- field protocol: Optional[StrictStr] = None
Protocol used by the component (e.g. SAS, NVME). May be null for components that do not have an associated protocol.
Error
- pydantic model pypureclient.pure1.Error(*, errors: Optional[ConstrainedListValue[ErrorErrors]] = None)
- field errors: Optional[ConstrainedListValue[ErrorErrors]] = None
The list of errors encountered.
ErrorErrors
ErrorNoContext
EvergreenForeverAndFoundationDetails
- pydantic model pypureclient.pure1.EvergreenForeverAndFoundationDetails(*, service_sla: Optional[StrictStr] = None, service_tier: Optional[StrictStr] = None)
- field service_sla: Optional[StrictStr] = None
The associated Service Level Agreements (SLAs) for the service tier.
- field service_tier: Optional[StrictStr] = None
A non-modifiable, locally unique name that the subscription was started with, never changes.
FileSystem
- pydantic model pypureclient.pure1.FileSystem(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, fast_remove_directory_enabled: Optional[StrictBool] = None, hard_limit_enabled: Optional[StrictBool] = None, http: Optional[Http] = None, nfs: Optional[Nfs] = None, provisioned: Optional[StrictInt] = None, smb: Optional[Smb] = None, snapshot_directory_enabled: Optional[StrictBool] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created: Optional[StrictInt] = None
Creation time in milliseconds since UNIX epoch.
- field destroyed: Optional[StrictBool] = None
Is the file system destroyed?
- Constraints
type = boolean
- field fast_remove_directory_enabled: Optional[StrictBool] = None
On a FlashBlade file system, returns the value of true if fast remove directory is enabled and false if it is not. On a FlashArray file system, the value is always null.
- Constraints
type = boolean
- field hard_limit_enabled: Optional[StrictBool] = None
On a FlashBlade file system, returns the value of true if the file system’s size is a hard limit quota and false if it is not. On a FlashArray file system, the value is always null.
- Constraints
type = boolean
- field http: Optional[Http] = None
HTTP configuration. On a FlashArray file system, the value is always null.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field nfs: Optional[Nfs] = None
NFS configuration. On a FlashArray file system, the value is always null.
- field provisioned: Optional[StrictInt] = None
The provisioned size of the file system in bytes. A value of 0 means unlimited. On a FlashArray file system, the value is always null.
- field smb: Optional[Smb] = None
SMB configuration. On a FlashArray file system, the value is always null.
- field snapshot_directory_enabled: Optional[StrictBool] = None
On a FlashBlade file system, returns the value of true if snapshot directory is enabled and false if it is not. On a FlashArray file system, the value is always null.
- Constraints
type = boolean
FileSystemGetResponse
- pydantic model pypureclient.pure1.FileSystemGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystem]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[FileSystem]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
FileSystemReplicaLink
- pydantic model pypureclient.pure1.FileSystemReplicaLink(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, paused: Optional[StrictBool] = None, recovery_point: Optional[StrictInt] = None, status: Optional[StrictStr] = None, members: Optional[ConstrainedListValue[ResourceWithLocation]] = None, sources: Optional[ConstrainedListValue[ResourceWithLocation]] = None, status_details: Optional[StrictStr] = None, targets: Optional[ConstrainedListValue[ResourceWithLocation]] = None)
A replica link between two FlashBlade file systems.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field lag: Optional[StrictInt] = None
Duration, in milliseconds, which represents how far behind the replication target is from the source.
- field members: Optional[ConstrainedListValue[ResourceWithLocation]] = None
The union of source and target file systems in the replica link.
- field paused: Optional[StrictBool] = None
Returns true if the replica link is paused.
- Constraints
type = boolean
- field recovery_point: Optional[StrictInt] = None
Time when the last replicated snapshot was created, in milliseconds since the UNIX epoch. (i.e. the recovery point if the file system is promoted.)
- field sources: Optional[ConstrainedListValue[ResourceWithLocation]] = None
The source file systems in the replica link.
- field status: Optional[StrictStr] = None
Status of the replica link. Values include replicating, idle, and unhealthy.
- field status_details: Optional[StrictStr] = None
Detailed information about the status of the replica link when it is unhealthy.
- field targets: Optional[ConstrainedListValue[ResourceWithLocation]] = None
The target file systems in the replica link.
FileSystemReplicaLinkGetResponse
- pydantic model pypureclient.pure1.FileSystemReplicaLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
FileSystemReplicaLinkResponse
- pydantic model pypureclient.pure1.FileSystemReplicaLinkResponse(*, items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None)
- field items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None
FileSystemResponse
- pydantic model pypureclient.pure1.FileSystemResponse(*, items: Optional[ConstrainedListValue[FileSystem]] = None)
- field items: Optional[ConstrainedListValue[FileSystem]] = None
FileSystemSnapshot
- pydantic model pypureclient.pure1.FileSystemSnapshot(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, on: Optional[FixedReferenceFqdn] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictStr] = None)
A point-in-time image of the contents of a FlashBlade file system.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created: Optional[StrictInt] = None
Creation time in milliseconds since UNIX epoch.
- field destroyed: Optional[StrictBool] = None
Indicates if this snapshot has been destroyed and is pending eradication.
- Constraints
type = boolean
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field on: Optional[FixedReferenceFqdn] = None
- field source: Optional[FixedReference] = None
A reference to the file system that the snapshot was taken from.
- field suffix: Optional[StrictStr] = None
Indicates the suffix of the snapshot.
FileSystemSnapshotGetResponse
- pydantic model pypureclient.pure1.FileSystemSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
FileSystemSnapshotResponse
- pydantic model pypureclient.pure1.FileSystemSnapshotResponse(*, items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None)
- field items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None
FixedReference
- pydantic model pypureclient.pure1.FixedReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)
- field id: Optional[StrictStr] = None
The opaque and unique id of this resource.
- field name: Optional[StrictStr] = None
The name of this resource.
- field resource_type: Optional[StrictStr] = None
The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.
FixedReferenceFqdn
- pydantic model pypureclient.pure1.FixedReferenceFqdn(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, fqdn: Optional[StrictStr] = None)
- field fqdn: Optional[StrictStr] = None
The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.
- field id: Optional[StrictStr] = None
The opaque and unique id of this resource.
- field name: Optional[StrictStr] = None
The name of this resource.
- field resource_type: Optional[StrictStr] = None
The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.
FlasharrayHardwareUpgradeRecommendation
- pydantic model pypureclient.pure1.FlasharrayHardwareUpgradeRecommendation(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, company: Optional[Company] = None, created_at: Optional[StrictInt] = None, description: Optional[StrictStr] = None, recommendation_type: Optional[StrictStr] = None, subscription_license: Optional[FixedReference] = None, target: Optional[FixedReference] = None, trigger: Optional[RecommendationTrigger] = None, current_installed_capacity: Optional[StrictInt] = None, current_model: Optional[StrictStr] = None, current_usable_capacity: Optional[StrictInt] = None, end_of_life_components: Optional[ConstrainedListValue[EolComponent]] = None, recommended_full_sku: Optional[StrictStr] = None, recommended_installed_capacity: Optional[StrictInt] = None, recommended_model: Optional[StrictStr] = None, recommended_upgrade_sku: Optional[StrictStr] = None, recommended_usable_capacity: Optional[StrictInt] = None)
A FlashArray hardware upgrade recommendation. Covers all FlashArray hardware upgrade scenarios including but not limited to capacity upgrades, controller upgrades, Evergreen//Now upgrades, and end-of-life hardware refresh. The specific fields are present and non-empty only when applicable for the specific recommendation scenario.
- Validators
recommendation_type_validate_enum»recommendation_type
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created_at: Optional[StrictInt] = None
Creation timestamp of the recommendation in epoch milliseconds.
- field current_installed_capacity: Optional[StrictInt] = None
Current installed raw capacity in bytes.
- field current_model: Optional[StrictStr] = None
Current FlashArray controller model (e.g. FA-X70R2).
- field current_usable_capacity: Optional[StrictInt] = None
Current usable capacity in bytes.
- field description: Optional[StrictStr] = None
Human-readable description of the recommendation.
- field end_of_life_components: Optional[ConstrainedListValue[EolComponent]] = None
Details of hardware components at or approaching end-of-life. Populated and non-empty only for end-of-life hardware upgrade scenarios; null otherwise.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field recommendation_type: Optional[StrictStr] = None
Type slug. Always flasharray-hardware-upgrade for this subtype.
- Validated by
recommendation_type_validate_enum
- field recommended_full_sku: Optional[StrictStr] = None
Complete SKU for the recommended FlashArray configuration.
- field recommended_installed_capacity: Optional[StrictInt] = None
Post-upgrade installed raw capacity in bytes.
- field recommended_model: Optional[StrictStr] = None
Recommended FlashArray controller model.
- field recommended_upgrade_sku: Optional[StrictStr] = None
Upgrade-only SKU representing components added to the existing system.
- field recommended_usable_capacity: Optional[StrictInt] = None
Post-upgrade usable capacity in bytes.
- field subscription_license: Optional[FixedReference] = None
Associated subscription license reference. Present when the recommendation is linked to a specific Everpure subscription license; null otherwise.
- field target: Optional[FixedReference] = None
Reference to the target asset this recommendation applies to.
- field trigger: Optional[RecommendationTrigger] = None
Reference to the recommendation program that generated this recommendation.
- validator recommendation_type_validate_enum » recommendation_type
Validates the enum
FlasharrayHardwareUpgradeRecommendationGetResponse
- pydantic model pypureclient.pure1.FlasharrayHardwareUpgradeRecommendationGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FlasharrayHardwareUpgradeRecommendation]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[FlasharrayHardwareUpgradeRecommendation]] = None
List of FlashArray hardware upgrade recommendations on the current page.
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
FlasharrayHardwareUpgradeRecommendationResponse
- pydantic model pypureclient.pure1.FlasharrayHardwareUpgradeRecommendationResponse(*, items: Optional[ConstrainedListValue[FlasharrayHardwareUpgradeRecommendation]] = None)
- field items: Optional[ConstrainedListValue[FlasharrayHardwareUpgradeRecommendation]] = None
List of FlashArray hardware upgrade recommendations on the current page.
Fleet
- pydantic model pypureclient.pure1.Fleet(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
FleetGetResponse
- pydantic model pypureclient.pure1.FleetGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Fleet]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
FleetMember
- pydantic model pypureclient.pure1.FleetMember(*, _as_of: Optional[StrictInt] = None, coordinator_of: Optional[ConstrainedListValue[FixedReference]] = None, fleet: Optional[FixedReference] = None, member: Optional[FixedReference] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None)
An association between a fleet and a member.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field coordinator_of: Optional[ConstrainedListValue[FixedReference]] = None
List of fleets that the member is the coordinator of. The list is empty if the member is not a coordinator.
- field fleet: Optional[FixedReference] = None
A reference to the fleet.
- field member: Optional[FixedReference] = None
A reference to the member of the fleet.
- field status: Optional[StrictStr] = None
Current fleet membership status. Valid values are one of joining, joined, or removing. A status of joining indicates that the member is attempting to join the fleet. A status of joined indicates that the member has joined the fleet. A status of removing indicates that the member is being removed from the fleet.
- field status_details: Optional[StrictStr] = None
Additional detail about the membership status. The value is an empty string when there is no additional detail to report.
FleetMemberGetResponse
- pydantic model pypureclient.pure1.FleetMemberGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FleetMember]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[FleetMember]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
FleetMemberResponse
- pydantic model pypureclient.pure1.FleetMemberResponse(*, items: Optional[ConstrainedListValue[FleetMember]] = None)
- field items: Optional[ConstrainedListValue[FleetMember]] = None
FleetResponse
Geolocation
- pydantic model pypureclient.pure1.Geolocation(*, latitude: Optional[Union[StrictFloat, StrictInt]] = None, longitude: Optional[Union[StrictFloat, StrictInt]] = None)
- field latitude: Optional[Union[StrictFloat, StrictInt]] = None
The latitude of the address.
- field longitude: Optional[Union[StrictFloat, StrictInt]] = None
The longitude of the address.
Hardware
- pydantic model pypureclient.pure1.Hardware(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, details: Optional[StrictStr] = None, identify_enabled: Optional[StrictBool] = None, model: Optional[StrictStr] = None, serial: Optional[StrictStr] = None, slot: Optional[StrictInt] = None, speed: Optional[StrictInt] = None, status: Optional[StrictStr] = None, temperature: Optional[StrictInt] = None, type: Optional[StrictStr] = None, voltage: Optional[StrictInt] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field details: Optional[StrictStr] = None
Details about the component if status is not healthy.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field identify_enabled: Optional[StrictBool] = None
If true, the ID light is lit to visually identify the component.
- Constraints
type = boolean
- field model: Optional[StrictStr] = None
Model number of the hardware component.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field serial: Optional[StrictStr] = None
Serial number of the hardware component.
- field slot: Optional[StrictInt] = None
Slot number occupied by the PCI Express card that hosts the component.
- field speed: Optional[StrictInt] = None
Speed (in bytes per second) at which the component is operating.
- field status: Optional[StrictStr] = None
Component status. Values include critical, healthy, identifying, unhealthy, unclaimed, unknown, unrecognized, and unused.
- field temperature: Optional[StrictInt] = None
Temperature (in degrees Celsius) reported by the component.
- field type: Optional[StrictStr] = None
Type of the hardware component. Values include am, chassis, controller, cooling, drive_bay, eth_port, fan, fc_port, flash_blade, ib_port, mgmt_port, nvram_bay, power_supply, sas_module, sas_port, storage_shelf, and temp_sensor.
- field voltage: Optional[StrictInt] = None
Voltage (in Volts) reported by the component.
HardwareConnector
- pydantic model pypureclient.pure1.HardwareConnector(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, connector_type: Optional[StrictStr] = None, lane_speed: Optional[Union[StrictFloat, StrictInt]] = None, port_count: Optional[Union[StrictFloat, StrictInt]] = None, transceiver_type: Optional[StrictStr] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field connector_type: Optional[StrictStr] = None
Form-factor of the interface. Values include QSFP and RJ-45.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field lane_speed: Optional[Union[StrictFloat, StrictInt]] = None
Configured speed of each lane in the connector in bits per second.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field port_count: Optional[Union[StrictFloat, StrictInt]] = None
Configured number of ports in the connector.
- field transceiver_type: Optional[StrictStr] = None
Type of transceiver plugged into the connector port. If the type cannot be auto-detected and the internal user has not specified a type, the value will be Unknown. If nothing is plugged into the QSFP port, the value will be Unused. Transceiver type is not applicable for RJ-45 connectors.
HardwareConnectorGetResponse
- pydantic model pypureclient.pure1.HardwareConnectorGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[HardwareConnector]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[HardwareConnector]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
HardwareConnectorResponse
- pydantic model pypureclient.pure1.HardwareConnectorResponse(*, items: Optional[ConstrainedListValue[HardwareConnector]] = None)
- field items: Optional[ConstrainedListValue[HardwareConnector]] = None
HardwareGetResponse
- pydantic model pypureclient.pure1.HardwareGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Hardware]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
HardwareResponse
Http
InstallAddress
- pydantic model pypureclient.pure1.InstallAddress(*, geolocation: Optional[Geolocation] = None, street_address: Optional[StrictStr] = None, updated: Optional[StrictInt] = None)
- field geolocation: Optional[Geolocation] = None
The geolocation that contains the latitude and the longitude of the address.
- field street_address: Optional[StrictStr] = None
The 1-line format street address of the array install address.
- field updated: Optional[StrictInt] = None
The epoch timestamp, in milliseconds, that denotes when the address was updated.
Invoice
- pydantic model pypureclient.pure1.Invoice(*, amount: Optional[Union[StrictFloat, StrictInt]] = None, currency: Optional[StrictStr] = None, date: Optional[StrictInt] = None, due_date: Optional[StrictInt] = None, end_user_name: Optional[StrictStr] = None, end_user_purchase_order: Optional[StrictStr] = None, id: Optional[StrictStr] = None, lines: Optional[ConstrainedListValue[InvoiceLine]] = None, partner_purchase_order: Optional[StrictStr] = None, payment_terms: Optional[StrictStr] = None, sales_representative: Optional[StrictStr] = None, ship_date: Optional[StrictInt] = None, status: Optional[StrictStr] = None, subscription: Optional[FixedReference] = None)
- field amount: Optional[Union[StrictFloat, StrictInt]] = None
The total invoice amount, expressed in the currency defined in currency.
- field currency: Optional[StrictStr] = None
The currency of the invoice in ISO 4217 format. This currency applies to the total invoice amount as well as all amounts in line items.
- field due_date: Optional[StrictInt] = None
The payment due date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field end_user_name: Optional[StrictStr] = None
The end user customer name.
- field end_user_purchase_order: Optional[StrictStr] = None
The end user customer purchase order number.
- field id: Optional[StrictStr] = None
The invoice number, a globally unique identifier for this invoice.
- field lines: Optional[ConstrainedListValue[InvoiceLine]] = None
A list of invoice line items.
- field partner_purchase_order: Optional[StrictStr] = None
The partner purchase order number.
- field payment_terms: Optional[StrictStr] = None
The invoice payment terms.
- field sales_representative: Optional[StrictStr] = None
The sales representative that issued the invoice.
- field ship_date: Optional[StrictInt] = None
The invoice shipment date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field status: Optional[StrictStr] = None
The invoice status. Values include open and paid.
- field subscription: Optional[FixedReference] = None
A reference to which subscription this invoice belongs.
- field var_date: Optional[StrictInt] = None (alias 'date')
The issuance date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
InvoiceGetResponse
- pydantic model pypureclient.pure1.InvoiceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Invoice]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
InvoiceLine
- pydantic model pypureclient.pure1.InvoiceLine(*, amount: Optional[Union[StrictFloat, StrictInt]] = None, components: Optional[ConstrainedListValue[InvoiceLineComponent]] = None, description: Optional[StrictStr] = None, end_date: Optional[StrictInt] = None, item: Optional[StrictStr] = None, quantity: Optional[ConstrainedIntValue] = None, start_date: Optional[StrictInt] = None, tax: Optional[Tax] = None, unit_price: Optional[Union[StrictFloat, StrictInt]] = None)
- field amount: Optional[Union[StrictFloat, StrictInt]] = None
The total price of current invoice item, currency is specified in invoice currency.
- field components: Optional[ConstrainedListValue[InvoiceLineComponent]] = None
The sub-components of current invoice item.
- field description: Optional[StrictStr] = None
- field end_date: Optional[StrictInt] = None
The invoice item end date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field item: Optional[StrictStr] = None
The name of invoice item.
- field quantity: Optional[ConstrainedIntValue] = None
The quantity of current invoice item.
- Constraints
minimum = 0
- field start_date: Optional[StrictInt] = None
The invoice item start date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field unit_price: Optional[Union[StrictFloat, StrictInt]] = None
The unit price of current invoice item, currency is specified in invoice currency.
InvoiceLineComponent
- pydantic model pypureclient.pure1.InvoiceLineComponent(*, description: Optional[StrictStr] = None, item: Optional[StrictStr] = None, quantity: Optional[ConstrainedIntValue] = None)
- field description: Optional[StrictStr] = None
- field item: Optional[StrictStr] = None
The name of invoice component.
- field quantity: Optional[ConstrainedIntValue] = None
The quantity of current invoice component.
- Constraints
minimum = 0
InvoiceResponse
LicenseResourceReference
- pydantic model pypureclient.pure1.LicenseResourceReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, fqdn: Optional[StrictStr] = None, activation_time: Optional[StrictInt] = None, usage: Optional[CurrentMetric] = None)
- field activation_time: Optional[StrictInt] = None
Time when the resource is activated under the license, in milliseconds since UNIX epoch.
- field fqdn: Optional[StrictStr] = None
The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.
- field id: Optional[StrictStr] = None
The opaque and unique id of this resource.
- field name: Optional[StrictStr] = None
The name of this resource.
- field resource_type: Optional[StrictStr] = None
The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.
- field usage: Optional[CurrentMetric] = None
Current usage of the resource under the license.
LicenseUpgradeRecommendation
- pydantic model pypureclient.pure1.LicenseUpgradeRecommendation(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, company: Optional[Company] = None, created_at: Optional[StrictInt] = None, description: Optional[StrictStr] = None, recommendation_type: Optional[StrictStr] = None, subscription_license: Optional[FixedReference] = None, target: Optional[FixedReference] = None, trigger: Optional[RecommendationTrigger] = None, current_bandwidth_sla_bytes_per_sec: Optional[Union[StrictFloat, StrictInt]] = None, current_iops_sla: Optional[Union[StrictFloat, StrictInt]] = None, current_reserve_exceeded_in_days: Optional[StrictInt] = None, current_reserved_amount: Optional[Union[StrictFloat, StrictInt]] = None, current_service_tier: Optional[StrictStr] = None, recommended_bandwidth_sla_bytes_per_sec: Optional[Union[StrictFloat, StrictInt]] = None, recommended_iops_sla: Optional[Union[StrictFloat, StrictInt]] = None, recommended_reserved_amount: Optional[Union[StrictFloat, StrictInt]] = None, recommended_service_tier: Optional[StrictStr] = None, reserved_unit: Optional[StrictStr] = None)
An Evergreen//One license upgrade recommendation. Covers such scenarios as reserve commit expansion (when projected usage will exceed the current commit), tier upgrades (when a higher-performance license tier is warranted) and other license upgrade scenarios. Type-specific fields are nullable; the exact set of populated fields varies per recommendation scenario.
- Validators
recommendation_type_validate_enum»recommendation_type
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created_at: Optional[StrictInt] = None
Creation timestamp of the recommendation in epoch milliseconds.
- field current_bandwidth_sla_bytes_per_sec: Optional[Union[StrictFloat, StrictInt]] = None
Bandwidth SLA for the current license tier in bytes per second.
- field current_iops_sla: Optional[Union[StrictFloat, StrictInt]] = None
IOPS SLA for the current license tier. Null when current_service_tier is a UFFO (Unlimited Flash for Fixed Overhead) tier, which carries no IOPS SLA commitment. Independent of recommended_iops_sla.
- field current_reserve_exceeded_in_days: Optional[StrictInt] = None
Projected number of days until the current reserve commit is exceeded. A lower value indicates greater urgency to act on this recommendation.
- field current_reserved_amount: Optional[Union[StrictFloat, StrictInt]] = None
Current reserved amount as a numeric quantity expressed in the unit given by reserved_unit.
- field current_service_tier: Optional[StrictStr] = None
Current service tier (e.g. //Block - Capacity, //Block - Performance, //UFFO - Performance).
- field description: Optional[StrictStr] = None
Human-readable description of the recommendation.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field recommendation_type: Optional[StrictStr] = None
Type slug. Always license-upgrade for this subtype.
- Validated by
recommendation_type_validate_enum
- field recommended_bandwidth_sla_bytes_per_sec: Optional[Union[StrictFloat, StrictInt]] = None
Bandwidth SLA for the recommended license tier in bytes per second.
- field recommended_iops_sla: Optional[Union[StrictFloat, StrictInt]] = None
IOPS SLA for the recommended license tier. Null when recommended_service_tier is a UFFO tier. Independent of current_iops_sla.
- field recommended_reserved_amount: Optional[Union[StrictFloat, StrictInt]] = None
Recommended reserved amount as a numeric quantity expressed in the unit given by reserved_unit.
- field recommended_service_tier: Optional[StrictStr] = None
Recommended service tier. Null when the recommendation is purely a reserve commit expansion with no tier change.
- field reserved_unit: Optional[StrictStr] = None
Unit for current_reserved_amount and recommended_reserved_amount (e.g. B, GiB, TiB, VMs). Plain-text unit; no implicit byte conversion.
- field subscription_license: Optional[FixedReference] = None
Associated subscription license reference. Present when the recommendation is linked to a specific Everpure subscription license; null otherwise.
- field target: Optional[FixedReference] = None
Reference to the target asset this recommendation applies to.
- field trigger: Optional[RecommendationTrigger] = None
Reference to the recommendation program that generated this recommendation.
- validator recommendation_type_validate_enum » recommendation_type
Validates the enum
LicenseUpgradeRecommendationGetResponse
- pydantic model pypureclient.pure1.LicenseUpgradeRecommendationGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LicenseUpgradeRecommendation]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[LicenseUpgradeRecommendation]] = None
List of license upgrade recommendations on the current page.
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
LicenseUpgradeRecommendationResponse
- pydantic model pypureclient.pure1.LicenseUpgradeRecommendationResponse(*, items: Optional[ConstrainedListValue[LicenseUpgradeRecommendation]] = None)
- field items: Optional[ConstrainedListValue[LicenseUpgradeRecommendation]] = None
List of license upgrade recommendations on the current page.
MarketplacePartner
- pydantic model pypureclient.pure1.MarketplacePartner(*, name: Optional[StrictStr] = None, reference_id: Optional[StrictStr] = None)
- field name: Optional[StrictStr] = None
Name or identifier of the marketplace parter who owns the reference ID.
- field reference_id: Optional[StrictStr] = None
External ID the marketplace partner knows to refer to this license.
Metric
- pydantic model pypureclient.pure1.Metric(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, availabilities: Optional[ConstrainedListValue[MetricAvailability]] = None, description: Optional[StrictStr] = None, resource_types: Optional[ConstrainedListValue[StrictStr]] = None, unit: Optional[StrictStr] = None)
A type of measurement recorded on a resource.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field availabilities: Optional[ConstrainedListValue[MetricAvailability]] = None
The available resolutions, aggregations and retentions of this metric.
- field description: Optional[StrictStr] = None
The additional description for the the metric.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field resource_types: Optional[ConstrainedListValue[StrictStr]] = None
The type of resource (as described by their endpoints) that this metric is available at. NOTE that a metric could be available for a combination of resource types, e.g. mirrored writes from “arrays” to “pods”.
- field unit: Optional[StrictStr] = None
The unit of the metric.
MetricAvailability
- pydantic model pypureclient.pure1.MetricAvailability(*, aggregations: Optional[ConstrainedListValue[StrictStr]] = None, resolution: Optional[StrictInt] = None, retention: Optional[StrictInt] = None)
- field aggregations: Optional[ConstrainedListValue[StrictStr]] = None
Available aggregations for this metric at the given resolution, e.g. ‘avg’, ‘max’.
- field resolution: Optional[StrictInt] = None
An available resolution of this metric in milliseconds.
- field retention: Optional[StrictInt] = None
The retention at this given resolution in milliseconds.
MetricGetResponse
- pydantic model pypureclient.pure1.MetricGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Metric]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
MetricHistory
- pydantic model pypureclient.pure1.MetricHistory(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, aggregation: Optional[StrictStr] = None, data: Optional[ConstrainedListValue[ConstrainedListValue[Union[StrictFloat, StrictInt]]]] = None, resolution: Optional[StrictInt] = None, resources: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, unit: Optional[StrictStr] = None)
- field aggregation: Optional[StrictStr] = None
The aggregation of the metric data.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field data: Optional[ConstrainedListValue[ConstrainedListValue[Union[StrictFloat, StrictInt]]]] = None
The data points of the metric corresponding to the time window, resolution and aggregation. The points are returned in a nested array of 2-element arrays. For each of the 2-element array, the 1st element is the UTC millisecond epoch, and the 2nd element is the value, e.g. [[1519362000000, 11], [1519362030000, 21], …].
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field resolution: Optional[StrictInt] = None
The resolution of the metric data in milliseconds.
- field resources: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The references to the resources that the metric data is for. For example, write-iops metric for an array will have one element in this list referencing the array entity. the write-iops from an array to a pod will contain two elements in this list - first element pointing to the array, and second element pointing to the pod.
- field unit: Optional[StrictStr] = None
The unit of the metric data.
MetricHistoryGetResponse
- pydantic model pypureclient.pure1.MetricHistoryGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[MetricHistory]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[MetricHistory]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
MetricHistoryResponse
- pydantic model pypureclient.pure1.MetricHistoryResponse(*, items: Optional[ConstrainedListValue[MetricHistory]] = None)
- field items: Optional[ConstrainedListValue[MetricHistory]] = None
MetricResponse
NetworkInterface
- pydantic model pypureclient.pure1.NetworkInterface(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, address: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, gateway: Optional[StrictStr] = None, hwaddr: Optional[StrictStr] = None, mtu: Optional[StrictInt] = None, netmask: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, speed: Optional[StrictInt] = None, subinterfaces: Optional[ConstrainedListValue[StrictStr]] = None)
- field address: Optional[StrictStr] = None
IP address of this network interface.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field enabled: Optional[StrictBool] = None
- Constraints
type = boolean
- field gateway: Optional[StrictStr] = None
- field hwaddr: Optional[StrictStr] = None
Hardware address.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field mtu: Optional[StrictInt] = None
Maximum transmission unit.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field netmask: Optional[StrictStr] = None
- field services: Optional[ConstrainedListValue[StrictStr]] = None
Services and protocols that are enabled on the interface.
- field speed: Optional[StrictInt] = None
Speed in bytes per second.
- field subinterfaces: Optional[ConstrainedListValue[StrictStr]] = None
NetworkInterfaceGetResponse
- pydantic model pypureclient.pure1.NetworkInterfaceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterface]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[NetworkInterface]] = None
A list of network interface objects.
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
NetworkInterfaceResponse
- pydantic model pypureclient.pure1.NetworkInterfaceResponse(*, items: Optional[ConstrainedListValue[NetworkInterface]] = None)
- field items: Optional[ConstrainedListValue[NetworkInterface]] = None
A list of network interface objects.
Nfs
Oauth210TokenPost400Response
Oauth210TokenPost401Response
OauthTokenResponse
- pydantic model pypureclient.pure1.OauthTokenResponse(*, access_token: Optional[StrictStr] = None, expires_in: Optional[StrictInt] = None, issued_token_type: Optional[StrictStr] = None, token_type: Optional[StrictStr] = None)
- field access_token: Optional[StrictStr] = None
The serialized OAuth 2.0 Bearer token used to perform authenticated requests. The access token must be added to the Authorization header of all API calls.
- field expires_in: Optional[StrictInt] = None
The duration after which the access token will expire. Measured in seconds. This differs from other duration fields that are expressed in milliseconds.
- field issued_token_type: Optional[StrictStr] = None
The type of token that is issued. The Everpure REST API supports OAuth 2.0 access tokens.
- field token_type: Optional[StrictStr] = None
Indicates how the API client can use the access token issued. The Everpure REST API supports the Bearer token.
ObjectStoreAccount
- pydantic model pypureclient.pure1.ObjectStoreAccount(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, object_count: Optional[StrictInt] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created: Optional[StrictInt] = None
Creation timestamp of the object, in milliseconds since Unix epoch.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A modifiable, locally unique name chosen by the user.
- field object_count: Optional[StrictInt] = None
The number of objects within the account.
ObjectStoreAccountGetResponse
- pydantic model pypureclient.pure1.ObjectStoreAccountGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None
A list of object store accounts.
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
ObjectStoreAccountResponse
- pydantic model pypureclient.pure1.ObjectStoreAccountResponse(*, items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None)
- field items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None
A list of object store accounts.
PageInfo
- pydantic model pypureclient.pure1.PageInfo(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
PlanningSimulationActiveclusterFailoverDetails
- pydantic model pypureclient.pure1.PlanningSimulationActiveclusterFailoverDetails(*, arrays: ConstrainedListValue[PlanningSimulationArrayReference])
ActiveCluster failover projection details for a planning simulation step. The two named arrays form a stretched pair; all pods stretched between them are in scope for the simulation. For each array listed in the request resources, the corresponding response item represents the projected load and capacity for that array as the surviving array after the other array in the pair fails. No pod-level or volume-level selector is accepted for this action.
- field arrays: ConstrainedListValue[PlanningSimulationArrayReference] [Required]
The two arrays in a stretched ActiveCluster pair. Each entry identifies an array by id or name. Exactly two entries are required.
- Constraints
minItems = 2
maxItems = 2
PlanningSimulationActiveclusterFailoverStep
- pydantic model pypureclient.pure1.PlanningSimulationActiveclusterFailoverStep(*, action: StrictStr, details: PlanningSimulationActiveclusterFailoverDetails)
A planning simulation step that computes projected load and capacity for each of two arrays in a stretched ActiveCluster pair, treating each array as the surviving array after the other array in the pair fails. All pods stretched between the two named arrays are in scope for the simulation.
- field action: StrictStr [Required]
The planning simulation action for this step. The valid value is simulations/activecluster/failover.
- field details: PlanningSimulationActiveclusterFailoverDetails [Required]
PlanningSimulationArrayReference
- pydantic model pypureclient.pure1.PlanningSimulationArrayReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
A reference to an array used in a planning simulation request. Specify either id or name to identify the array.
- field id: Optional[StrictStr] = None
A globally unique, system-generated ID. The ID cannot be modified.
- field name: Optional[StrictStr] = None
The resource name, such as volume name, pod name, snapshot name, and so on.
PlanningSimulationMetric
- pydantic model pypureclient.pure1.PlanningSimulationMetric(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, aggregation: Optional[StrictStr] = None, data: Optional[ConstrainedListValue[ConstrainedListValue[Union[StrictFloat, StrictInt]]]] = None, resolution: Optional[StrictInt] = None, resources: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, unit: Optional[StrictStr] = None)
- field aggregation: Optional[StrictStr] = None
The aggregation mode used for the projected metric data.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field data: Optional[ConstrainedListValue[ConstrainedListValue[Union[StrictFloat, StrictInt]]]] = None
The projected data points corresponding to the projection window, resolution, and aggregation. The points are returned in a nested array of two-element arrays. For each two-element array, the first element is the UTC millisecond epoch timestamp and the second element is the projected value.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
The name of the projected metric. Valid values include projected_load and projected_capacity.
- field resolution: Optional[StrictInt] = None
The resolution of the projected metric data in milliseconds.
- field resources: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The array resource that the projected metric data is for.
- field unit: Optional[StrictStr] = None
The unit of the projected metric data.
PlanningSimulationMetricRequest
- pydantic model pypureclient.pure1.PlanningSimulationMetricRequest(*, aggregation: Optional[StrictStr] = None, name: StrictStr)
A projected metric to include in a planning simulation response, optionally with an aggregation mode. Only the projected_load timeseries differs by aggregation mode; projected_capacity is computed on daily granularity, so both aggregation modes return the same values. If aggregation is not specified, the server uses blended_max as the default.
- field aggregation: Optional[StrictStr] = None
The aggregation mode for the requested metric. Valid values are average and blended_max. If not specified, the server uses blended_max. This field only affects projected_load; projected_capacity returns the same values regardless of the requested aggregation mode.
- field name: StrictStr [Required]
The name of the projected metric. Valid values are projected_load and projected_capacity.
PlanningSimulationPost
- pydantic model pypureclient.pure1.PlanningSimulationPost(*, metrics: Optional[ConstrainedListValue[PlanningSimulationMetricRequest]] = None, projection_end_time: Optional[StrictInt] = None, projection_start_time: Optional[StrictInt] = None, resolution: Optional[StrictInt] = None, resources: ConstrainedListValue[PlanningSimulationArrayReference], steps: Optional[ConstrainedListValue[PlanningSimulationStep]] = None, training_end_time: Optional[StrictInt] = None, training_start_time: Optional[StrictInt] = None)
Parameters for evaluating a Pure1 planning simulation. The resources field lists the arrays whose projections are returned. An array listed in resources that is not targeted by any step receives baseline projections; an array listed in resources that is targeted by one or more steps receives simulated projections that reflect the applied steps. An array referenced only inside a step (for example as the source or target of a simulations/volumes/move step) but not listed in resources participates in the simulation as input and does not appear in the response. A missing or empty resources array is rejected as a client error. The valid step actions are simulations/volumes/move and simulations/activecluster/failover.
- field metrics: Optional[ConstrainedListValue[PlanningSimulationMetricRequest]] = None
The projected metrics to include in the response, each optionally with a per-metric aggregation mode. If metrics is not specified, the server returns both projected_load and projected_capacity with the default aggregation mode. Only projected_load differs by aggregation mode; projected_capacity is computed on daily granularity, so both aggregation modes return the same values. If a metric entry omits aggregation, the server uses blended_max as the default.
- field projection_end_time: Optional[StrictInt] = None
The end of the projection window, in UTC milliseconds since the UNIX epoch. If not specified, defaults to three months after the request time.
- field projection_start_time: Optional[StrictInt] = None
The start of the projection window, in UTC milliseconds since the UNIX epoch. If not specified, defaults to the most recent UTC midnight at or before the request time.
- field resolution: Optional[StrictInt] = None
The resolution of projected time series in milliseconds. If not specified, defaults to daily (86400000 milliseconds).
- field resources: ConstrainedListValue[PlanningSimulationArrayReference] [Required]
The arrays for which to return projected load and capacity. Each entry identifies an array by id or name. Arrays listed here without a corresponding simulation step receive baseline projections; arrays targeted by one or more steps receive simulated projections. This field is required and must contain at least one array.
- Constraints
minItems = 1
- field steps: Optional[ConstrainedListValue[PlanningSimulationStep]] = None
The simulation steps to apply. If omitted or empty, the response contains baseline projections for every array listed in resources.
- field training_end_time: Optional[StrictInt] = None
The end of the historical training window, in UTC milliseconds since the UNIX epoch. If not specified, defaults to the most recent UTC midnight at or before the request time.
- field training_start_time: Optional[StrictInt] = None
The start of the historical training window, in UTC milliseconds since the UNIX epoch. If not specified, defaults to three months before the request time.
PlanningSimulationResponse
- pydantic model pypureclient.pure1.PlanningSimulationResponse(*, items: Optional[ConstrainedListValue[PlanningSimulationMetric]] = None, total_item_count: Optional[StrictInt] = None)
- field items: Optional[ConstrainedListValue[PlanningSimulationMetric]] = None
The projected metric results.
- field total_item_count: Optional[StrictInt] = None
The total number of projected metric results.
PlanningSimulationStep
- pydantic model pypureclient.pure1.PlanningSimulationStep(*args, anyof_schema_1_validator: Optional[PlanningSimulationActiveclusterFailoverStep] = None, anyof_schema_2_validator: Optional[PlanningSimulationVolumeMoveStep] = None, actual_instance: Any = None, any_of_schemas: List[str] = ['PlanningSimulationActiveclusterFailoverStep', 'PlanningSimulationVolumeMoveStep'], discriminator_value_class_map: dict = {})
- Validators
actual_instance_must_validate_anyof»actual_instance
- field actual_instance: Any = None
- Validated by
actual_instance_must_validate_anyof
- field any_of_schemas: List[str] = ['PlanningSimulationActiveclusterFailoverStep', 'PlanningSimulationVolumeMoveStep']
- Constraints
const = [‘PlanningSimulationActiveclusterFailoverStep’, ‘PlanningSimulationVolumeMoveStep’]
- field anyof_schema_1_validator: Optional[PlanningSimulationActiveclusterFailoverStep] = None
- field anyof_schema_2_validator: Optional[PlanningSimulationVolumeMoveStep] = None
- validator actual_instance_must_validate_anyof » actual_instance
PlanningSimulationVolumeMoveDetails
- pydantic model pypureclient.pure1.PlanningSimulationVolumeMoveDetails(*, source: PlanningSimulationArrayReference, target: PlanningSimulationArrayReference, volumes: ConstrainedListValue[PlanningSimulationVolumeReference])
Volume move projection details for a planning simulation step. The listed volumes on the source array are treated as if they were moved to the target array when projecting load and capacity. Requests that reference volumes belonging to a stretched pod are rejected as a client error, since stretched-pod volume movement is not modeled by this simulation.
- field source: PlanningSimulationArrayReference [Required]
- field target: PlanningSimulationArrayReference [Required]
- field volumes: ConstrainedListValue[PlanningSimulationVolumeReference] [Required]
The volumes on the source array to include in the move.
- Constraints
minItems = 1
PlanningSimulationVolumeMoveStep
- pydantic model pypureclient.pure1.PlanningSimulationVolumeMoveStep(*, action: StrictStr, details: PlanningSimulationVolumeMoveDetails)
A planning simulation step that computes projected load and capacity after moving a set of volumes from a source array to a target array. Compose two simulations/volumes/move steps in the same request to model a swap between two arrays.
- field action: StrictStr [Required]
The planning simulation action for this step. The valid value is simulations/volumes/move.
- field details: PlanningSimulationVolumeMoveDetails [Required]
PlanningSimulationVolumeReference
- pydantic model pypureclient.pure1.PlanningSimulationVolumeReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
A reference to a volume used in a planning simulation request. Specify either id or name to identify the volume.
- field id: Optional[StrictStr] = None
A globally unique, system-generated ID. The ID cannot be modified.
- field name: Optional[StrictStr] = None
The resource name, such as volume name, pod name, snapshot name, and so on.
Pod
- pydantic model pypureclient.pure1.Pod(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, mediator: Optional[StrictStr] = None, source: Optional[FixedReference] = None)
An administrative domain, a data container, and a namespace for volumes and protection groups.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field mediator: Optional[StrictStr] = None
The URL of the mediator for this pod.
- field name: Optional[StrictStr] = None
A modifiable, locally unique name chosen by the user.
- field source: Optional[FixedReference] = None
A reference to the source pod of a pod clone.
PodGetResponse
- pydantic model pypureclient.pure1.PodGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Pod]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
PodReplicaLink
- pydantic model pypureclient.pure1.PodReplicaLink(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, paused: Optional[StrictBool] = None, recovery_point: Optional[StrictInt] = None, status: Optional[StrictStr] = None, members: Optional[ConstrainedListValue[ResourceWithLocations]] = None, sources: Optional[ConstrainedListValue[ResourceWithLocations]] = None, targets: Optional[ConstrainedListValue[ResourceWithLocations]] = None)
A replica link between two pods.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field lag: Optional[StrictInt] = None
Duration, in milliseconds, which represents how far behind the replication target is from the source.
- field members: Optional[ConstrainedListValue[ResourceWithLocations]] = None
The union of source and target pods in the replica link.
- field paused: Optional[StrictBool] = None
Returns true if the replica link is paused.
- Constraints
type = boolean
- field recovery_point: Optional[StrictInt] = None
Time when the last piece of data was replicated, in milliseconds since the UNIX epoch, and the recovery point if the target pod is promoted. If the pod is currently baselining then the value is null.
- field sources: Optional[ConstrainedListValue[ResourceWithLocations]] = None
The source pods in the replica link.
- field status: Optional[StrictStr] = None
Status of the replica link. Values include replicating, idle, baselining, paused, quiescing, quiesced, and unhealthy.
- field targets: Optional[ConstrainedListValue[ResourceWithLocations]] = None
The target pods in the replica link.
PodReplicaLinkGetResponse
- pydantic model pypureclient.pure1.PodReplicaLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PodReplicaLink]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[PodReplicaLink]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
PodReplicaLinkResponse
- pydantic model pypureclient.pure1.PodReplicaLinkResponse(*, items: Optional[ConstrainedListValue[PodReplicaLink]] = None)
- field items: Optional[ConstrainedListValue[PodReplicaLink]] = None
PodResponse
Policy
- pydantic model pypureclient.pure1.Policy(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, enabled: Optional[StrictBool] = None, rules: Optional[ConstrainedListValue[PolicyRule]] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field enabled: Optional[StrictBool] = None
Returns true if this policy is enabled.
- Constraints
type = boolean
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field rules: Optional[ConstrainedListValue[PolicyRule]] = None
PolicyGetResponse
- pydantic model pypureclient.pure1.PolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Policy]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
PolicyMember
- pydantic model pypureclient.pure1.PolicyMember(*, _as_of: Optional[StrictInt] = None, member: Optional[FixedReference] = None, policy: Optional[FixedReference] = None)
An association between a policy and a member.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field member: Optional[FixedReference] = None
- field policy: Optional[FixedReference] = None
PolicyMembersGetResponse
- pydantic model pypureclient.pure1.PolicyMembersGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMember]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[PolicyMember]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
PolicyMembersResponse
- pydantic model pypureclient.pure1.PolicyMembersResponse(*, items: Optional[ConstrainedListValue[PolicyMember]] = None)
- field items: Optional[ConstrainedListValue[PolicyMember]] = None
PolicyResponse
PolicyRule
- pydantic model pypureclient.pure1.PolicyRule(*, at: Optional[StrictInt] = None, every: Optional[StrictInt] = None, keep_for: Optional[StrictInt] = None, time_zone: Optional[StrictStr] = None)
A rule that can be added to a policy.
- field at: Optional[StrictInt] = None
Time of day to take the snapshot, in milliseconds since 00:00 in the specified time_zone. Only valid if every is set as whole days.
- field every: Optional[StrictInt] = None
How often to take snapshots, in milliseconds.
- field keep_for: Optional[StrictInt] = None
How long to keep snapshots, in milliseconds.
- field time_zone: Optional[StrictStr] = None
The time zone in which the at rule is applied.
Port
- pydantic model pypureclient.pure1.Port(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, failover: Optional[StrictStr] = None, iqn: Optional[StrictStr] = None, nqn: Optional[StrictStr] = None, portal: Optional[StrictStr] = None, wwn: Optional[StrictStr] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field failover: Optional[StrictStr] = None
If the array port has failed over, returns the name of the port to which this port has failed over.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field iqn: Optional[StrictStr] = None
The iSCSI Qualified Name if the port is iSCSI, null otherwise.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field nqn: Optional[StrictStr] = None
The NVMe Qualified Name if the port is NVMe-oF, null otherwise.
- field portal: Optional[StrictStr] = None
The IP and port number if the port is iSCSI or NVMe-oF, null otherwise.
- field wwn: Optional[StrictStr] = None
The Fibre Channel World Wide Name if the port is Fibre Channel, null otherwise.
PortGetResponse
- pydantic model pypureclient.pure1.PortGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Port]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
PortResponse
ProtectionGroupSnapshot
- pydantic model pypureclient.pure1.ProtectionGroupSnapshot(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, created: Optional[StrictInt] = None, on: Optional[FixedReferenceFqdn] = None, pod: Optional[FixedReference] = None, source: Optional[FixedReference] = None)
A protection group snapshot is a collection of point-in-time consistent volume snapshots, for volumes associated with the protection group when the snapshot was taken.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created: Optional[StrictInt] = None
Creation time in milliseconds since UNIX epoch.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field on: Optional[FixedReferenceFqdn] = None
A reference to the array where the snapshot is stored.
- field pod: Optional[FixedReference] = None
A reference to the pod the source protection group belongs to, if applicable.
- field source: Optional[FixedReference] = None
A reference to the protection group that the snapshot was taken from.
ProtectionGroupSnapshotGetResponse
- pydantic model pypureclient.pure1.ProtectionGroupSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
ProtectionGroupSnapshotResponse
- pydantic model pypureclient.pure1.ProtectionGroupSnapshotResponse(*, items: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None)
- field items: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None
ProtectionGroupSnapshotTransfer
- pydantic model pypureclient.pure1.ProtectionGroupSnapshotTransfer(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, completed: Optional[StrictInt] = None, data_transferred: Optional[StrictInt] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, started: Optional[StrictInt] = None)
The transfer statistics for snapshot replication data.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field completed: Optional[StrictInt] = None
The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.
- field data_transferred: Optional[StrictInt] = None
The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field progress: Optional[Union[StrictFloat, StrictInt]] = None
The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.
- field started: Optional[StrictInt] = None
The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.
ProtectionGroupSnapshotTransferGetResponse
- pydantic model pypureclient.pure1.ProtectionGroupSnapshotTransferGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
ProtectionGroupSnapshotTransferResponse
- pydantic model pypureclient.pure1.ProtectionGroupSnapshotTransferResponse(*, items: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None)
- field items: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None
Recommendation
- pydantic model pypureclient.pure1.Recommendation(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, company: Optional[Company] = None, created_at: Optional[StrictInt] = None, description: Optional[StrictStr] = None, recommendation_type: Optional[StrictStr] = None, subscription_license: Optional[FixedReference] = None, target: Optional[FixedReference] = None, trigger: Optional[RecommendationTrigger] = None)
A generic recommendation resource containing base fields shared across all recommendation types. The recommendation_type field identifies the type slug; use it as the {recommendation_type} path parameter to retrieve the full type-specific response.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created_at: Optional[StrictInt] = None
Creation timestamp of the recommendation in epoch milliseconds.
- field description: Optional[StrictStr] = None
Human-readable description of the recommendation.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field recommendation_type: Optional[StrictStr] = None
Type slug that identifies the recommendation category. Matches the {recommendation_type} path segment on the type-specific endpoint. Can be one of: flasharray-hardware-upgrade, license-upgrade, support-contract-renewal, or other recommendation types that may be added in the future.
- field subscription_license: Optional[FixedReference] = None
Associated subscription license reference. Present when the recommendation is linked to a specific Everpure subscription license; null otherwise.
- field target: Optional[FixedReference] = None
Reference to the target asset this recommendation applies to.
- field trigger: Optional[RecommendationTrigger] = None
Reference to the recommendation program that generated this recommendation.
RecommendationBase
- pydantic model pypureclient.pure1.RecommendationBase(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, company: Optional[Company] = None, created_at: Optional[StrictInt] = None, description: Optional[StrictStr] = None, recommendation_type: Optional[StrictStr] = None, subscription_license: Optional[FixedReference] = None, target: Optional[FixedReference] = None, trigger: Optional[RecommendationTrigger] = None)
Recommendation generic object with the base fields shared by all recommendation types. Each recommendation is generated by a recommendation program (trigger) and targets a specific Everpure asset.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created_at: Optional[StrictInt] = None
Creation timestamp of the recommendation in epoch milliseconds.
- field description: Optional[StrictStr] = None
Human-readable description of the recommendation.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field recommendation_type: Optional[StrictStr] = None
Type slug that identifies the recommendation category. Matches the {recommendation_type} path segment on the type-specific endpoint. Can be one of: flasharray-hardware-upgrade, license-upgrade, support-contract-renewal, or other recommendation types that may be added in the future.
- field subscription_license: Optional[FixedReference] = None
Associated subscription license reference. Present when the recommendation is linked to a specific Everpure subscription license; null otherwise.
- field target: Optional[FixedReference] = None
Reference to the target asset this recommendation applies to.
- field trigger: Optional[RecommendationTrigger] = None
Reference to the recommendation program that generated this recommendation.
RecommendationGetResponse
- pydantic model pypureclient.pure1.RecommendationGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Recommendation]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[Recommendation]] = None
List of recommendations on the current page.
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
RecommendationResponse
- pydantic model pypureclient.pure1.RecommendationResponse(*, items: Optional[ConstrainedListValue[Recommendation]] = None)
- field items: Optional[ConstrainedListValue[Recommendation]] = None
List of recommendations on the current page.
RecommendationTrigger
ReferenceWithoutType
- pydantic model pypureclient.pure1.ReferenceWithoutType(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
- field id: Optional[StrictStr] = None
A globally unique, system-generated ID. The ID cannot be modified.
- field name: Optional[StrictStr] = None
The resource name, such as volume name, pod name, snapshot name, and so on.
ReplicaLink
- pydantic model pypureclient.pure1.ReplicaLink(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, paused: Optional[StrictBool] = None, recovery_point: Optional[StrictInt] = None, status: Optional[StrictStr] = None)
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field lag: Optional[StrictInt] = None
Duration, in milliseconds, which represents how far behind the replication target is from the source.
- field paused: Optional[StrictBool] = None
Returns true if the replica link is paused.
- Constraints
type = boolean
- field recovery_point: Optional[StrictInt] = None
Time when the last piece of data was replicated, measured in milliseconds since the UNIX epoch, and the recovery point of the resource.
- field status: Optional[StrictStr] = None
Status of the replica link. Values include replicating, idle, and unhealthy.
Resource
- pydantic model pypureclient.pure1.Resource(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
An ordinary (as opposed to built-in) resource that can be created, named, renamed, or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the physical environment, like a host or a server.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A modifiable, locally unique name chosen by the user.
ResourceNoName
- pydantic model pypureclient.pure1.ResourceNoName(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None)
An ordinary (as opposed to built-in) resource that can be created or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the physical environment, like a host or a server.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
ResourceWithLocation
- pydantic model pypureclient.pure1.ResourceWithLocation(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, location: Optional[FixedReferenceFqdn] = None)
An ordinary resource that exists in one location.
- field id: Optional[StrictStr] = None
The opaque and unique id of this resource.
- field location: Optional[FixedReferenceFqdn] = None
- field name: Optional[StrictStr] = None
The name of this resource.
- field resource_type: Optional[StrictStr] = None
The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.
ResourceWithLocations
- pydantic model pypureclient.pure1.ResourceWithLocations(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, locations: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None)
A resource that may relate to multiple locations.
- field id: Optional[StrictStr] = None
The opaque and unique id of this resource.
- field locations: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
- field name: Optional[StrictStr] = None
The name of this resource.
- field resource_type: Optional[StrictStr] = None
The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.
SecurityInsightArray
- pydantic model pypureclient.pure1.SecurityInsightArray(*, _as_of: Optional[StrictInt] = None, additional_data: Optional[Dict[str, Any]] = None, resource: Optional[FixedReferenceFqdn] = None, type: Optional[StrictStr] = None)
A security insight reporting a potentially insecure condition on a single FlashArray or FlashBlade appliance. The _as_of is the time when the insight was generated.
- field additional_data: Optional[Dict[str, Any]] = None
The arbitrary data associated with the insight.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field resource: Optional[FixedReferenceFqdn] = None
- field type: Optional[StrictStr] = None
The type of the insight. Valid values are appliance_not_phoning_home, end_of_life_purity_version_in_use, public_access_risk, purity_optimizations_available, unsafe_password_configuration, remote_assist_longer_than_eight_hours, remote_assist_longer_than_one_day, open_critical_alerts_detected, open_anomalies_detected, data_protection_needs_review, ntp_server_not_enabled, remote_access_control_not_enabled, critical_cve_detected, high_cve_detected, medium_cve_detected, and low_cve_detected.
SecurityInsightArrayGetResponse
- pydantic model pypureclient.pure1.SecurityInsightArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SecurityInsightArray]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[SecurityInsightArray]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
SecurityInsightArrayResponse
- pydantic model pypureclient.pure1.SecurityInsightArrayResponse(*, items: Optional[ConstrainedListValue[SecurityInsightArray]] = None)
- field items: Optional[ConstrainedListValue[SecurityInsightArray]] = None
Smb
Subscription
- pydantic model pypureclient.pure1.Subscription(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, customer_name: Optional[StrictStr] = None, expiration_date: Optional[StrictInt] = None, initial_name: Optional[StrictStr] = None, last_updated_date: Optional[StrictInt] = None, organization: Optional[FixedReference] = None, partner_name: Optional[StrictStr] = None, service: Optional[StrictStr] = None, service_details: Optional[SubscriptionAllOfServiceDetails] = None, start_date: Optional[StrictInt] = None, status: Optional[StrictStr] = None, subscription_term: Optional[StrictInt] = None)
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field customer_name: Optional[StrictStr] = None
The name of the end customer of the asset.
- field expiration_date: Optional[StrictInt] = None
Date when the subscription expires. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field initial_name: Optional[StrictStr] = None
A non-modifiable, locally unique name that the subscription was started with, never changes.
- field last_updated_date: Optional[StrictInt] = None
The date of the last amendment to the current subscription. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field organization: Optional[FixedReference] = None
This field has been deprecated. Please use customer_name instead. The Pure1 organization for the asset.
- field partner_name: Optional[StrictStr] = None
The partner who invoices for the subscription.
- field service: Optional[StrictStr] = None
The service type of the subscription. Values include Evergreen//One, Evergreen//Flex, FlashStack as a Service, Storage as a Service, PaaS (Block Storage Service), PaaS (File and Object Storage Service), PaaS (Data Protection Service), and Pure1 Subscription.
- field service_details: Optional[SubscriptionAllOfServiceDetails] = None
- field start_date: Optional[StrictInt] = None
Date when the subscription starts. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field status: Optional[StrictStr] = None
Current status of the subscription. Values include active, terminated, poc-expired, and signed.
- field subscription_term: Optional[StrictInt] = None
Length of the subscription in months.
SubscriptionAllOfServiceDetails
- pydantic model pypureclient.pure1.SubscriptionAllOfServiceDetails(*args, oneof_schema_1_validator: Optional[EvergreenForeverAndFoundationDetails] = None, oneof_schema_2_validator: Optional[Dict[str, Any]] = None, actual_instance: Any = None, one_of_schemas: List[str] = ['EvergreenForeverAndFoundationDetails', 'object'])
Additional details for the given service.
- Validators
actual_instance_must_validate_oneof»actual_instance
- field actual_instance: Any = None
- Validated by
actual_instance_must_validate_oneof
- field one_of_schemas: List[str] = ['EvergreenForeverAndFoundationDetails', 'object']
- Constraints
const = [‘EvergreenForeverAndFoundationDetails’, ‘object’]
- field oneof_schema_1_validator: Optional[EvergreenForeverAndFoundationDetails] = None
- field oneof_schema_2_validator: Optional[Dict[str, Any]] = None
- validator actual_instance_must_validate_oneof » actual_instance
SubscriptionAsset
- pydantic model pypureclient.pure1.SubscriptionAsset(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, activation_date: Optional[StrictInt] = None, array: Optional[SubscriptionAssetArray] = None, customer_name: Optional[StrictStr] = None, end_of_life_date: Optional[StrictInt] = None, install_address: Optional[AssetAddress] = None, license: Optional[FixedReference] = None, organization: Optional[AssetOrg] = None, subscription: Optional[FixedReference] = None, upgrade_details: Optional[AssetUpgradeDetails] = None)
- field activation_date: Optional[StrictInt] = None
The date when the appliance is activated under the license. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field array: Optional[SubscriptionAssetArray] = None
The specific fields for assets that are arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field customer_name: Optional[StrictStr] = None
The name of the end customer of the asset.
- field end_of_life_date: Optional[StrictInt] = None
The date when the appliance hardware reach end of life and Pure no longer provide support. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field install_address: Optional[AssetAddress] = None
The address where the appliance is installed. This address is also where replacement parts will be shipped to.
- field license: Optional[FixedReference] = None
A reference to which license this appliance belongs.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field organization: Optional[AssetOrg] = None
This field has been deprecated. Please use customer_name instead. The Pure1 organization for the asset.
- field subscription: Optional[FixedReference] = None
A reference to which subscription this appliance belongs.
- field upgrade_details: Optional[AssetUpgradeDetails] = None
The address where the appliance is installed. This address is also where replacement parts will be shipped to.
SubscriptionAssetArray
- pydantic model pypureclient.pure1.SubscriptionAssetArray(*, advanced_space: Optional[SubscriptionAssetArrayAdvancedSpace] = None, chassis_serial_number: Optional[StrictStr] = None, model: Optional[StrictStr] = None, space: Optional[AssetSpace] = None, version: Optional[StrictStr] = None)
- field advanced_space: Optional[SubscriptionAssetArrayAdvancedSpace] = None
The physical and effective space information. Only visible when the query parameter advanced_space is set to true.
- field chassis_serial_number: Optional[StrictStr] = None
The chassis serial number of the appliance.
- field model: Optional[StrictStr] = None
The model of the appliance.
- field space: Optional[AssetSpace] = None
Displays size and space consumption information. For Evergreen//One and Evergreen//Flex this is the effective space information. For Evergreen//Forever and Evergreen//Foundation this is the physical space information.
- field version: Optional[StrictStr] = None
The Purity version of the appliance.
SubscriptionAssetArrayAdvancedSpace
- pydantic model pypureclient.pure1.SubscriptionAssetArrayAdvancedSpace(*, effective: Optional[AssetSpace] = None, physical: Optional[AssetSpace] = None)
- field effective: Optional[AssetSpace] = None
The effective space information of the appliance.
- field physical: Optional[AssetSpace] = None
The physical space information of the appliance.
SubscriptionAssetGetResponse
- pydantic model pypureclient.pure1.SubscriptionAssetGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SubscriptionAsset]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[SubscriptionAsset]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
SubscriptionAssetResponse
- pydantic model pypureclient.pure1.SubscriptionAssetResponse(*, items: Optional[ConstrainedListValue[SubscriptionAsset]] = None)
- field items: Optional[ConstrainedListValue[SubscriptionAsset]] = None
SubscriptionGetResponse
- pydantic model pypureclient.pure1.SubscriptionGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Subscription]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[Subscription]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
SubscriptionLicense
- pydantic model pypureclient.pure1.SubscriptionLicense(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, add_on_slas: Optional[ConstrainedListValue[SubscriptionLicenseAddOnSla]] = None, average_on_demand: Optional[CurrentMetric] = None, expiration_date: Optional[StrictInt] = None, last_updated_date: Optional[StrictInt] = None, marketplace_partner: Optional[MarketplacePartner] = None, pre_ratio: Optional[SubscriptionLicensePreRatio] = None, quarter_on_demand: Optional[CurrentMetric] = None, reservation: Optional[CurrentMetric] = None, resources: Optional[ConstrainedListValue[LicenseResourceReference]] = None, service_tier: Optional[StrictStr] = None, site_address: Optional[BaseAddress] = None, start_date: Optional[StrictInt] = None, subscription: Optional[FixedReference] = None, usage: Optional[CurrentMetric] = None)
- field add_on_slas: Optional[ConstrainedListValue[SubscriptionLicenseAddOnSla]] = None
Add-on SLAs.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field average_on_demand: Optional[CurrentMetric] = None
Estimated daily on-demand usage of the license from the current calendar quarter to date.
- field expiration_date: Optional[StrictInt] = None
Date when the license expires. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field last_updated_date: Optional[StrictInt] = None
The date of the last amendment to the current license. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field marketplace_partner: Optional[MarketplacePartner] = None
Reference information about the marketplace partner of this license.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field pre_ratio: Optional[SubscriptionLicensePreRatio] = None
- field quarter_on_demand: Optional[CurrentMetric] = None
Estimated total on-demand usage of the license of the current calendar quarter to date.
- field reservation: Optional[CurrentMetric] = None
Current reservation amount of the license.
- field resources: Optional[ConstrainedListValue[LicenseResourceReference]] = None
References to the resources that operate under this license.
- field service_tier: Optional[StrictStr] = None
The tier of the service for the license.
- field site_address: Optional[BaseAddress] = None
The license site address.
- field start_date: Optional[StrictInt] = None
Date when the license starts. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field subscription: Optional[FixedReference] = None
A reference to which subscription this license belongs.
- field usage: Optional[CurrentMetric] = None
Usage of the license, averaged over the last day.
SubscriptionLicenseAddOnSla
SubscriptionLicenseGetResponse
- pydantic model pypureclient.pure1.SubscriptionLicenseGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SubscriptionLicense]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[SubscriptionLicense]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
SubscriptionLicensePreRatio
- pydantic model pypureclient.pure1.SubscriptionLicensePreRatio(*, data: Optional[Union[StrictFloat, StrictInt]] = None, metric: Optional[FixedReference] = None, unit: Optional[StrictStr] = None)
The pre-reduced & encrypted ratio calculated at license level.
- field data: Optional[Union[StrictFloat, StrictInt]] = None
- field metric: Optional[FixedReference] = None
A reference to the metric this data measures.
- field unit: Optional[StrictStr] = None
The unit of the metric.
SubscriptionLicenseResponse
- pydantic model pypureclient.pure1.SubscriptionLicenseResponse(*, items: Optional[ConstrainedListValue[SubscriptionLicense]] = None)
- field items: Optional[ConstrainedListValue[SubscriptionLicense]] = None
SubscriptionResponse
- pydantic model pypureclient.pure1.SubscriptionResponse(*, items: Optional[ConstrainedListValue[Subscription]] = None)
- field items: Optional[ConstrainedListValue[Subscription]] = None
SupportContract
- pydantic model pypureclient.pure1.SupportContract(*, end_date: Optional[StrictInt] = None, resource: Optional[FixedReferenceFqdn] = None, start_date: Optional[StrictInt] = None)
- field end_date: Optional[StrictInt] = None
Date when the support contract ended. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
- field resource: Optional[FixedReferenceFqdn] = None
- field start_date: Optional[StrictInt] = None
Date when the support contract started. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
SupportContractDetails
- pydantic model pypureclient.pure1.SupportContractDetails(*, expires: Optional[StrictInt] = None, subscription_evergreen_tier: Optional[StrictStr] = None, target: Optional[FixedReference] = None, target_model: Optional[StrictStr] = None)
Per-target details for a support contract included in this renewal recommendation. One entry per target under the renewal; the nested target Reference is the natural key.
- field expires: Optional[StrictInt] = None
Support contract expiration date in epoch milliseconds (UTC).
- field subscription_evergreen_tier: Optional[StrictStr] = None
Evergreen tier of the subscription for this target (e.g. Evergreen//Forever, Evergreen//Foundation).
- field target: Optional[FixedReference] = None
Reference to the target resource under the support contract.
- field target_model: Optional[StrictStr] = None
Name of the target appliance model (e.g. FA-X90R4, FA-C60, FlashBlade-S200), if applicable.
SupportContractGetResponse
- pydantic model pypureclient.pure1.SupportContractGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SupportContract]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[SupportContract]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
SupportContractRenewalRecommendation
- pydantic model pypureclient.pure1.SupportContractRenewalRecommendation(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, company: Optional[Company] = None, created_at: Optional[StrictInt] = None, description: Optional[StrictStr] = None, recommendation_type: Optional[StrictStr] = None, subscription_license: Optional[FixedReference] = None, target: Optional[FixedReference] = None, trigger: Optional[RecommendationTrigger] = None, partner_name: Optional[StrictStr] = None, subscription_term_months: Optional[StrictInt] = None, support_contracts: Optional[ConstrainedListValue[SupportContractDetails]] = None)
A support contract renewal recommendation. Generated when a support contract is approaching expiration. Provides details about the targets covered by the contract and the proposed renewal term length.
- Validators
recommendation_type_validate_enum»recommendation_type
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created_at: Optional[StrictInt] = None
Creation timestamp of the recommendation in epoch milliseconds.
- field description: Optional[StrictStr] = None
Human-readable description of the recommendation.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field partner_name: Optional[StrictStr] = None
Name of the partner involved in this recommendation, if applicable. Null when the recommendation is not processed through a channel partner.
- field recommendation_type: Optional[StrictStr] = None
Type slug. Always support-contract-renewal for this subtype.
- Validated by
recommendation_type_validate_enum
- field subscription_license: Optional[FixedReference] = None
Associated subscription license reference. Present when the recommendation is linked to a specific Everpure subscription license; null otherwise.
- field subscription_term_months: Optional[StrictInt] = None
Proposed term length in months (e.g. 12, 24, 36).
- field support_contracts: Optional[ConstrainedListValue[SupportContractDetails]] = None
List of support contracts included in this renewal recommendation. Each entry references a support contract and provides its renewal details, including the target resource, expiration date, and Evergreen tier.
- field target: Optional[FixedReference] = None
Reference to the target asset this recommendation applies to.
- field trigger: Optional[RecommendationTrigger] = None
Reference to the recommendation program that generated this recommendation.
- validator recommendation_type_validate_enum » recommendation_type
Validates the enum
SupportContractRenewalRecommendationGetResponse
- pydantic model pypureclient.pure1.SupportContractRenewalRecommendationGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SupportContractRenewalRecommendation]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[SupportContractRenewalRecommendation]] = None
List of support contract renewal recommendations on the current page.
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
SupportContractRenewalRecommendationResponse
- pydantic model pypureclient.pure1.SupportContractRenewalRecommendationResponse(*, items: Optional[ConstrainedListValue[SupportContractRenewalRecommendation]] = None)
- field items: Optional[ConstrainedListValue[SupportContractRenewalRecommendation]] = None
List of support contract renewal recommendations on the current page.
SupportContractResponse
- pydantic model pypureclient.pure1.SupportContractResponse(*, items: Optional[ConstrainedListValue[SupportContract]] = None)
- field items: Optional[ConstrainedListValue[SupportContract]] = None
SustainabilityArray
- pydantic model pypureclient.pure1.SustainabilityArray(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, assessment: Optional[SustainabilityAssessment] = None, install_address: Optional[InstallAddress] = None, reporting_status: Optional[StrictStr] = None)
A single FlashArray/FlashBlade appliance Sustainability assessment information.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field assessment: Optional[SustainabilityAssessment] = None
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field install_address: Optional[InstallAddress] = None
The address where the array is installed. This address is also where replacement parts will be shipped to.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field reporting_status: Optional[StrictStr] = None
Enum value that describes what is the status of the latest assessment. Valid values include: not_enough_data - There was not enough data to calculate assessment level of the appliance. unsupported_purity_version - The appliance is running an unsupported version of Purity operating system. It is an old Purity version which does not provide enough data for assessing the sustainability metrics. not_phoning_home - The appliance has not phoned home for more than 7 days so the assessment level was not calculated assessment_ready - Assessment is ready and it is available under assessment field.
SustainabilityArrayGetResponse
- pydantic model pypureclient.pure1.SustainabilityArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SustainabilityArray]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[SustainabilityArray]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
SustainabilityArrayResponse
- pydantic model pypureclient.pure1.SustainabilityArrayResponse(*, items: Optional[ConstrainedListValue[SustainabilityArray]] = None)
- field items: Optional[ConstrainedListValue[SustainabilityArray]] = None
SustainabilityAssessment
- pydantic model pypureclient.pure1.SustainabilityAssessment(*, _as_of: Optional[StrictInt] = None, _interval_end: Optional[StrictInt] = None, _interval_start: Optional[StrictInt] = None, array_data_reduction: Optional[Union[StrictFloat, StrictInt]] = None, array_total_load: Optional[Union[StrictFloat, StrictInt]] = None, assessment_level: Optional[StrictStr] = None, blades: Optional[StrictInt] = None, capacity_utilization: Optional[Union[StrictFloat, StrictInt]] = None, chassis: Optional[StrictInt] = None, heat_average: Optional[Union[StrictFloat, StrictInt]] = None, heat_peak_spec: Optional[Union[StrictFloat, StrictInt]] = None, heat_typical_spec: Optional[Union[StrictFloat, StrictInt]] = None, power_average: Optional[Union[StrictFloat, StrictInt]] = None, power_peak_spec: Optional[Union[StrictFloat, StrictInt]] = None, power_per_usable_capacity: Optional[Union[StrictFloat, StrictInt]] = None, power_per_used_space: Optional[Union[StrictFloat, StrictInt]] = None, power_typical_spec: Optional[Union[StrictFloat, StrictInt]] = None, rack_units: Optional[StrictInt] = None, shelves: Optional[StrictInt] = None)
A FlashArray or FlashBlade Sustainability assessment information. The _as_of is the time when the computation happened. Only the data from the given time interval was used for the aggregation. Typically the last week of data is used for the aggregation.
- field array_data_reduction: Optional[Union[StrictFloat, StrictInt]] = None
The data reduction ratio of the appliance. Average over the assessment window.
- field array_total_load: Optional[Union[StrictFloat, StrictInt]] = None
The load percentage. Average over the assessment window.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field assessment_level: Optional[StrictStr] = None
The assessment level of an appliance. Valid values include: good - The assessment level of appliance is GOOD - all green. recommendation - There are some actions that can be done to bring appliance to a GOOD level. action_required - The lowest level of assessment. Some actions are required to improve the assessment level.
- field blades: Optional[StrictInt] = None
The number of blades of the FlashBlade appliance, always zero for FlashArray appliances.
- field capacity_utilization: Optional[Union[StrictFloat, StrictInt]] = None
The percentage of the used capacity. Average over the assessment window.
- field chassis: Optional[StrictInt] = None
The number of chassis of the appliance, always one for FlashArray appliances.
- field heat_average: Optional[Union[StrictFloat, StrictInt]] = None
The average of heat production of the appliance in BTU/Hr. Average over the assessment window.
- field heat_peak_spec: Optional[Union[StrictFloat, StrictInt]] = None
The peak heat production of the appliance in BTU/hr. The value is derived from benchmark data and remains static for the model and configuration.
- field heat_typical_spec: Optional[Union[StrictFloat, StrictInt]] = None
The typical heat production of the appliance in BTU/hr. The value is derived from benchmark data and remains static for the model and configuration.
- field interval_end: Optional[StrictInt] = None (alias '_interval_end')
The timestamp of the end of the time interval.
- field interval_start: Optional[StrictInt] = None (alias '_interval_start')
The timestamp of the start of the time interval.
- field power_average: Optional[Union[StrictFloat, StrictInt]] = None
The average of power consumption of the appliance. Average over the assessment window.
- field power_peak_spec: Optional[Union[StrictFloat, StrictInt]] = None
The peak power consumption of the appliance in Watts. The value is derived from benchmark data and remains static for the model and configuration.
- field power_per_usable_capacity: Optional[Union[StrictFloat, StrictInt]] = None
The average of power consumption per TiB of usable capacity.
- field power_per_used_space: Optional[Union[StrictFloat, StrictInt]] = None
The average of power consumption per TiB of used space.
- field power_typical_spec: Optional[Union[StrictFloat, StrictInt]] = None
The typical power consumption of the appliance in Watts. The value is derived from benchmark data and remains static for the model and configuration.
- field rack_units: Optional[StrictInt] = None
The total number of rack units occupied by the appliance.
- field shelves: Optional[StrictInt] = None
The number of expansion shelves of the FlashArray appliance. It is always zero for FlashBlade appliances.
SustainabilityInsightArray
- pydantic model pypureclient.pure1.SustainabilityInsightArray(*, _as_of: Optional[StrictInt] = None, _interval_end: Optional[StrictInt] = None, _interval_start: Optional[StrictInt] = None, additional_data: Optional[Dict[str, Any]] = None, resource: Optional[FixedReferenceFqdn] = None, severity: Optional[StrictStr] = None, type: Optional[StrictStr] = None)
A single FlashArray/FlashBlade appliance Sustainability assessment insights information. The _as_of is the time when the computation happened. Only the data from the given time interval was used for the computation of insight. Typically the last week of data is used for the computation of insights.
- field additional_data: Optional[Dict[str, Any]] = None
The arbitrary data associated with the insight.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field interval_end: Optional[StrictInt] = None (alias '_interval_end')
The timestamp of the end of the time interval.
- field interval_start: Optional[StrictInt] = None (alias '_interval_start')
The timestamp of the start of the time interval.
- field resource: Optional[FixedReferenceFqdn] = None
- field severity: Optional[StrictStr] = None
The severity of the insight. Should be one of medium, high.
- field type: Optional[StrictStr] = None
The type of the insight.
SustainabilityInsightArrayGetResponse
- pydantic model pypureclient.pure1.SustainabilityInsightArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SustainabilityInsightArray]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[SustainabilityInsightArray]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
SustainabilityInsightArrayResponse
- pydantic model pypureclient.pure1.SustainabilityInsightArrayResponse(*, items: Optional[ConstrainedListValue[SustainabilityInsightArray]] = None)
- field items: Optional[ConstrainedListValue[SustainabilityInsightArray]] = None
Tag
- pydantic model pypureclient.pure1.Tag(*, key: Optional[StrictStr] = None, namespace: Optional[StrictStr] = None, resource: Optional[FixedReference] = None, tag_organization_id: Optional[StrictInt] = None, value: Optional[StrictStr] = None)
- field key: Optional[StrictStr] = None
Key of the tag.
- field namespace: Optional[StrictStr] = None
Namespace of the tag. Namespace identifies the category of the tag.
- field resource: Optional[FixedReference] = None
- field tag_organization_id: Optional[StrictInt] = None
Org id of the tag.
- field value: Optional[StrictStr] = None
Value of the tag.
TagGetResponse
- pydantic model pypureclient.pure1.TagGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Tag]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
TagPut
TagResponse
Target
- pydantic model pypureclient.pure1.Target(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, address: Optional[StrictStr] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None)
- field address: Optional[StrictStr] = None
IP address or FQDN of the target system.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field status: Optional[StrictStr] = None
Status of the connection. Values include connected and connecting.
- field status_details: Optional[StrictStr] = None
Additional information describing any issues encountered when connecting, or null if the status is connected.
TargetGetResponse
- pydantic model pypureclient.pure1.TargetGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Target]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
TargetResponse
Tax
- pydantic model pypureclient.pure1.Tax(*, amount: Optional[Union[StrictFloat, StrictInt]] = None, exemption_statement: Optional[StrictStr] = None, percentage: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)
- field amount: Optional[Union[StrictFloat, StrictInt]] = None
The total taxes of current invoice item, currency is specified in invoice currency.
- field exemption_statement: Optional[StrictStr] = None
The tax exemption statement.
- field percentage: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None
The tax ratio in percentage.
TimeAware
TimeInterval
- pydantic model pypureclient.pure1.TimeInterval(*, _interval_end: Optional[StrictInt] = None, _interval_start: Optional[StrictInt] = None)
- field interval_end: Optional[StrictInt] = None (alias '_interval_end')
The timestamp of the end of the time interval.
- field interval_start: Optional[StrictInt] = None (alias '_interval_start')
The timestamp of the start of the time interval.
TopologyGroup
- pydantic model pypureclient.pure1.TopologyGroup(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, fleet: Optional[FixedReference] = None, parent_topology_group: Optional[FixedReference] = None)
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field fleet: Optional[FixedReference] = None
A reference to the fleet that this topology group belongs to, if any.
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field parent_topology_group: Optional[FixedReference] = None
A reference to the topology group that this topology group is a direct child of. There is no such reference if this topology group is a root group.
TopologyGroupGetResponse
- pydantic model pypureclient.pure1.TopologyGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[TopologyGroup]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[TopologyGroup]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
TopologyGroupMember
- pydantic model pypureclient.pure1.TopologyGroupMember(*, _as_of: Optional[StrictInt] = None, fleet: Optional[FixedReference] = None, member: Optional[FixedReference] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None, topology_group: Optional[FixedReference] = None)
An association between a topology group and a member.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field fleet: Optional[FixedReference] = None
A reference to the fleet that the topology group belongs to, if any.
- field member: Optional[FixedReference] = None
A reference to the member of the topology group.
- field status: Optional[StrictStr] = None
Current topology group membership status. Valid values are one of joining, joined, or removing. A status of joining indicates that the member is attempting to join the topology group. A status of joined indicates that the member has joined the topology group. A status of removing indicates that the member is being removed from the topology group.
- field status_details: Optional[StrictStr] = None
Additional detail about the membership status. The value is an empty string when there is no additional detail to report.
- field topology_group: Optional[FixedReference] = None
A reference to the topology group.
TopologyGroupMemberGetResponse
- pydantic model pypureclient.pure1.TopologyGroupMemberGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[TopologyGroupMember]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[TopologyGroupMember]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
TopologyGroupMemberResponse
- pydantic model pypureclient.pure1.TopologyGroupMemberResponse(*, items: Optional[ConstrainedListValue[TopologyGroupMember]] = None)
- field items: Optional[ConstrainedListValue[TopologyGroupMember]] = None
TopologyGroupResponse
- pydantic model pypureclient.pure1.TopologyGroupResponse(*, items: Optional[ConstrainedListValue[TopologyGroup]] = None)
- field items: Optional[ConstrainedListValue[TopologyGroup]] = None
Volume
- pydantic model pypureclient.pure1.Volume(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, eradicated: Optional[StrictBool] = None, pod: Optional[FixedReference] = None, provisioned: Optional[ConstrainedIntValue] = None, serial: Optional[StrictStr] = None, source: Optional[FixedReference] = None)
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created: Optional[StrictInt] = None
Creation time in milliseconds since UNIX epoch.
- field destroyed: Optional[StrictBool] = None
Whether this volume has been destroyed or not.
- Constraints
type = boolean
- field eradicated: Optional[StrictBool] = None
Whether this volume has been eradicated or not.
- Constraints
type = boolean
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A modifiable, locally unique name chosen by the user.
- field pod: Optional[FixedReference] = None
A reference to the pod this volume belongs to, if applicable.
- field provisioned: Optional[ConstrainedIntValue] = None
Provisioned size of the volume in bytes.
- Constraints
minimum = 1048576
maximum = 4503599627370496
- field serial: Optional[StrictStr] = None
Serial number generated by Purity when the volume was created.
- field source: Optional[FixedReference] = None
A reference to the volume this volume was cloned from, if applicable.
VolumeGetResponse
- pydantic model pypureclient.pure1.VolumeGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Volume]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
VolumeResponse
VolumeSnapshot
- pydantic model pypureclient.pure1.VolumeSnapshot(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, on: Optional[FixedReferenceFqdn] = None, pod: Optional[FixedReference] = None, provisioned: Optional[StrictInt] = None, serial: Optional[StrictStr] = None, snapshot_group: Optional[FixedReference] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictStr] = None)
A point-in-time image of the contents of a volume.
- field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None
The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.
- field as_of: Optional[StrictInt] = None (alias '_as_of')
The freshness of the data (timestamp in millis since epoch).
- field created: Optional[StrictInt] = None
Creation time in milliseconds since UNIX epoch.
- field destroyed: Optional[StrictBool] = None
Indicates if this snapshot has been destroyed and is pending eradication.
- Constraints
type = boolean
- field id: Optional[StrictStr] = None
A non-modifiable, globally unique ID chosen by the system.
- field name: Optional[StrictStr] = None
A non-modifiable, locally unique name chosen by the system.
- field on: Optional[FixedReferenceFqdn] = None
A reference to the array or the offload where the snapshot is stored.
- field pod: Optional[FixedReference] = None
A reference to the pod the source volume belongs to, if applicable.
- field provisioned: Optional[StrictInt] = None
Indicates the size (in bytes) of the volume when the snapshot was taken.
- field serial: Optional[StrictStr] = None
Serial number generated by Purity when the snapshot was created.
- field snapshot_group: Optional[FixedReference] = None
A reference to a consistency group snapshot that this snapshot is part of.
- field source: Optional[FixedReference] = None
A reference to the volume that the snapshot was taken from.
- field suffix: Optional[StrictStr] = None
Suffix added to the source volume name used to generate the volume snapshot name.
VolumeSnapshotGetResponse
- pydantic model pypureclient.pure1.VolumeSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VolumeSnapshot]] = None)
- field continuation_token: Optional[StrictStr] = None
Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
- field items: Optional[ConstrainedListValue[VolumeSnapshot]] = None
- field total_item_count: Optional[StrictInt] = None
Total number of items after applying filter params.
VolumeSnapshotResponse
- pydantic model pypureclient.pure1.VolumeSnapshotResponse(*, items: Optional[ConstrainedListValue[VolumeSnapshot]] = None)
- field items: Optional[ConstrainedListValue[VolumeSnapshot]] = None