pypureclient.flasharray.FA_2_40.models package
Submodules
pypureclient.flasharray.FA_2_40.models.active_directory module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.active_directory.ActiveDirectory(name=None, kerberos_servers=None, computer_name=None, directory_servers=None, domain=None, tls=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, kerberos_servers=None, computer_name=None, directory_servers=None, domain=None, tls=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
kerberos_servers (list[str]) – A list of key distribution servers to use for Kerberos protocol. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array. If this field is null, the servers are resolved for the domain in DNS.
computer_name (str) – The name of the computer account in the Active Directory domain.
directory_servers (list[str]) – A list of directory servers used for lookups related to user authorization. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array and are only communicated with over the secure LDAP (LDAPS) protocol. If this field is null, the servers are resolved for the domain in DNS.
domain (str) – The Active Directory domain joined.
tls (str) – TLS mode for communication with domain controllers. Valid values are required and optional. required forces TLS communication with a domain controller. optional allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to required.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'computer_name': 'computer_name', 'directory_servers': 'directory_servers', 'domain': 'domain', 'kerberos_servers': 'kerberos_servers', 'name': 'name', 'tls': 'tls'}
- keys()
- required_args = {}
- swagger_types = {'computer_name': 'str', 'directory_servers': 'list[str]', 'domain': 'str', 'kerberos_servers': 'list[str]', 'name': 'str', 'tls': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.active_directory_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.active_directory_get_response.ActiveDirectoryGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ActiveDirectory]) – A list of Active Directory computer account configuration objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ActiveDirectory]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.active_directory_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.active_directory_patch.ActiveDirectoryPatch(tls=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(tls=None)
- Keyword Arguments
tls (str) – TLS mode for communication with domain controllers. Valid values are required and optional. required forces TLS communication with domain controller. optional allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to required.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'tls': 'tls'}
- keys()
- required_args = {}
- swagger_types = {'tls': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.active_directory_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.active_directory_post.ActiveDirectoryPost(kerberos_servers=None, computer_name=None, join_ou=None, password=None, directory_servers=None, domain=None, tls=None, user=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(kerberos_servers=None, computer_name=None, join_ou=None, password=None, directory_servers=None, domain=None, tls=None, user=None)
- Keyword Arguments
kerberos_servers (list[str]) – A list of key distribution servers to use for Kerberos protocol. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array. If not specified, servers are resolved for the domain in DNS.
computer_name (str) – The name of the computer account to be created in the Active Directory domain. If not specified, defaults to the name of the Active Directory configuration.
join_ou (str) – The distinguished name of the organizational unit in which the computer account should be created when joining the domain. The DC=… components of the distinguished name can be optionally omitted. If not specified, defaults to CN=Computers.
password (str) – The login password of the user with privileges to create the computer account in the domain. This is not persisted on the array.
directory_servers (list[str]) – A list of directory servers used for lookups related to user authorization. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array and are only communicated with over the secure LDAP (LDAPS) protocol. If not specified, servers are resolved for the domain in DNS.
domain (str) – The Active Directory domain to join.
tls (str) – TLS mode for communication with domain controllers. Valid values are required and optional. required forces TLS communication with a domain controller. optional allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to required.
user (str) – The login name of the user with privileges to create the computer account in the domain. This is not persisted on the array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'computer_name': 'computer_name', 'directory_servers': 'directory_servers', 'domain': 'domain', 'join_ou': 'join_ou', 'kerberos_servers': 'kerberos_servers', 'password': 'password', 'tls': 'tls', 'user': 'user'}
- keys()
- required_args = {}
- swagger_types = {'computer_name': 'str', 'directory_servers': 'list[str]', 'domain': 'str', 'join_ou': 'str', 'kerberos_servers': 'list[str]', 'password': 'str', 'tls': 'str', 'user': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.active_directory_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.active_directory_response.ActiveDirectoryResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ActiveDirectory]) – A list of Active Directory computer account configuration objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ActiveDirectory]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin.Admin(name=None, management_access_policies=None, public_key=None, password=None, role=None, api_token=None, lockout_remaining=None, is_local=None, locked=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, management_access_policies=None, public_key=None, password=None, role=None, api_token=None, lockout_remaining=None, is_local=None, locked=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and cannot be changed.
management_access_policies (list[ReferenceWithType]) – List of management access policies associated with the administrator.
public_key (str) – Public key for SSH access. Multiple public keys can be specified, separated by newlines.
password (str) – Password associated with the account.
role (AdminRole) –
api_token (ApiToken) –
lockout_remaining (int) – The remaining lockout period if the user is locked out, in milliseconds. This field is only visible to array_admin roles. For all other users, the value is always null.
is_local (bool) – Returns a value of true if the user is local to the machine.
locked (bool) – Returns a value of true if the user is currently locked out. otherwise false. Change to false to unlock a user. This field is only visible to array_admin roles. For all other users, the value is always null.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'api_token': 'api_token', 'is_local': 'is_local', 'locked': 'locked', 'lockout_remaining': 'lockout_remaining', 'management_access_policies': 'management_access_policies', 'name': 'name', 'password': 'password', 'public_key': 'public_key', 'role': 'role'}
- keys()
- required_args = {}
- swagger_types = {'api_token': 'ApiToken', 'is_local': 'bool', 'locked': 'bool', 'lockout_remaining': 'int', 'management_access_policies': 'list[ReferenceWithType]', 'name': 'str', 'password': 'str', 'public_key': 'str', 'role': 'AdminRole'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_api_token module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_api_token.AdminApiToken(name=None, api_token=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, api_token=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and cannot be changed.
api_token (ApiToken) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'api_token': 'api_token', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'api_token': 'ApiToken', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_api_token_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_api_token_get_response.AdminApiTokenGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[AdminApiToken]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[AdminApiToken]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_api_token_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_api_token_response.AdminApiTokenResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[AdminApiToken]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[AdminApiToken]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_cache module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_cache.AdminCache(name=None, management_access_policies=None, role=None, cached_at=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, management_access_policies=None, role=None, cached_at=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and cannot be changed.
management_access_policies (list[FixedReferenceWithType]) – List of management access policies associated with the administrator.
role (AdminRole) –
cached_at (int) – Time when the entry was added to the cache, in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'cached_at': 'cached_at', 'management_access_policies': 'management_access_policies', 'name': 'name', 'role': 'role'}
- keys()
- required_args = {}
- swagger_types = {'cached_at': 'int', 'management_access_policies': 'list[FixedReferenceWithType]', 'name': 'str', 'role': 'AdminRole'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_cache_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_cache_get_response.AdminCacheGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[AdminCache]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[AdminCache]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_cache_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_cache_response.AdminCacheResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[AdminCache]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[AdminCache]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_get_response.AdminGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Admin]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Admin]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_patch.AdminPatch(name=None, management_access_policies=None, public_key=None, password=None, role=None, api_token=None, lockout_remaining=None, is_local=None, locked=None, old_password=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, management_access_policies=None, public_key=None, password=None, role=None, api_token=None, lockout_remaining=None, is_local=None, locked=None, old_password=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and cannot be changed.
management_access_policies (list[ReferenceWithType]) – List of management access policies associated with the administrator.
public_key (str) – Public key for SSH access. Multiple public keys can be specified, separated by newlines.
password (str) – Password associated with the account.
role (AdminRole) –
api_token (ApiToken) –
lockout_remaining (int) – The remaining lockout period if the user is locked out, in milliseconds. This field is only visible to array_admin roles. For all other users, the value is always null.
is_local (bool) – Returns a value of true if the user is local to the machine.
locked (bool) – Returns a value of true if the user is currently locked out. otherwise false. Change to false to unlock a user. This field is only visible to array_admin roles. For all other users, the value is always null.
old_password (str) – The current password.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'api_token': 'api_token', 'is_local': 'is_local', 'locked': 'locked', 'lockout_remaining': 'lockout_remaining', 'management_access_policies': 'management_access_policies', 'name': 'name', 'old_password': 'old_password', 'password': 'password', 'public_key': 'public_key', 'role': 'role'}
- keys()
- required_args = {}
- swagger_types = {'api_token': 'ApiToken', 'is_local': 'bool', 'locked': 'bool', 'lockout_remaining': 'int', 'management_access_policies': 'list[ReferenceWithType]', 'name': 'str', 'old_password': 'str', 'password': 'str', 'public_key': 'str', 'role': 'AdminRole'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_post.AdminPost(management_access_policies=None, password=None, role=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(management_access_policies=None, password=None, role=None)
- Keyword Arguments
management_access_policies (list[ReferenceWithType]) – List of management access policies to associate with the administrator. Policies can be specified by the name or ID parameter, but they cannot be set together.
password (str) – Password associated with the account.
role (AdminRole) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'management_access_policies': 'management_access_policies', 'password': 'password', 'role': 'role'}
- keys()
- required_args = {}
- swagger_types = {'management_access_policies': 'list[ReferenceWithType]', 'password': 'str', 'role': 'AdminRole'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_response.AdminResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Admin]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_role module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_role.AdminRole(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_settings module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_settings.AdminSettings(required_authentication_methods=None, lockout_duration=None, single_sign_on_enabled=None, min_password_length=None, max_login_attempts=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(required_authentication_methods=None, lockout_duration=None, single_sign_on_enabled=None, min_password_length=None, max_login_attempts=None)
- Keyword Arguments
required_authentication_methods (AdminSettingsRequiredAuthenticationMethods) –
lockout_duration (int) – The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days.
single_sign_on_enabled (bool) – If true, then single sign-on is enabled for the array.
min_password_length (int) – Minimum password length. If not specified, defaults to 1.
max_login_attempts (int) – Maximum number of failed login attempts allowed before the user is locked out.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'lockout_duration': 'lockout_duration', 'max_login_attempts': 'max_login_attempts', 'min_password_length': 'min_password_length', 'required_authentication_methods': 'required_authentication_methods', 'single_sign_on_enabled': 'single_sign_on_enabled'}
- keys()
- required_args = {}
- swagger_types = {'lockout_duration': 'int', 'max_login_attempts': 'int', 'min_password_length': 'int', 'required_authentication_methods': 'AdminSettingsRequiredAuthenticationMethods', 'single_sign_on_enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_settings_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_settings_get_response.AdminSettingsGetResponse(items=None, more_items_remaining=None, total_item_count=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None, more_items_remaining=None, total_item_count=None)
- Keyword Arguments
items (list[AdminSettings]) –
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[AdminSettings]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_settings_required_authentication_methods module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_settings_required_authentication_methods.AdminSettingsRequiredAuthenticationMethods(web_ui=None, ssh=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(web_ui=None, ssh=None)
- Keyword Arguments
web_ui (list[str]) – List of authentication methods that are required for the web UI. Possible values include password, webauthn, and default. Other possible values include saml2 and securid-am but these cannot be changed through PATCH. If not specified, defaults to default. Specify password and webauthn authentication methods to set up local multi-factor authentication for web UI. External multi-factor authentication is configured through SAML2 SSO endpoints.
ssh (list[str]) – List of authentication methods that are required for SSH. Possible values include password, key, and default. securid-am is a possible value, but it cannot be changed through PATCH. If not specified, defaults to default. Specify password and key authentication methods to set up local multi-factor authentication for SSH.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ssh': 'ssh', 'web_ui': 'web_ui'}
- keys()
- required_args = {}
- swagger_types = {'ssh': 'list[str]', 'web_ui': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.admin_settings_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.admin_settings_response.AdminSettingsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[AdminSettings]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[AdminSettings]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.aggregate_replication_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.aggregate_replication_performance.AggregateReplicationPerformance(bytes_per_sec=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(bytes_per_sec=None)
- Keyword Arguments
bytes_per_sec (int) – The total number of bytes of replication data transmitted and received per second.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_sec': 'bytes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert.Alert(name=None, id=None, context=None, severity=None, summary=None, actual=None, code=None, issue=None, knowledge_base_url=None, created=None, notified=None, component_name=None, expected=None, description=None, component_type=None, flagged=None, closed=None, state=None, category=None, updated=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, severity=None, summary=None, actual=None, code=None, issue=None, knowledge_base_url=None, created=None, notified=None, component_name=None, expected=None, description=None, component_type=None, flagged=None, closed=None, state=None, category=None, updated=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
severity (str) – The severity level of the alert. Valid values include info, warning, critical, and hidden.
summary (str) – A summary of the alert.
actual (str) – Actual condition at the time the alert is created.
code (int) – The code number of the alert.
issue (str) – Information about the alert cause.
knowledge_base_url (str) – The URL of the relevant knowledge base page.
created (int) – The time the alert was created in milliseconds since the UNIX epoch.
notified (int) – The time the most recent alert notification was sent in milliseconds since the UNIX epoch.
component_name (str) – The name of the component that generated the alert.
expected (str) – Expected state or threshold under normal conditions.
description (str) – A short description of the alert.
component_type (str) – The type of component that generated the alert.
flagged (bool) – If set to true, the message is flagged. Important messages can can be flagged and listed separately.
closed (int) – The time the alert was closed in milliseconds since the UNIX epoch.
state (str) – The current state of the alert. Valid values include open, closing, and closed.
category (str) – The category of the alert. Valid values include array, hardware and software.
updated (int) – The time the alert was last updated in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actual': 'actual', 'category': 'category', 'closed': 'closed', 'code': 'code', 'component_name': 'component_name', 'component_type': 'component_type', 'context': 'context', 'created': 'created', 'description': 'description', 'expected': 'expected', 'flagged': 'flagged', 'id': 'id', 'issue': 'issue', 'knowledge_base_url': 'knowledge_base_url', 'name': 'name', 'notified': 'notified', 'severity': 'severity', 'state': 'state', 'summary': 'summary', 'updated': 'updated'}
- keys()
- required_args = {}
- swagger_types = {'actual': 'str', 'category': 'str', 'closed': 'int', 'code': 'int', 'component_name': 'str', 'component_type': 'str', 'context': 'FixedReference', 'created': 'int', 'description': 'str', 'expected': 'str', 'flagged': 'bool', 'id': 'str', 'issue': 'str', 'knowledge_base_url': 'str', 'name': 'str', 'notified': 'int', 'severity': 'str', 'state': 'str', 'summary': 'str', 'updated': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_event module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_event.AlertEvent(name=None, context=None, severity=None, summary=None, actual=None, code=None, issue=None, knowledge_base_url=None, created=None, component_name=None, expected=None, component_type=None, alert=None, state=None, time=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, context=None, severity=None, summary=None, actual=None, code=None, issue=None, knowledge_base_url=None, created=None, component_name=None, expected=None, component_type=None, alert=None, state=None, time=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
severity (str) – The severity level of the alert. Valid values include info, warning, critical, and hidden.
summary (str) – A summary of the alert.
actual (str) – Actual condition at the time the alert is created.
code (int) – The parent alert number.
issue (str) – Information about the alert cause.
knowledge_base_url (str) – The knowledge base URL of the alert.
created (int) – The time the parent alert was created.
component_name (str) – The component type of the alert.
expected (str) – Expected state and threshold under normal conditions.
component_type (str) – The component name of the alert.
alert (FixedReference) –
state (str) – The state of the alert. Valid values include open, closing, and closed.
time (int) – The time the event occurred.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actual': 'actual', 'alert': 'alert', 'code': 'code', 'component_name': 'component_name', 'component_type': 'component_type', 'context': 'context', 'created': 'created', 'expected': 'expected', 'issue': 'issue', 'knowledge_base_url': 'knowledge_base_url', 'name': 'name', 'severity': 'severity', 'state': 'state', 'summary': 'summary', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'actual': 'str', 'alert': 'FixedReference', 'code': 'int', 'component_name': 'str', 'component_type': 'str', 'context': 'FixedReference', 'created': 'int', 'expected': 'str', 'issue': 'str', 'knowledge_base_url': 'str', 'name': 'str', 'severity': 'str', 'state': 'str', 'summary': 'str', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_event_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_event_get_response.AlertEventGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[AlertEvent]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[AlertEvent]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_event_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_event_response.AlertEventResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[AlertEvent]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[AlertEvent]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_get_response.AlertGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Alert]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Alert]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_response.AlertResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Alert]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_rules module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_rules.AlertRules(context=None, code=None, parameter=None, value=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, code=None, parameter=None, value=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
code (int) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog.
parameter (str) – The parameter of the custom alert rule to modify. Values include info and warning. Available parameter values can be found in the alert rules catalog.
value (str) – The value to use for the custom alert rule. Valid values for an alert code and parameter combination can be found in the alert rules catalog.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'code': 'code', 'context': 'context', 'parameter': 'parameter', 'value': 'value'}
- keys()
- required_args = {}
- swagger_types = {'code': 'int', 'context': 'FixedReference', 'parameter': 'str', 'value': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_rules_catalog module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_rules_catalog.AlertRulesCatalog(context=None, allowed_values=None, code=None, subject=None, parameter=None, default_value=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, allowed_values=None, code=None, subject=None, parameter=None, default_value=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
allowed_values (str) – The range of values allowed to set the custom alert rule to.
code (int) – The alert code that the rule applies to.
subject (str) – The alert code description.
parameter (str) – The parameter of the custom alert rule.
default_value (str) – The system default values for the alert code and parameter.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed_values': 'allowed_values', 'code': 'code', 'context': 'context', 'default_value': 'default_value', 'parameter': 'parameter', 'subject': 'subject'}
- keys()
- required_args = {}
- swagger_types = {'allowed_values': 'str', 'code': 'int', 'context': 'FixedReference', 'default_value': 'str', 'parameter': 'str', 'subject': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_rules_catalog_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_rules_catalog_get_response.AlertRulesCatalogGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[AlertRulesCatalog]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[AlertRulesCatalog]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_rules_catalog_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_rules_catalog_response.AlertRulesCatalogResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[AlertRulesCatalog]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[AlertRulesCatalog]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_rules_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_rules_get_response.AlertRulesGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[AlertRules]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[AlertRules]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_rules_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_rules_response.AlertRulesResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[AlertRules]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[AlertRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_watcher module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_watcher.AlertWatcher(name=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, enabled=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
enabled (bool) – If set to true, email notifications will be sent to this watcher for alerts. If set to false, email notification is disabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_watcher_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_watcher_get_response.AlertWatcherGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[AlertWatcher]) – A list of alert watcher objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[AlertWatcher]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_watcher_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_watcher_patch.AlertWatcherPatch(enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None)
- Keyword Arguments
enabled (bool) – If set to true, email notifications will be sent to this watcher for alerts. If set to false, email notifications are disabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_watcher_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_watcher_post.AlertWatcherPost(enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None)
- Keyword Arguments
enabled (bool) – If set to true, email notifications will be sent to this watcher for alerts. If set to false, email notifications are disabled. If not specified, defaults to true.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.alert_watcher_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.alert_watcher_response.AlertWatcherResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[AlertWatcher]) – A list of alert watcher objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[AlertWatcher]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.api_client module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.api_client.ApiClient(public_key=None, max_role=None, key_id=None, name=None, access_policies=None, id=None, enabled=None, issuer=None, access_token_ttl_in_ms=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(public_key=None, max_role=None, key_id=None, name=None, access_policies=None, id=None, enabled=None, issuer=None, access_token_ttl_in_ms=None)
- Keyword Arguments
public_key (str) – The API client’s PEM formatted (Base64 encoded) RSA public key.
max_role (str) – This field has been deprecated. The maximum Admin Access Policy (previously ‘role’) allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this policy and that of the array user specified as the JWT sub (subject) claim. max_role is deprecated in favor of access_policies, but remains for backwards compatibility. If a client has exactly one access policy which corresponds to a valid legacy role of the same name, max_role will be the name of that policy. Otherwise, it will be null.
key_id (str) – The unique identifier for the associated public key of this API client. This string must match the JWT kid (key ID) claim in ID Tokens issued for this API client.
name (str) – The API client name.
access_policies (list[FixedReferenceWithType]) – The access policies allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of these policies and those of the array user specified as the JWT sub (subject) claim.
id (str) – The unique identifier for the associated API client. The ID represents the JWT aud (audience) claim in ID Tokens issued for this API client.
enabled (bool) – If true, the API client is permitted to exchange ID Tokens for access tokens. API clients are disabled by default.
issuer (str) – The name of the identity provider that will be issuing ID Tokens for this API client. This string represents the JWT iss (issuer) claim in ID Tokens issued for this API client.
access_token_ttl_in_ms (int) – The requested TTL (Time To Live) length of time for the exchanged access token, measured in milliseconds.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_policies': 'access_policies', 'access_token_ttl_in_ms': 'access_token_ttl_in_ms', 'enabled': 'enabled', 'id': 'id', 'issuer': 'issuer', 'key_id': 'key_id', 'max_role': 'max_role', 'name': 'name', 'public_key': 'public_key'}
- keys()
- required_args = {}
- swagger_types = {'access_policies': 'list[FixedReferenceWithType]', 'access_token_ttl_in_ms': 'int', 'enabled': 'bool', 'id': 'str', 'issuer': 'str', 'key_id': 'str', 'max_role': 'str', 'name': 'str', 'public_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.api_client_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.api_client_get_response.ApiClientGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ApiClient]) – Returns a list of all items after filtering. The values are displayed for each name, where meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ApiClient]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.api_client_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.api_client_patch.ApiClientPatch(enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None)
- Keyword Arguments
enabled (bool) – Returns a value of true if the API client is permitted to exchange ID tokens for access tokens. API clients are disabled by default.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.api_client_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.api_client_post.ApiClientPost(public_key=None, max_role=None, access_policies=None, issuer=None, access_token_ttl_in_ms=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(public_key=None, max_role=None, access_policies=None, issuer=None, access_token_ttl_in_ms=None)
- Keyword Arguments
public_key (str) – The API client’s PEM formatted (Base64 encoded) RSA public key. Include the —–BEGIN PUBLIC KEY—– and —–END PUBLIC KEY—– lines.
max_role (str) – Deprecated. The maximum Admin Access Policy (previously ‘role’) allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this policy and that of the array user specified as the JWT sub (subject) claim. max_role is deprecated in favor of access_policies, but remains for backwards compatibility. If max_role is the name of a valid legacy role, it will be interpreted as the corresponding access policy of the same name. Otherwise, it’s invalid.
access_policies (list[ReferenceWithType]) – The access policies allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of these policies and those of the array user specified as the JWT sub (subject) claim.
issuer (str) – The name of the identity provider that will be issuing ID Tokens for this API client. The iss claim in the JWT issued must match this string. If not specified, defaults to the API client name.
access_token_ttl_in_ms (int) – The TTL (Time To Live) length of time for the exchanged access token. Measured in milliseconds. If not specified, defaults to 86400000.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_policies': 'access_policies', 'access_token_ttl_in_ms': 'access_token_ttl_in_ms', 'issuer': 'issuer', 'max_role': 'max_role', 'public_key': 'public_key'}
- keys()
- required_args = {}
- swagger_types = {'access_policies': 'list[ReferenceWithType]', 'access_token_ttl_in_ms': 'int', 'issuer': 'str', 'max_role': 'str', 'public_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.api_client_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.api_client_response.ApiClientResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ApiClient]) – Returns a list of all items after filtering. The values are displayed for each name, where meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ApiClient]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.api_token module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.api_token.ApiToken(expires_at=None, created_at=None, token=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(expires_at=None, created_at=None, token=None)
- Keyword Arguments
expires_at (int) – Expiration time in milliseconds since the UNIX epoch.
created_at (int) – Creation time in milliseconds since the UNIX epoch.
token (str) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created_at': 'created_at', 'expires_at': 'expires_at', 'token': 'token'}
- keys()
- required_args = {}
- swagger_types = {'created_at': 'int', 'expires_at': 'int', 'token': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.api_version_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.api_version_response.ApiVersionResponse(version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(version=None)
- Keyword Arguments
version (list[str]) – A list of supported API versions.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'version': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.app module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.app.App(name=None, vnc_enabled=None, description=None, details=None, version=None, enabled=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, vnc_enabled=None, description=None, details=None, version=None, enabled=None, status=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
vnc_enabled (bool) – If set to true, VNC access is enabled. By default, VNC access is disabled.
description (str) – A description of the app.
details (str) – Details of the status of the app.
version (str) – The app version. For cluster apps, this represents the node version if all nodes are of the same version. If the node versions differ, a value of null is returned.
enabled (bool) – If set to true, the app is enabled. By default, apps are disabled.
status (str) – The status of the app. Values include healthy and unhealthy. For cluster apps, this represents the aggregate status of the app. The aggregate status is only healthy if all nodes are healthy`; otherwise, it is `unhealthy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'description': 'description', 'details': 'details', 'enabled': 'enabled', 'name': 'name', 'status': 'status', 'version': 'version', 'vnc_enabled': 'vnc_enabled'}
- keys()
- required_args = {}
- swagger_types = {'description': 'str', 'details': 'str', 'enabled': 'bool', 'name': 'str', 'status': 'str', 'version': 'str', 'vnc_enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.app_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.app_get_response.AppGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[App]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[App]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.app_node module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.app_node.AppNode(app=None, index=None, vnc=None, version=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(app=None, index=None, vnc=None, version=None, status=None)
- Keyword Arguments
app (FixedReference) – A reference to the app of which this node is a part.
index (int) – An index that represents this node.
vnc (list[str]) – The VNC information used to access this node if VNC is enabled.
version (str) – The node version.
status (str) – The node status. Possible values are starting, healthy, unhealthy, critical, stopping, and disabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'app': 'app', 'index': 'index', 'status': 'status', 'version': 'version', 'vnc': 'vnc'}
- keys()
- required_args = {}
- swagger_types = {'app': 'FixedReference', 'index': 'int', 'status': 'str', 'version': 'str', 'vnc': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.app_node_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.app_node_get_response.AppNodeGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[AppNode]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[AppNode]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.app_node_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.app_node_response.AppNodeResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[AppNode]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.app_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.app_response.AppResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[App]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection.ArrayConnection(name=None, id=None, context=None, replication_addresses=None, throttle=None, encryption=None, os=None, management_address=None, replication_transport=None, encryption_mode=None, remote=None, type=None, version=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, replication_addresses=None, throttle=None, encryption=None, os=None, management_address=None, replication_transport=None, encryption_mode=None, remote=None, type=None, version=None, status=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
replication_addresses (list[str]) – IP addresses of the target arrays when replication_transport is ip. WWNs of the target arrays when replication_transport is fc.
throttle (Throttle) –
encryption (str) – If encrypted, all traffic over this array connection will be encrypted. If unencrypted, all traffic over this array connection will be unencrypted.
os (str) – The operating system of the connected array.
management_address (str) – Management IP address or FQDN of the target array.
replication_transport (str) – The protocol used to transport data between the local array and the remote array. Valid values are ip and fc. The default value is ip.
encryption_mode (str) – Cryptographic protocol, trust model, and encryption algorithm information. Will be null if encrypted is false.
remote (ReferenceWithType) – The remote array.
type (str) – The type of connection. Valid values include async-replication, sync-replication, and fleet-management.
version (str) – The Purity version on the target array.
status (str) – Status of the connection. Valid values include connected, connecting, partially_connected, and unbalanced. A status of connected indicates that arrays are communicating. A status of connecting indicates that the array is trying to establish a connection. A status of partially_connected indicates that some replication addresses are communicating but others are not. A status of unbalanced indicates that the arrays are communicating, but the set of paths is either not redundant or not symmetrical.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'encryption': 'encryption', 'encryption_mode': 'encryption_mode', 'id': 'id', 'management_address': 'management_address', 'name': 'name', 'os': 'os', 'remote': 'remote', 'replication_addresses': 'replication_addresses', 'replication_transport': 'replication_transport', 'status': 'status', 'throttle': 'throttle', 'type': 'type', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'encryption': 'str', 'encryption_mode': 'str', 'id': 'str', 'management_address': 'str', 'name': 'str', 'os': 'str', 'remote': 'ReferenceWithType', 'replication_addresses': 'list[str]', 'replication_transport': 'str', 'status': 'str', 'throttle': 'Throttle', 'type': 'str', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection_get_response.ArrayConnectionGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ArrayConnection]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ArrayConnection]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection_key module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection_key.ArrayConnectionKey(connection_key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(connection_key=None)
- Keyword Arguments
connection_key (str) – Connection-key used on another array to connect to this array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'connection_key': 'connection_key'}
- keys()
- required_args = {}
- swagger_types = {'connection_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection_key_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection_key_get_response.ArrayConnectionKeyGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ArrayConnectionKey]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ArrayConnectionKey]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection_patch.ArrayConnectionPatch(window=None, default_limit=None, window_limit=None, replication_addresses=None, throttle=None, connection_key=None, encryption=None, management_address=None, type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(window=None, default_limit=None, window_limit=None, replication_addresses=None, throttle=None, connection_key=None, encryption=None, management_address=None, type=None)
- Keyword Arguments
window (TimeWindow) – Deprecated. The time during which the window_limit threshold is in effect.
default_limit (int) – Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs.
window_limit (int) – Deprecated. Maximum bandwidth threshold for outbound traffic during the specified window_limit time range in bytes. Once exceeded, bandwidth throttling occurs.
replication_addresses (list[str]) – IP addresses and FQDNs of the target arrays. Configurable only when replication_transport is set to ip.
throttle (Throttle) –
connection_key (str) – The connection key of the target array. It is only required when encryption is changed from unencrypted to encrypted, or when type is changed from async-replication to sync-replication.
encryption (str) – If encrypted, encryption will be enabled for all traffic over this array connection. connection_key must be specified when encrypted is set to true. If unencrypted, encryption will be disabled for all traffic over this array connection. If not specified, the current encryption option for the array connection will remain unchanged.
management_address (str) – Management IP address of the target array.
type (str) – The type of replication. Valid values are async-replication and sync-replication.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'connection_key': 'connection_key', 'default_limit': 'default_limit', 'encryption': 'encryption', 'management_address': 'management_address', 'replication_addresses': 'replication_addresses', 'throttle': 'throttle', 'type': 'type', 'window': 'window', 'window_limit': 'window_limit'}
- keys()
- required_args = {}
- swagger_types = {'connection_key': 'str', 'default_limit': 'int', 'encryption': 'str', 'management_address': 'str', 'replication_addresses': 'list[str]', 'throttle': 'Throttle', 'type': 'str', 'window': 'TimeWindow', 'window_limit': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection_path module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection_path.ArrayConnectionPath(name=None, encryption=None, local_port=None, replication_transport=None, local_address=None, remote_port=None, id=None, remote_address=None, encryption_mode=None, remote=None, type=None, status_details=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, encryption=None, local_port=None, replication_transport=None, local_address=None, remote_port=None, id=None, remote_address=None, encryption_mode=None, remote=None, type=None, status_details=None, status=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
encryption (str) – If encrypted, all traffic over this array connection will be encrypted. If unencrypted, all traffic over this array connection will be unencrypted.
local_port (str) – The local port of the path.
replication_transport (str) – The protocol used to transport data between the local array and the remote array. Valid values are ip and fc.
local_address (str) – IP address or WWN of the local port.
remote_port (str) – The remote port of the path.
id (str) – A globally unique, system-generated ID of an array connection.
remote_address (str) – IP address or WWN of the remote port.
encryption_mode (str) – Cryptographic protocol, trust model, and encryption algorithm information. Will be null if encrypted is false.
remote (ReferenceWithType) – The remote array.
type (str) – The type of path. Valid values include async-replication, sync-replication, and fleet-management.
status_details (str) – Additional information describing any issues encountered when connecting, or null if the status is connected.
status (str) – Status of the connection. Valid values are connected, connecting, and quarantined. A status of connected indicates that the arrays are communicating. A status of connecting indicates that the array is trying to establish a connection. A status of quarantined indicates that the path is unstable and has been temporarily embargoed for synchronous replication connections.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'encryption': 'encryption', 'encryption_mode': 'encryption_mode', 'id': 'id', 'local_address': 'local_address', 'local_port': 'local_port', 'name': 'name', 'remote': 'remote', 'remote_address': 'remote_address', 'remote_port': 'remote_port', 'replication_transport': 'replication_transport', 'status': 'status', 'status_details': 'status_details', 'type': 'type'}
- keys()
- required_args = {}
- swagger_types = {'encryption': 'str', 'encryption_mode': 'str', 'id': 'str', 'local_address': 'str', 'local_port': 'str', 'name': 'str', 'remote': 'ReferenceWithType', 'remote_address': 'str', 'remote_port': 'str', 'replication_transport': 'str', 'status': 'str', 'status_details': 'str', 'type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection_path_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection_path_get_response.ArrayConnectionPathGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ArrayConnectionPath]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ArrayConnectionPath]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection_path_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection_path_response.ArrayConnectionPathResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ArrayConnectionPath]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ArrayConnectionPath]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection_post.ArrayConnectionPost(replication_addresses=None, connection_key=None, encryption=None, management_address=None, replication_transport=None, type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(replication_addresses=None, connection_key=None, encryption=None, management_address=None, replication_transport=None, type=None)
- Keyword Arguments
replication_addresses (list[str]) – IP addresses and FQDNs of the target arrays. Configurable only when replication_transport is set to ip. If not configured, will be set to all the replication addresses available on the target array at the time of the POST.
connection_key (str) – The connection key of the target array.
encryption (str) – If encrypted, all traffic over this array connection will be encrypted. If unencrypted, all traffic over this array connection will be unencrypted. Defaults to unencrypted.
management_address (str) – Management IP address of the target array.
replication_transport (str) – The protocol used to transport data between the local array and the remote array. Valid values are ip and fc. The default is ip.
type (str) – The type of replication. Valid values are async-replication and sync-replication.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'connection_key': 'connection_key', 'encryption': 'encryption', 'management_address': 'management_address', 'replication_addresses': 'replication_addresses', 'replication_transport': 'replication_transport', 'type': 'type'}
- keys()
- required_args = {}
- swagger_types = {'connection_key': 'str', 'encryption': 'str', 'management_address': 'str', 'replication_addresses': 'list[str]', 'replication_transport': 'str', 'type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_connection_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_connection_response.ArrayConnectionResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ArrayConnection]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ArrayConnection]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_encryption module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_encryption.ArrayEncryption(data_at_rest=None, module_version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(data_at_rest=None, module_version=None)
- Keyword Arguments
data_at_rest (ArrayencryptionDataAtRest) –
module_version (str) – The version of the Purity encryption module installed on the array. Security certifications are carried out on a per-version basis. On non-encrypt builds, an encryption module may be installed without being enabled. Values include FA-1.0, FA-1.1, FA-1.2, FA-1.3, and so on.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'data_at_rest': 'data_at_rest', 'module_version': 'module_version'}
- keys()
- required_args = {}
- swagger_types = {'data_at_rest': 'ArrayencryptionDataAtRest', 'module_version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_erasure module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_erasure.ArrayErasure(name=None, id=None, sanitization_certificate=None, details=None, image_download_progress=None, image_version=None, image_source=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, sanitization_certificate=None, details=None, image_download_progress=None, image_version=None, image_source=None, status=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
sanitization_certificate (str) – The sanitization certificate of the factory reset, which complies with the standard described in NIST SP800-88R1 section 4.8.
details (str) – The detailed reason of the status.
image_download_progress (float) – The progress of the ISO image download, displayed in decimal format.
image_version (str) – Version of the image to download and install.
image_source (str) – Source of the ISO image to download. Valid values include auto and URLs. auto means download the image from Pure1 cloud, and a URL means download the image from the specified URL.
status (str) – The status of the factory reset process. Valid values include resetting, reset_failed, reimage_failed, waiting_for_finalize, downloading, downloaded, and download_failed. A status of resetting indicates that the factory reset is running. A status of reset_failed indicates that the factory reset encountered a failure. A status of reimage_failed indicates that the factory reset failed to reimage the array. A status of waiting_for_finalize indicates that the factory reset has finished sanitizing drives, and is waiting to be finalized. A status of downloading indicates that the factory reset is downloading ISO image. A status of downloaded indicates that the factory reset completed ISO image download. A status of download_failed indicates that the factory reset failed to download ISO image.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'id': 'id', 'image_download_progress': 'image_download_progress', 'image_source': 'image_source', 'image_version': 'image_version', 'name': 'name', 'sanitization_certificate': 'sanitization_certificate', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'details': 'str', 'id': 'str', 'image_download_progress': 'float', 'image_source': 'str', 'image_version': 'str', 'name': 'str', 'sanitization_certificate': 'str', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_erasure_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_erasure_get_response.ArrayErasureGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ArrayErasure]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ArrayErasure]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_erasure_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_erasure_patch.ArrayErasurePatch(image_version=None, image_source=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(image_version=None, image_source=None)
- Keyword Arguments
image_version (str) – Version of the image to download. image_version is optional, and the default value is the current running Purity version. If image_source is auto, the image with the specified version will be downloaded from Pure1 cloud. If image_source is a URL, image_version will be used to compare to the downloaded image version for the purpose of validation.
image_source (str) – Source of the ISO image to download. Valid values include auto and URLs. auto means download the image from Pure1 cloud, and a URL means download the image from the specified URL. Default value is auto.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'image_source': 'image_source', 'image_version': 'image_version'}
- keys()
- required_args = {}
- swagger_types = {'image_source': 'str', 'image_version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_erasure_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_erasure_response.ArrayErasureResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ArrayErasure]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ArrayErasure]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_factory_reset_token module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_factory_reset_token.ArrayFactoryResetToken(name=None, id=None, token=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, token=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
token (int) – A random number required as input to perform a factory reset of the array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'token': 'token'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'token': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_factory_reset_token_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_factory_reset_token_get_response.ArrayFactoryResetTokenGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ArrayFactoryResetToken]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ArrayFactoryResetToken]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_factory_reset_token_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_factory_reset_token_response.ArrayFactoryResetTokenResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ArrayFactoryResetToken]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ArrayFactoryResetToken]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_get_response.ArrayGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Arrays]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Arrays]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_performance.ArrayPerformance(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, others_per_sec=None, local_queue_usec_per_op=None, usec_per_other_op=None, queue_depth=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, others_per_sec=None, local_queue_usec_per_op=None, usec_per_other_op=None, queue_depth=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
others_per_sec (int) – The number of other requests processed per second.
local_queue_usec_per_op (int) – Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display null. Instead, use queue_usec_per_mirrored_write_op, queue_usec_per_read_op, and queue_usec_per_write_op fields to measure IO queuing.
usec_per_other_op (int) – The average time it takes the array to process an I/O other request, measured in microseconds.
queue_depth (int) – Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display null. Instead, use queue_usec_per_mirrored_write_op, queue_usec_per_read_op, and queue_usec_per_write_op fields to measure IO queuing.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'id': 'id', 'local_queue_usec_per_op': 'local_queue_usec_per_op', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'others_per_sec': 'others_per_sec', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_depth': 'queue_depth', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_other_op': 'usec_per_other_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'id': 'str', 'local_queue_usec_per_op': 'int', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'others_per_sec': 'int', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_depth': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_other_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_performance_by_link module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_performance_by_link.ArrayPerformanceByLink(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, others_per_sec=None, local_queue_usec_per_op=None, usec_per_other_op=None, queue_depth=None, link=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, others_per_sec=None, local_queue_usec_per_op=None, usec_per_other_op=None, queue_depth=None, link=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
others_per_sec (int) – The number of other requests processed per second.
local_queue_usec_per_op (int) – Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display null. Instead, use queue_usec_per_mirrored_write_op, queue_usec_per_read_op, and queue_usec_per_write_op fields to measure IO queuing.
usec_per_other_op (int) – The average time it takes the array to process an I/O other request, measured in microseconds.
queue_depth (int) – Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display null. Instead, use queue_usec_per_mirrored_write_op, queue_usec_per_read_op, and queue_usec_per_write_op fields to measure IO queuing.
link (list[Resource]) – List of IDs and array names for the link
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'id': 'id', 'link': 'link', 'local_queue_usec_per_op': 'local_queue_usec_per_op', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'others_per_sec': 'others_per_sec', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_depth': 'queue_depth', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_other_op': 'usec_per_other_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'id': 'str', 'link': 'list[Resource]', 'local_queue_usec_per_op': 'int', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'others_per_sec': 'int', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_depth': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_other_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_performance_by_link_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_performance_by_link_get_response.ArrayPerformanceByLinkGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ArrayPerformanceByLink]) – Array-level front-end I/O performance metrics grouped by link. A link represents a set of arrays that an I/O operation depends on.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ArrayPerformanceByLink]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_performance_by_link_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_performance_by_link_response.ArrayPerformanceByLinkResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ArrayPerformanceByLink]) – Array-level front-end I/O performance metrics grouped by link. A link represents a set of arrays that an I/O operation depends on.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ArrayPerformanceByLink]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_performance_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_performance_get_response.ArrayPerformanceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ArrayPerformance]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ArrayPerformance]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_response.ArrayResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Arrays]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_space module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_space.ArraySpace(name=None, id=None, context=None, parity=None, time=None, space=None, capacity=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, parity=None, time=None, space=None, capacity=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
parity (float) – A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0.
time (int) –
space (Space) –
capacity (int) – The usable capacity in bytes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'capacity': 'capacity', 'context': 'context', 'id': 'id', 'name': 'name', 'parity': 'parity', 'space': 'space', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'capacity': 'int', 'context': 'FixedReference', 'id': 'str', 'name': 'str', 'parity': 'float', 'space': 'Space', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.array_space_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.array_space_get_response.ArraySpaceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ArraySpace]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ArraySpace]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.arrayencryption_data_at_rest module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.arrayencryption_data_at_rest.ArrayencryptionDataAtRest(enabled=None, algorithm=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None, algorithm=None)
- Keyword Arguments
enabled (bool) – Returns a value of true if data at rest encryption is enabled on the array.
algorithm (str) – The algorithm used to encrypt data on the array. Values include AES-256-CTR and null.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'algorithm': 'algorithm', 'enabled': 'enabled'}
- keys()
- required_args = {}
- swagger_types = {'algorithm': 'str', 'enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.arrays module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.arrays.Arrays(name=None, id=None, context=None, os=None, scsi_timeout=None, parity=None, banner=None, console_lock_enabled=None, eradication_config=None, ntp_servers=None, as_of=None, time_zone=None, version=None, space=None, capacity=None, encryption=None, ntp_symmetric_key=None, idle_timeout=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, os=None, scsi_timeout=None, parity=None, banner=None, console_lock_enabled=None, eradication_config=None, ntp_servers=None, as_of=None, time_zone=None, version=None, space=None, capacity=None, encryption=None, ntp_symmetric_key=None, idle_timeout=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
os (str) – Specifies the operating system. Valid values are Purity, Purity//FA, and Purity//FB.
scsi_timeout (int) – The SCSI timeout. If not specified, defaults to 60s. If the user does not have sufficient access, this field will return null.
parity (float) – A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0. If the user does not have sufficient access, this field will return null.
banner (str) –
console_lock_enabled (bool) – If true, console lock is enabled for the array. If the user does not have sufficient access, this field will return null.
eradication_config (EradicationConfig) –
ntp_servers (list[str]) – NTP Servers. If the user does not have sufficient access, this field will return null.
as_of (int) – The time in milliseconds since UNIX epoch.
time_zone (str) – The time zone of the array.
version (str) –
space (Space) –
capacity (int) – The usable capacity in bytes. If the user does not have sufficient access, this field will return null.
encryption (ArrayEncryption) –
ntp_symmetric_key (str) – The text of ntp symmetric authentication key. Supported formats include a hex-encoded string no longer than 64 characters, or an ASCII string no longer than 20 characters, excluding “#”. Any configured key will be masked as “****” on return. If the user does not have sufficient access, this field will return null.
idle_timeout (int) – The idle timeout in milliseconds. Valid values include 0 and any multiple of 60000 in the range of 300000 and 10800000. Any other values are rounded down to the nearest multiple of 60000.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'as_of': '_as_of', 'banner': 'banner', 'capacity': 'capacity', 'console_lock_enabled': 'console_lock_enabled', 'context': 'context', 'encryption': 'encryption', 'eradication_config': 'eradication_config', 'id': 'id', 'idle_timeout': 'idle_timeout', 'name': 'name', 'ntp_servers': 'ntp_servers', 'ntp_symmetric_key': 'ntp_symmetric_key', 'os': 'os', 'parity': 'parity', 'scsi_timeout': 'scsi_timeout', 'space': 'space', 'time_zone': 'time_zone', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'as_of': 'int', 'banner': 'str', 'capacity': 'int', 'console_lock_enabled': 'bool', 'context': 'FixedReference', 'encryption': 'ArrayEncryption', 'eradication_config': 'EradicationConfig', 'id': 'str', 'idle_timeout': 'int', 'name': 'str', 'ntp_servers': 'list[str]', 'ntp_symmetric_key': 'str', 'os': 'str', 'parity': 'float', 'scsi_timeout': 'int', 'space': 'Space', 'time_zone': 'str', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.audit module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.audit.Audit(name=None, id=None, context=None, subcommand=None, origin=None, user_interface=None, arguments=None, time=None, user=None, command=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, subcommand=None, origin=None, user_interface=None, arguments=None, time=None, user=None, command=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
subcommand (str) – The command and subcommand combination determines which action the user attempted to perform.
origin (FixedReference) – The array from which the command originated.
user_interface (str) – The user interface through which the user session event was performed. Valid values are CLI, GUI, and REST.
arguments (str) – The arguments provided to the command.
time (int) – The time at which the command was run in milliseconds since the UNIX epoch.
user (str) – The user who ran the command.
command (str) – The top level command that starts with the string “pure” as a convention.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'arguments': 'arguments', 'command': 'command', 'context': 'context', 'id': 'id', 'name': 'name', 'origin': 'origin', 'subcommand': 'subcommand', 'time': 'time', 'user': 'user', 'user_interface': 'user_interface'}
- keys()
- required_args = {}
- swagger_types = {'arguments': 'str', 'command': 'str', 'context': 'FixedReference', 'id': 'str', 'name': 'str', 'origin': 'FixedReference', 'subcommand': 'str', 'time': 'int', 'user': 'str', 'user_interface': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.audit_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.audit_get_response.AuditGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Audit]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Audit]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.audit_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.audit_response.AuditResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Audit]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.base_port module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.base_port.BasePort(name=None, iqn=None, nqn=None, portal=None, wwn=None, failover=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, iqn=None, nqn=None, portal=None, wwn=None, failover=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
iqn (str) – The iSCSI Qualified Name (or null if target is not iSCSI).
nqn (str) – NVMe Qualified Name (or null if target is not NVMeoF).
portal (str) – IP and port number (or null if target is not iSCSI).
wwn (str) – Fibre Channel World Wide Name (or null if target is not Fibre Channel).
failover (str) – If the array port has failed over, returns the name of the port to which this port has failed over.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'failover': 'failover', 'iqn': 'iqn', 'name': 'name', 'nqn': 'nqn', 'portal': 'portal', 'wwn': 'wwn'}
- keys()
- required_args = {}
- swagger_types = {'failover': 'str', 'iqn': 'str', 'name': 'str', 'nqn': 'str', 'portal': 'str', 'wwn': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.built_in module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.built_in.BuiltIn(name=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.built_in_relationship module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.built_in_relationship.BuiltInRelationship(id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(id=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.built_in_resource_no_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.built_in_resource_no_id.BuiltInResourceNoId(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate.Certificate(name=None, country=None, issued_by=None, issued_to=None, certificate=None, locality=None, valid_from=None, intermediate_certificate=None, organization=None, valid_to=None, state=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, country=None, issued_by=None, issued_to=None, certificate=None, locality=None, valid_from=None, intermediate_certificate=None, organization=None, valid_to=None, state=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
country (str) – Two-letter country (ISO) code listed in the certificate.
issued_by (str) – The party that issued the certificate.
issued_to (str) – The party to whom the certificate is issued.
certificate (str) – The text of the certificate.
locality (str) – The locality field listed in the certificate.
valid_from (int) – The date when the certificate starts being valid.
intermediate_certificate (str) – The text of the intermediate certificate chains.
organization (str) – The organization field listed in the certificate.
valid_to (int) – The date of when the certificate stops being valid.
state (str) – The state/province field listed in the certificate.
common_name (str) – The common name field listed in the certificate.
email (str) – The email field listed in the certificate.
organizational_unit (str) – The organizational unit field listed in the certificate.
key_size (int) – The size of the private key for the certificate in bits. Default is 2048 bits.
status (str) – The type of certificate. Valid values are self-signed and imported.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificate': 'certificate', 'common_name': 'common_name', 'country': 'country', 'email': 'email', 'intermediate_certificate': 'intermediate_certificate', 'issued_by': 'issued_by', 'issued_to': 'issued_to', 'key_size': 'key_size', 'locality': 'locality', 'name': 'name', 'organization': 'organization', 'organizational_unit': 'organizational_unit', 'state': 'state', 'status': 'status', 'valid_from': 'valid_from', 'valid_to': 'valid_to'}
- keys()
- required_args = {}
- swagger_types = {'certificate': 'str', 'common_name': 'str', 'country': 'str', 'email': 'str', 'intermediate_certificate': 'str', 'issued_by': 'str', 'issued_to': 'str', 'key_size': 'int', 'locality': 'str', 'name': 'str', 'organization': 'str', 'organizational_unit': 'str', 'state': 'str', 'status': 'str', 'valid_from': 'int', 'valid_to': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_certificate_group_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_certificate_group_get_response.CertificateCertificateGroupGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[MemberWithType]) – A list of certificate and certificate group relationships.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[MemberWithType]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_certificate_group_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_certificate_group_response.CertificateCertificateGroupResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[MemberWithType]) – A list of certificate and certificate group relationships.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[MemberWithType]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_get_response.CertificateGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Certificate]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Certificate]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_group module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_group.CertificateGroup(name=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_group_certificate_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_group_certificate_get_response.CertificateGroupCertificateGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[MemberWithType]) – A list of certificate and certificate group relationships.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[MemberWithType]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_group_certificate_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_group_certificate_response.CertificateGroupCertificateResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[MemberWithType]) – A list of certificate and certificate group relationships.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[MemberWithType]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_group_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_group_get_response.CertificateGroupGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[CertificateGroup]) – A list of certificate group objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[CertificateGroup]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_group_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_group_response.CertificateGroupResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[CertificateGroup]) – A list of certificate group objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[CertificateGroup]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_post.CertificatePost(name=None, country=None, issued_by=None, issued_to=None, certificate=None, locality=None, valid_from=None, intermediate_certificate=None, organization=None, valid_to=None, state=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None, days=None, passphrase=None, key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, country=None, issued_by=None, issued_to=None, certificate=None, locality=None, valid_from=None, intermediate_certificate=None, organization=None, valid_to=None, state=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None, days=None, passphrase=None, key=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
country (str) – Two-letter country (ISO) code listed in the certificate.
issued_by (str) – The party that issued the certificate.
issued_to (str) – The party to whom the certificate is issued.
certificate (str) – The text of the certificate.
locality (str) – The locality field listed in the certificate.
valid_from (int) – The date when the certificate starts being valid.
intermediate_certificate (str) – The text of the intermediate certificate chains.
organization (str) – The organization field listed in the certificate.
valid_to (int) – The date of when the certificate stops being valid.
state (str) – The state/province field listed in the certificate.
common_name (str) – The common name field listed in the certificate.
email (str) – The email field listed in the certificate.
organizational_unit (str) – The organizational unit field listed in the certificate.
key_size (int) – The size of the private key for the certificate in bits. Default is 2048 bits.
status (str) – The type of certificate. Valid values are self-signed and imported.
days (int) – The number of days that the self-signed certificate is valid. If not specified, defaults to 3650.
passphrase (str) – The passphrase used to encrypt private_key.
key (str) – The text of private key.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificate': 'certificate', 'common_name': 'common_name', 'country': 'country', 'days': 'days', 'email': 'email', 'intermediate_certificate': 'intermediate_certificate', 'issued_by': 'issued_by', 'issued_to': 'issued_to', 'key': 'key', 'key_size': 'key_size', 'locality': 'locality', 'name': 'name', 'organization': 'organization', 'organizational_unit': 'organizational_unit', 'passphrase': 'passphrase', 'state': 'state', 'status': 'status', 'valid_from': 'valid_from', 'valid_to': 'valid_to'}
- keys()
- required_args = {}
- swagger_types = {'certificate': 'str', 'common_name': 'str', 'country': 'str', 'days': 'int', 'email': 'str', 'intermediate_certificate': 'str', 'issued_by': 'str', 'issued_to': 'str', 'key': 'str', 'key_size': 'int', 'locality': 'str', 'name': 'str', 'organization': 'str', 'organizational_unit': 'str', 'passphrase': 'str', 'state': 'str', 'status': 'str', 'valid_from': 'int', 'valid_to': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_response.CertificateResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Certificate]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Certificate]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_signing_request module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_signing_request.CertificateSigningRequest(certificate_signing_request=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(certificate_signing_request=None)
- Keyword Arguments
certificate_signing_request (str) – The text of a new certificate signing request.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificate_signing_request': 'certificate_signing_request'}
- keys()
- required_args = {}
- swagger_types = {'certificate_signing_request': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_signing_request_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_signing_request_post.CertificateSigningRequestPost(country=None, organization=None, certificate=None, locality=None, state=None, common_name=None, email=None, organizational_unit=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(country=None, organization=None, certificate=None, locality=None, state=None, common_name=None, email=None, organizational_unit=None)
- Keyword Arguments
country (str) – Two-letter country (ISO) code listed in the certificate.
organization (str) – The organization field listed in the certificate.
certificate (ReferenceNoId) –
locality (str) – The locality field listed in the certificate.
state (str) – The state/province field listed in the certificate.
common_name (str) – The common name field listed in the certificate.
email (str) – The email field listed in the certificate.
organizational_unit (str) – The organizational unit field listed in the certificate.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificate': 'certificate', 'common_name': 'common_name', 'country': 'country', 'email': 'email', 'locality': 'locality', 'organization': 'organization', 'organizational_unit': 'organizational_unit', 'state': 'state'}
- keys()
- required_args = {}
- swagger_types = {'certificate': 'ReferenceNoId', 'common_name': 'str', 'country': 'str', 'email': 'str', 'locality': 'str', 'organization': 'str', 'organizational_unit': 'str', 'state': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.certificate_signing_request_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.certificate_signing_request_response.CertificateSigningRequestResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[CertificateSigningRequest]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[CertificateSigningRequest]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.chap module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.chap.Chap(host_password=None, target_password=None, target_user=None, host_user=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(host_password=None, target_password=None, target_user=None, host_user=None)
- Keyword Arguments
host_password (str) – The host password for CHAP authentication. The password must be between 12 and 255 characters (inclusive) and cannot be the same as the target password.
target_password (str) – The target password for CHAP authentication. The password must be between 12 and 255 characters (inclusive) and cannot be the same as the host password.
target_user (str) – The target username for CHAP authentication.
host_user (str) – The host username for CHAP authentication.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'host_password': 'host_password', 'host_user': 'host_user', 'target_password': 'target_password', 'target_user': 'target_user'}
- keys()
- required_args = {}
- swagger_types = {'host_password': 'str', 'host_user': 'str', 'target_password': 'str', 'target_user': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_capacity_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_capacity_get_response.CloudCapacityGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[CloudCapacityStatus]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[CloudCapacityStatus]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_capacity_patch_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_capacity_patch_response.CloudCapacityPatchResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[CloudCapacityStatus]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[CloudCapacityStatus]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_capacity_status module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_capacity_status.CloudCapacityStatus(name=None, id=None, current_capacity=None, details=None, requested_capacity=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, current_capacity=None, details=None, requested_capacity=None, status=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
current_capacity (int) – The current raw capacity of the CBS array in bytes.
details (str) – Details about the capacity update. This field can contain error details when status is failed or progress information when status is expanding. For status idle the value is null.
requested_capacity (int) – The requested raw capacity of the CBS array in bytes. When the capacity update process finishes, it should be the same as current_capacity.
status (str) – The status of the capacity update process. Can be one of idle, failed, expanding.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'current_capacity': 'current_capacity', 'details': 'details', 'id': 'id', 'name': 'name', 'requested_capacity': 'requested_capacity', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'current_capacity': 'int', 'details': 'str', 'id': 'str', 'name': 'str', 'requested_capacity': 'int', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_capacity_step module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_capacity_step.CloudCapacityStep(supported_capacity=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(supported_capacity=None)
- Keyword Arguments
supported_capacity (int) – A possible supported raw capacity of the CBS array in bytes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'supported_capacity': 'supported_capacity'}
- keys()
- required_args = {}
- swagger_types = {'supported_capacity': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_capacity_steps_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_capacity_steps_get_response.CloudCapacityStepsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[CloudCapacityStep]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[CloudCapacityStep]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_config module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_config.CloudConfig(name=None, model=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, model=None, id=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
model (CloudConfigModel) – The model configuration of the CBS array.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'model': 'model', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'model': 'CloudConfigModel', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_config_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_config_get_response.CloudConfigGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[CloudConfig]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[CloudConfig]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_config_model module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_config_model.CloudConfigModel(current=None, requested=None, override_checks=None, details=None, step=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(current=None, requested=None, override_checks=None, details=None, step=None, status=None)
- Keyword Arguments
current (str) – The current model of the CBS array.
requested (str) – A requested model of the CBS array.
override_checks (list[str]) – A list of upgrade checks to be overridden.
details (str) – Details about the hardware upgrade. This field can contain error details or progress information when the status is upgrading. The default value is an empty string.
step (str) – The current step of the hardware upgrade process. Can be pre-upgrade-check, upgrade-ct0, failover and so on. The default value is an empty string.
status (str) – The status of the hardware upgrade process. Can be one of idle, paused, upgrading.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'current': 'current', 'details': 'details', 'override_checks': 'override_checks', 'requested': 'requested', 'status': 'status', 'step': 'step'}
- keys()
- required_args = {}
- swagger_types = {'current': 'str', 'details': 'str', 'override_checks': 'list[str]', 'requested': 'str', 'status': 'str', 'step': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_config_model_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_config_model_patch.CloudConfigModelPatch(requested=None, add_override_checks=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(requested=None, add_override_checks=None)
- Keyword Arguments
requested (str) – A supported model for the CBS array.
add_override_checks (list[str]) – A list of upgrade checks to be overridden.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'add_override_checks': 'add_override_checks', 'requested': 'requested'}
- keys()
- required_args = {}
- swagger_types = {'add_override_checks': 'list[str]', 'requested': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_config_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_config_patch.CloudConfigPatch(model=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(model=None)
- Keyword Arguments
model (CloudConfigModelPatch) – The requested model configuration of the CBS array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'model': 'model'}
- keys()
- required_args = {}
- swagger_types = {'model': 'CloudConfigModelPatch'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_config_patch_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_config_patch_response.CloudConfigPatchResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[CloudConfig]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[CloudConfig]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_config_supported module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_config_supported.CloudConfigSupported(supported_models=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(supported_models=None)
- Keyword Arguments
supported_models (list[str]) – List of supported models for an upgrade.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'supported_models': 'supported_models'}
- keys()
- required_args = {}
- swagger_types = {'supported_models': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_config_supported_configs_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_config_supported_configs_get_response.CloudConfigSupportedConfigsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[CloudConfigSupported]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[CloudConfigSupported]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_provider_tag module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_provider_tag.CloudProviderTag(details=None, value=None, key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(details=None, value=None, key=None)
- Keyword Arguments
details (str) – Details about the status of the tag if not healthy.
value (str) – Value of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations.
key (str) – Key of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'key': 'key', 'value': 'value'}
- keys()
- required_args = {}
- swagger_types = {'details': 'str', 'key': 'str', 'value': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_provider_tag_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_provider_tag_get_response.CloudProviderTagGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[CloudProviderTag]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[CloudProviderTag]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.cloud_provider_tag_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.cloud_provider_tag_response.CloudProviderTagResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[CloudProviderTag]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[CloudProviderTag]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.connection module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.connection.Connection(context=None, protocol_endpoint=None, volume=None, host_group=None, nsid=None, lun=None, host=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, protocol_endpoint=None, volume=None, host_group=None, nsid=None, lun=None, host=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
protocol_endpoint (Reference) – A protocol endpoint (also known as a conglomerate volume) which acts as a proxy through which virtual volumes are created and then connected to VMware ESXi hosts or host groups. The protocol endpoint itself does not serve I/Os; instead, its job is to form connections between FlashArray volumes and ESXi hosts and host groups.
volume (FixedReference) – A container that manages the storage space on the array.
host_group (ReferenceNoId) – A virtual collection of hosts with common connectivity to volumes.
nsid (int) – Namespace identifier allocated for the NVMe namespace backing the volume. NSID is set for NVMe connections only.
lun (int) – The logical unit number (LUN) by which the specified hosts are to address the specified volume. A LUN is set for SCSI connections only. A LUN can be in one of two formats: a simple LUN, or a LUN and Sublun with virtual volumes. The first format is simply the LUN. The second format is a single int64 combining both ((LUN << 32) + Sublun) or (LUN * 4294967296 + Sublun). In the FA UI, a combined LUN and Sublun is represented as LUN:Sublun. The maximum int64 LUN:Sublun value is 17587891081215.
host (ReferenceNoId) – The host computer that sends and receives I/O requests to and from volumes on the FlashArray array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'host': 'host', 'host_group': 'host_group', 'lun': 'lun', 'nsid': 'nsid', 'protocol_endpoint': 'protocol_endpoint', 'volume': 'volume'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'host': 'ReferenceNoId', 'host_group': 'ReferenceNoId', 'lun': 'int', 'nsid': 'int', 'protocol_endpoint': 'Reference', 'volume': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.connection_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.connection_get_response.ConnectionGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Connection]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Connection]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.connection_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.connection_post.ConnectionPost(protocol_endpoint=None, lun=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(protocol_endpoint=None, lun=None)
- Keyword Arguments
protocol_endpoint (Reference) – A protocol endpoint (also known as a conglomerate volume) which acts as a proxy through which virtual volumes are created and then connected to VMware ESXi hosts or host groups. The protocol endpoint itself does not serve I/Os; instead, its job is to form connections between FlashArray volumes and ESXi hosts and host groups.
lun (int) – The logical unit number (LUN) by which the specified hosts are to address the specified volume. If the LUN is not specified, the system automatically assigns a LUN to the connection. To automatically assign a LUN to a private connection, the system starts at LUN 1 and counts up to the maximum LUN 4095, assigning the first available LUN to the connection. For shared connections, the system starts at LUN 254 and counts down to the minimum LUN 1, assigning the first available LUN to the connection. If all LUNs in the [1…254] range are taken, the system starts at LUN 255 and counts up to the maximum LUN 4095, assigning the first available LUN to the connection. Should not be used together with an NVMe host or host group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'lun': 'lun', 'protocol_endpoint': 'protocol_endpoint'}
- keys()
- required_args = {}
- swagger_types = {'lun': 'int', 'protocol_endpoint': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.connection_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.connection_response.ConnectionResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Connection]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Connection]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.container_default_protection module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.container_default_protection.ContainerDefaultProtection(context=None, default_protections=None, name=None, id=None, type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, default_protections=None, name=None, id=None, type=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
default_protections (list[DefaultProtectionReference]) – The default protection that is applied to newly created volumes. Volumes can opt out of the default protection at creation. The pod’s default_protections defaults to the array’s default_protections at pod creation. To clear the list of default protections, set to an empty list [].
name (str) – The name of an administrative domain, a data container, and a namespace for volumes and protection groups. Values can be pod name or null. null represents the local array name.
id (str) – The id of an administrative domain, a data container, and a namespace for volumes and protection groups. Values can be pod id or null. Null represents the local array id.
type (str) – The type of an administrative domain, a data container, and a namespace for volumes and protection groups. Values can be pod or null. null represents the local array type.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'default_protections': 'default_protections', 'id': 'id', 'name': 'name', 'type': 'type'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'default_protections': 'list[DefaultProtectionReference]', 'id': 'str', 'name': 'str', 'type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.container_default_protection_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.container_default_protection_get_response.ContainerDefaultProtectionGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ContainerDefaultProtection]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ContainerDefaultProtection]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.container_default_protection_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.container_default_protection_response.ContainerDefaultProtectionResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ContainerDefaultProtection]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ContainerDefaultProtection]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.container_eradication_config module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.container_eradication_config.ContainerEradicationConfig(manual_eradication=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(manual_eradication=None)
- Keyword Arguments
manual_eradication (str) – The manual eradication status of the container. If all-enabled, the container and its contents can be eradicated. If partially-disabled, the container cannot be eradicated because the container contains some non-empty protection groups that are retention-locked. If all-disabled, the container and its contents cannot be eradicated. Values include all-disabled, all-enabled, and partially-disabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'manual_eradication': 'manual_eradication'}
- keys()
- required_args = {}
- swagger_types = {'manual_eradication': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.container_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.container_performance.ContainerPerformance(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None, others_per_sec=None, usec_per_other_op=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None, others_per_sec=None, usec_per_other_op=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
others_per_sec (int) – The number of other requests processed per second.
usec_per_other_op (int) – The average time it takes the pod to process an I/O other request, measured in microseconds.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'context': 'context', 'id': 'id', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'others_per_sec': 'others_per_sec', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_other_op': 'usec_per_other_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'context': 'FixedReference', 'id': 'str', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'others_per_sec': 'int', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_other_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.container_performance_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.container_performance_get_response.ContainerPerformanceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ContainerPerformance]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.
items (list[ContainerPerformance]) – Performance data. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ContainerPerformance]', 'more_items_remaining': 'bool', 'total': 'list[ContainerPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.container_qos module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.container_qos.ContainerQos(bandwidth_limit=None, iops_limit=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(bandwidth_limit=None, iops_limit=None)
- Keyword Arguments
bandwidth_limit (int) – The maximum QoS bandwidth limit for the container. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Maximum limit is 512 GB/s.
iops_limit (int) – The QoS IOPs limit for the container.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bandwidth_limit': 'bandwidth_limit', 'iops_limit': 'iops_limit'}
- keys()
- required_args = {}
- swagger_types = {'bandwidth_limit': 'int', 'iops_limit': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.context module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.context.Context(context=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.controller module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.controller.Controller(name=None, mode=None, mode_since=None, model=None, type=None, version=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, mode=None, mode_since=None, model=None, type=None, version=None, status=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
mode (str) – Mode of controller. Values include not present, offline, primary, and secondary.
mode_since (int) – The time at which the current mode of the controller was last set. It is measured in milliseconds since the UNIX epoch. If the controller mode is not present or offline, this field will be null.
model (str) –
type (str) – Type of controller. Values include array_controller and shelf_controller.
version (str) –
status (str) – Status of controller. Values include not ready, ready, unknown, and updating.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'mode': 'mode', 'mode_since': 'mode_since', 'model': 'model', 'name': 'name', 'status': 'status', 'type': 'type', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'mode': 'str', 'mode_since': 'int', 'model': 'str', 'name': 'str', 'status': 'str', 'type': 'str', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.controller_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.controller_get_response.ControllerGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Controller]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Controller]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.default_protection_reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.default_protection_reference.DefaultProtectionReference(name=None, id=None, type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, type=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
type (str) – The type of default protection. Currently, the only valid value is protection_group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'type': 'type'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.destroyed_patch_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.destroyed_patch_post.DestroyedPatchPost(destroyed=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory.Directory(name=None, id=None, time_remaining=None, path=None, destroyed=None, file_system=None, created=None, limited_by=None, directory_name=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, time_remaining=None, path=None, destroyed=None, file_system=None, created=None, limited_by=None, directory_name=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
time_remaining (int) – The amount of time left, measured in milliseconds until the destroyed managed directory is permanently eradicated.
path (str) – Absolute path of the managed directory in the file system.
destroyed (bool) – Returns a value of true if the managed directory has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed managed directory is permanently eradicated. Once the time_remaining period has elapsed, the managed directory is permanently eradicated and can no longer be recovered.
file_system (FixedReference) – The file system that this managed directory is in.
created (int) – The managed directory creation time, measured in milliseconds since the UNIX epoch.
limited_by (LimitedBy) – The quota policy that is limiting usage on this managed directory. This policy defines the total amount of space provisioned to this managed directory and its descendants. The returned value contains two parts: the name of the policy and the managed directory to which the policy is attached.
directory_name (str) – The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of FILE_SYSTEM:DIR where FILE_SYSTEM is the file system name and DIR is the value of this field.
space (Space) – Displays size and space consumption details.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'destroyed': 'destroyed', 'directory_name': 'directory_name', 'file_system': 'file_system', 'id': 'id', 'limited_by': 'limited_by', 'name': 'name', 'path': 'path', 'space': 'space', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'created': 'int', 'destroyed': 'bool', 'directory_name': 'str', 'file_system': 'FixedReference', 'id': 'str', 'limited_by': 'LimitedBy', 'name': 'str', 'path': 'str', 'space': 'Space', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_export module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_export.DirectoryExport(export_name=None, enabled=None, status=None, path=None, destroyed=None, directory=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(export_name=None, enabled=None, status=None, path=None, destroyed=None, directory=None, policy=None)
- Keyword Arguments
export_name (str) – The export name for accessing this export.
enabled (bool) – Returns a value of true if the export policy that manages this export is enabled.
status (str) – Explains why enabled is false, or whether there is a name conflict with another export. Valid values include policy_disabled, export_disabled, and name_conflict.
path (str) – The path of the exported managed directory.
destroyed (bool) – Returns a value of true if the managed directory of the export has been destroyed and is pending eradication. The export can be recovered by recovering the destroyed managed directory.
directory (FixedReferenceWithType) – The managed directory of the export.
policy (FixedReferenceWithType) – The export policy that manages this export. An export can be managed by at most one export policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'directory': 'directory', 'enabled': 'enabled', 'export_name': 'export_name', 'path': 'path', 'policy': 'policy', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'directory': 'FixedReferenceWithType', 'enabled': 'bool', 'export_name': 'str', 'path': 'str', 'policy': 'FixedReferenceWithType', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_export_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_export_get_response.DirectoryExportGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[DirectoryExport]) – Displays a list of all items after filtering. The values are displayed for each name if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[DirectoryExport]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_export_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_export_patch.DirectoryExportPatch(export_enabled=None, export_name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(export_enabled=None, export_name=None)
- Keyword Arguments
export_enabled (bool) – If set to true, the export is enabled. If not specified, defaults to true.
export_name (str) – The new name of the export. Export names must be unique within the same protocol.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'export_enabled': 'export_enabled', 'export_name': 'export_name'}
- keys()
- required_args = {}
- swagger_types = {'export_enabled': 'bool', 'export_name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_export_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_export_post.DirectoryExportPost(export_enabled=None, export_name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(export_enabled=None, export_name=None)
- Keyword Arguments
export_enabled (bool) – If set to true, the export is enabled. If not specified, defaults to true.
export_name (str) – The name of the export to create. Export names must be unique within the same protocol.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'export_enabled': 'export_enabled', 'export_name': 'export_name'}
- keys()
- required_args = {}
- swagger_types = {'export_enabled': 'bool', 'export_name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_export_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_export_response.DirectoryExportResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[DirectoryExport]) – Displays a list of all items after filtering. The values are displayed for each name if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[DirectoryExport]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_get_response.DirectoryGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Directory]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
total (list[Directory]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Directory]', 'more_items_remaining': 'bool', 'total': 'list[Directory]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_lock_nlm_reclamation module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_lock_nlm_reclamation.DirectoryLockNlmReclamation(start=None, end=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(start=None, end=None)
- Keyword Arguments
start (int) – Start time of the NLM reclamation in milliseconds since the UNIX epoch.
end (int) – End time of the NLM reclamation in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'end': 'end', 'start': 'start'}
- keys()
- required_args = {}
- swagger_types = {'end': 'int', 'start': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_lock_nlm_reclamation_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_lock_nlm_reclamation_response.DirectoryLockNlmReclamationResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[DirectoryLockNlmReclamation]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[DirectoryLockNlmReclamation]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_patch.DirectoryPatch(name=None, directory_name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, directory_name=None)
- Keyword Arguments
name (str) – The new name for the resource.
directory_name (str) – The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of FILE_SYSTEM:DIR where FILE_SYSTEM is the file system name and DIR is the value of this field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'directory_name': 'directory_name', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'directory_name': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_performance.DirectoryPerformance(name=None, id=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
read_bytes_per_sec (int) – The number of bytes read per second.
others_per_sec (int) – The number of other requests processed per second.
reads_per_sec (int) – The number of read requests processed per second.
write_bytes_per_sec (int) – The number of bytes written per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
usec_per_other_op (int) – The average time it takes the array to process an I/O other request, measured in microseconds.
writes_per_sec (int) – The number of write requests processed per second.
time (int) – The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'id': 'id', 'name': 'name', 'others_per_sec': 'others_per_sec', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'time': 'time', 'usec_per_other_op': 'usec_per_other_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'id': 'str', 'name': 'str', 'others_per_sec': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'time': 'int', 'usec_per_other_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_performance_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_performance_get_response.DirectoryPerformanceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
total (list[DirectoryPerformance]) – The aggregate value of all items after filtering. When it makes sense, the average value is displayed instead. The values are displayed for each field if meaningful.
items (list[DirectoryPerformance]) – Performance data. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[DirectoryPerformance]', 'more_items_remaining': 'bool', 'total': 'list[DirectoryPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_policy_export_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_policy_export_post.DirectoryPolicyExportPost(policies=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(policies=None)
- Keyword Arguments
policies (list[DirectorypolicyexportpostPolicies]) – A list of export policies to apply to the directory. The id and name fields in each policy parameter are required, but cannot be set together.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'policies': 'policies'}
- keys()
- required_args = {}
- swagger_types = {'policies': 'list[DirectorypolicyexportpostPolicies]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_policy_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_policy_post.DirectoryPolicyPost(policies=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(policies=None)
- Keyword Arguments
policies (list[DirectorypolicypostPolicies]) – A list of policies to apply to the resource. The id or name field in each policy parameter is required, but they cannot be set together.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'policies': 'policies'}
- keys()
- required_args = {}
- swagger_types = {'policies': 'list[DirectorypolicypostPolicies]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_post.DirectoryPost(path=None, directory_name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(path=None, directory_name=None)
- Keyword Arguments
path (str) – Path of the managed directory in the file system.
directory_name (str) – The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of FILE_SYSTEM:DIR where FILE_SYSTEM is the file system name and DIR is the value of this field. directory_name is required if file_system_names or file_system_ids is set. directory_name cannot be set if names is set.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'directory_name': 'directory_name', 'path': 'path'}
- keys()
- required_args = {}
- swagger_types = {'directory_name': 'str', 'path': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_quota module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_quota.DirectoryQuota(quota_limit=None, enforced=None, path=None, rule_name=None, percentage_used=None, usage=None, directory=None, enabled=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(quota_limit=None, enforced=None, path=None, rule_name=None, percentage_used=None, usage=None, directory=None, enabled=None, policy=None)
- Keyword Arguments
quota_limit (int) – Effective quota limit imposed by the quota policy rule attached to the directory, measured in bytes.
enforced (bool) – Defines whether the quota rule is enforced or unenforced. If the quota rule is enforced and logical space usage exceeds the quota limit, any modification operations that result in a need for more space are blocked. If the quota rule is unenforced and logical space usage exceeds the quota limit, notification emails are sent to targets that are specified using the notification parameter. No client operations are blocked when an unenforced limit is exceeded. If set to true, the limit is enforced. If set to false, notification targets are informed when the usage exceeds 80 percent of the limit.
path (str) – Absolute path of the directory in the file system.
rule_name (str) – Name of the rule that results in this quota and behavior being applied to this directory.
percentage_used (float) – The percentage of the space used in the directory with respect to the quota limit.
usage (int) – The amount of logically written data for the directory, measured in bytes.
directory (FixedReferenceWithType) – The directory to which the quota applies.
enabled (bool) – Returns a value of true if the policy is enabled.
policy (FixedReferenceWithType) – The effective quota policy that imposes the limit. This is the policy with the lowest limit.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'directory': 'directory', 'enabled': 'enabled', 'enforced': 'enforced', 'path': 'path', 'percentage_used': 'percentage_used', 'policy': 'policy', 'quota_limit': 'quota_limit', 'rule_name': 'rule_name', 'usage': 'usage'}
- keys()
- required_args = {}
- swagger_types = {'directory': 'FixedReferenceWithType', 'enabled': 'bool', 'enforced': 'bool', 'path': 'str', 'percentage_used': 'float', 'policy': 'FixedReferenceWithType', 'quota_limit': 'int', 'rule_name': 'str', 'usage': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_quotas_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_quotas_get_response.DirectoryQuotasGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[DirectoryQuota]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[DirectoryQuota]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_quotas_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_quotas_response.DirectoryQuotasResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[DirectoryQuota]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[DirectoryQuota]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_response.DirectoryResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Directory]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Directory]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_service module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_service.DirectoryService(name=None, ca_certificate=None, check_peer=None, uris=None, base_dn=None, bind_password=None, management=None, services=None, bind_user=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, ca_certificate=None, check_peer=None, uris=None, base_dn=None, bind_password=None, management=None, services=None, bind_user=None, enabled=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
ca_certificate (str) – The certificate of the Certificate Authority (CA) that signed the certificates of the directory servers, which is used to validate the authenticity of the configured servers.
check_peer (bool) – Whether or not server authenticity is enforced when a certificate is provided.
uris (list[str]) – List of URIs for the configured directory servers.
base_dn (str) – Base of the Distinguished Name (DN) of the directory service groups.
bind_password (str) – Masked password used to query the directory.
management (DirectoryServiceManagement) –
services (list[str]) – The services the directory service configuration is used for.
bind_user (str) – Username used to query the directory.
enabled (bool) – Whether or not the directory service is enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'base_dn': 'base_dn', 'bind_password': 'bind_password', 'bind_user': 'bind_user', 'ca_certificate': 'ca_certificate', 'check_peer': 'check_peer', 'enabled': 'enabled', 'management': 'management', 'name': 'name', 'services': 'services', 'uris': 'uris'}
- keys()
- required_args = {}
- swagger_types = {'base_dn': 'str', 'bind_password': 'str', 'bind_user': 'str', 'ca_certificate': 'str', 'check_peer': 'bool', 'enabled': 'bool', 'management': 'DirectoryServiceManagement', 'name': 'str', 'services': 'list[str]', 'uris': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_service_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_service_get_response.DirectoryServiceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[DirectoryService]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[DirectoryService]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_service_management module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_service_management.DirectoryServiceManagement(user_login_attribute=None, ssh_public_key_attribute=None, user_object_class=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(user_login_attribute=None, ssh_public_key_attribute=None, user_object_class=None)
- Keyword Arguments
user_login_attribute (str) – User login attribute in the structure of the configured LDAP servers. Typically the attribute field that holds the user’s unique login name. Default value is sAMAccountName for Active Directory or uid for all other directory services.
ssh_public_key_attribute (str) – SSH public key attribute in the structure of the configured LDAP servers. The attribute field that holds the user’s SSH public key. This attribute can represent a single-valued or multi-valued field. If this attribute resolves to a multi-valued field, all valid SSH keys will be used. If the user has specified keys under Admin endpoints, these are used as well.
user_object_class (str) – Value of the object class for a management LDAP user. Defaults to User for Active Directory servers, posixAccount or shadowAccount for OpenLDAP servers dependent on the group type of the server, or person for all other directory servers.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ssh_public_key_attribute': 'ssh_public_key_attribute', 'user_login_attribute': 'user_login_attribute', 'user_object_class': 'user_object_class'}
- keys()
- required_args = {}
- swagger_types = {'ssh_public_key_attribute': 'str', 'user_login_attribute': 'str', 'user_object_class': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_service_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_service_response.DirectoryServiceResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[DirectoryService]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[DirectoryService]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_service_role module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_service_role.DirectoryServiceRole(name=None, management_access_policies=None, role=None, group_base=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, management_access_policies=None, role=None, group_base=None, group=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and cannot be changed.
management_access_policies (list[FixedReferenceWithType]) – List of management access policies associated with the group.
role (ReferenceNoId) – This field has been deprecated. Predecessor to management access policies.
group_base (str) – Specifies where the configured group is located in the directory tree.
group (str) – Group name that contains users with the abilities granted by the associated policies.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'group': 'group', 'group_base': 'group_base', 'management_access_policies': 'management_access_policies', 'name': 'name', 'role': 'role'}
- keys()
- required_args = {}
- swagger_types = {'group': 'str', 'group_base': 'str', 'management_access_policies': 'list[FixedReferenceWithType]', 'name': 'str', 'role': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_service_role_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_service_role_get_response.DirectoryServiceRoleGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[DirectoryServiceRole]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[DirectoryServiceRole]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_service_role_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_service_role_post.DirectoryServiceRolePost(management_access_policies=None, role=None, group_base=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(management_access_policies=None, role=None, group_base=None, group=None)
- Keyword Arguments
management_access_policies (list[ReferenceWithType]) – List of management access policies to associate with the group.
role (ReferenceNoId) – This field has been deprecated. Predecessor to management access policies. Can be set to the premade policy of the same name. Cannot be set with management_access_policies.
group_base (str) – Specifies where the configured group is located in the directory tree.
group (str) – Group name that contains users with the abilities granted by the associated policies.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'group': 'group', 'group_base': 'group_base', 'management_access_policies': 'management_access_policies', 'role': 'role'}
- keys()
- required_args = {}
- swagger_types = {'group': 'str', 'group_base': 'str', 'management_access_policies': 'list[ReferenceWithType]', 'role': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_service_role_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_service_role_response.DirectoryServiceRoleResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[DirectoryServiceRole]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[DirectoryServiceRole]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_snapshot module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_snapshot.DirectorySnapshot(name=None, id=None, time_remaining=None, destroyed=None, created=None, source=None, suffix=None, client_name=None, space=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, time_remaining=None, destroyed=None, created=None, source=None, suffix=None, client_name=None, space=None, policy=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
time_remaining (int) – The amount of time left until the directory snapshot is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the snapshot can be recovered by setting destroyed=false if it is destroyed, by setting policy=”” if it is managed by a snapshot policy, or by setting `keep_for=”” ` if it is a manual snapshot.
destroyed (bool) – Returns a value of true if the snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed directory snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed directory snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the directory snapshot is permanently eradicated and can no longer be recovered.
created (int) – The snapshot creation time, measured in milliseconds since the UNIX epoch.
source (FixedReference) – The directory from which this snapshot was taken.
suffix (int) – The suffix that is appended to the source_name value and the client_name value to generate the full directory snapshot name in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the client name, and SUFFIX is the suffix. If the suffix is a string, this field returns null. See the name value for the full snapshot name including the suffix.
client_name (str) – The customizable portion of the client-visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the full managed directory name, CLIENT_NAME is the client name, and SUFFIX is the suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX.
space (Space) – Displays size and space consumption details.
policy (FixedReference) – The snapshot policy that manages this snapshot, if applicable.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client_name': 'client_name', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'policy': 'policy', 'source': 'source', 'space': 'space', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'client_name': 'str', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'policy': 'FixedReference', 'source': 'FixedReference', 'space': 'Space', 'suffix': 'int', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_snapshot_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_snapshot_get_response.DirectorySnapshotGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[DirectorySnapshot]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
total (list[DirectorySnapshot]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[DirectorySnapshot]', 'more_items_remaining': 'bool', 'total': 'list[DirectorySnapshot]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_snapshot_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_snapshot_patch.DirectorySnapshotPatch(destroyed=None, name=None, keep_for=None, suffix=None, client_name=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None, name=None, keep_for=None, suffix=None, client_name=None, policy=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
name (str) – The new name of a directory snapshot. The name of a directory snapshot managed by a snapshot policy is not changeable.
keep_for (int) – The amount of time to keep the snapshots, in milliseconds. Can only be set on snapshots that are not managed by any snapshot policy. Set to “” to clear the keep_for value.
suffix (str) – The suffix portion of the client-visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the client name, and SUFFIX is the value of this field. The client-visible snapshot name is CLIENT_NAME.SUFFIX. The suffix of a directory snapshot managed by a snapshot policy is not changeable. If the name and suffix parameters are both specified, suffix must match the suffix portion of name.
client_name (str) – The client name portion of the client-visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the value of this field, and SUFFIX is the suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX. The client name of a directory snapshot managed by a snapshot policy is not changeable. If the name and client_name parameters are both specified, client_name must match the client name portion of name.
policy (Reference) – The snapshot policy that manages this snapshot. Set to name or id to “” to clear the policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client_name': 'client_name', 'destroyed': 'destroyed', 'keep_for': 'keep_for', 'name': 'name', 'policy': 'policy', 'suffix': 'suffix'}
- keys()
- required_args = {}
- swagger_types = {'client_name': 'str', 'destroyed': 'bool', 'keep_for': 'int', 'name': 'str', 'policy': 'Reference', 'suffix': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_snapshot_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_snapshot_post.DirectorySnapshotPost(keep_for=None, suffix=None, client_name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(keep_for=None, suffix=None, client_name=None)
- Keyword Arguments
keep_for (int) – The time to keep the snapshots for, in milliseconds.
suffix (str) – The suffix portion of the client visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the client name, and SUFFIX is the value of this field. The client visible snapshot name is CLIENT_NAME.SUFFIX. If not specified, defaults to a monotonically increasing number generated by the system.
client_name (str) – The client name portion of the client visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the value of this field, and SUFFIX is the suffix. The client visible snapshot name is CLIENT_NAME.SUFFIX.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client_name': 'client_name', 'keep_for': 'keep_for', 'suffix': 'suffix'}
- keys()
- required_args = {}
- swagger_types = {'client_name': 'str', 'keep_for': 'int', 'suffix': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directory_snapshot_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directory_snapshot_response.DirectorySnapshotResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[DirectorySnapshot]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[DirectorySnapshot]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directorypolicyexportpost_policies module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directorypolicyexportpost_policies.DirectorypolicyexportpostPolicies(export_enabled=None, export_name=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(export_enabled=None, export_name=None, policy=None)
- Keyword Arguments
export_enabled (bool) – If set to true, the export is enabled. If not specified, defaults to true.
export_name (str) – The name of the export to create when applying the export policy to the directory.
policy (Reference) – Reference to the export policy to apply to the directory.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'export_enabled': 'export_enabled', 'export_name': 'export_name', 'policy': 'policy'}
- keys()
- required_args = {}
- swagger_types = {'export_enabled': 'bool', 'export_name': 'str', 'policy': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.directorypolicypost_policies module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.directorypolicypost_policies.DirectorypolicypostPolicies(policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(policy=None)
- Keyword Arguments
policy (Reference) – Reference to the policy to apply to the resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'policy': 'policy'}
- keys()
- required_args = {}
- swagger_types = {'policy': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.dns module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.dns.Dns(name=None, ca_certificate=None, nameservers=None, domain=None, ca_certificate_group=None, services=None, source=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, ca_certificate=None, nameservers=None, domain=None, ca_certificate_group=None, services=None, source=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
ca_certificate (ReferenceWithType) – A reference to the certificate to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate_group property and may only be configured when nameservers begin with HTTPS.
nameservers (list[str]) – The list of DNS servers either in the form of IP addresses or HTTPS endpoints. Domain names in HTTPS endpoints are not supported. IP addresses must be used instead. If nameservers begin with https://, then DNS queries will be performed over HTTPS. Otherwise, unencrypted DNS queries will be performed. Using a combination of nameservers that begin with https:// and that do not begin with https:// is not supported. If servers are specified with https:// one of ca_certificate and ca_certificate_group parameters must be set.
domain (str) – The domain suffix to be appended by the appliance when performing DNS lookups.
ca_certificate_group (ReferenceWithType) – A reference to the certificate group to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate property and may only be configured when nameservers begin with HTTPS.
services (list[str]) – The list of services utilizing the DNS configuration.
source (ReferenceNoId) – The network interface used for communication with the DNS server.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ca_certificate': 'ca_certificate', 'ca_certificate_group': 'ca_certificate_group', 'domain': 'domain', 'name': 'name', 'nameservers': 'nameservers', 'services': 'services', 'source': 'source'}
- keys()
- required_args = {}
- swagger_types = {'ca_certificate': 'ReferenceWithType', 'ca_certificate_group': 'ReferenceWithType', 'domain': 'str', 'name': 'str', 'nameservers': 'list[str]', 'services': 'list[str]', 'source': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.dns_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.dns_get_response.DnsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Dns]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Dns]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.dns_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.dns_patch.DnsPatch(name=None, ca_certificate=None, nameservers=None, domain=None, ca_certificate_group=None, services=None, source=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, ca_certificate=None, nameservers=None, domain=None, ca_certificate_group=None, services=None, source=None)
- Keyword Arguments
name (str) – The new name for the resource.
ca_certificate (ReferenceWithType) – A reference to the certificate to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate_group property and may only be configured when nameservers begin with HTTPS.
nameservers (list[str]) – The list of DNS servers either in the form of IP addresses or HTTPS endpoints. Domain names in HTTPS endpoints are not supported. IP addresses must be used instead. If nameservers begin with https://, then DNS queries will be performed over HTTPS. Otherwise, unencrypted DNS queries will be performed. Using a combination of nameservers that begin with https:// and that do not begin with https:// is not supported. If servers are specified with https:// one of ca_certificate and ca_certificate_group parameters must be set.
domain (str) – The domain suffix to be appended by the appliance when performing DNS lookups.
ca_certificate_group (ReferenceWithType) – A reference to the certificate group to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate property and may only be configured when nameservers begin with HTTPS.
services (list[str]) – The list of services utilizing the DNS configuration.
source (ReferenceNoId) – The network interface used for communication with the DNS server.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ca_certificate': 'ca_certificate', 'ca_certificate_group': 'ca_certificate_group', 'domain': 'domain', 'name': 'name', 'nameservers': 'nameservers', 'services': 'services', 'source': 'source'}
- keys()
- required_args = {}
- swagger_types = {'ca_certificate': 'ReferenceWithType', 'ca_certificate_group': 'ReferenceWithType', 'domain': 'str', 'name': 'str', 'nameservers': 'list[str]', 'services': 'list[str]', 'source': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.dns_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.dns_post.DnsPost(ca_certificate=None, nameservers=None, domain=None, ca_certificate_group=None, services=None, source=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(ca_certificate=None, nameservers=None, domain=None, ca_certificate_group=None, services=None, source=None)
- Keyword Arguments
ca_certificate (ReferenceWithType) – A reference to the certificate to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate_group property and may only be configured when nameservers begin with HTTPS.
nameservers (list[str]) – The list of DNS servers either in the form of IP addresses or HTTPS endpoints. Domain names in HTTPS endpoints are not supported. IP addresses must be used instead. If nameservers begin with https://, then DNS queries will be performed over HTTPS. Otherwise, unencrypted DNS queries will be performed. Using a combination of nameservers that begin with https:// and that do not begin with https:// is not supported. If servers are specified with https:// one of ca_certificate and ca_certificate_group parameters must be set.
domain (str) – The domain suffix to be appended by the appliance when performing DNS lookups.
ca_certificate_group (ReferenceWithType) – A reference to the certificate group to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate property and may only be configured when nameservers begin with HTTPS.
services (list[str]) – The list of services utilizing the DNS configuration.
source (ReferenceNoId) – The network interface used for communication with the DNS server.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ca_certificate': 'ca_certificate', 'ca_certificate_group': 'ca_certificate_group', 'domain': 'domain', 'nameservers': 'nameservers', 'services': 'services', 'source': 'source'}
- keys()
- required_args = {}
- swagger_types = {'ca_certificate': 'ReferenceWithType', 'ca_certificate_group': 'ReferenceWithType', 'domain': 'str', 'nameservers': 'list[str]', 'services': 'list[str]', 'source': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.dns_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.dns_response.DnsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Dns]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.drive module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.drive.Drive(name=None, protocol=None, details=None, type=None, capacity=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, protocol=None, details=None, type=None, capacity=None, status=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
protocol (str) – Storage protocol of the module. Valid values are NVMe and SAS.
details (str) – Details about the status of the module if not healthy.
type (str) – The type of the module. Valid values are cache, NVRAM, SSD, and virtual.
capacity (int) – Physical storage capacity of the module in bytes.
status (str) – Current status of the module. Valid values are empty, failed, healthy, identifying, missing, recovering, unadmitted, unhealthy, unrecognized, and updating.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'capacity': 'capacity', 'details': 'details', 'name': 'name', 'protocol': 'protocol', 'status': 'status', 'type': 'type'}
- keys()
- required_args = {}
- swagger_types = {'capacity': 'int', 'details': 'str', 'name': 'str', 'protocol': 'str', 'status': 'str', 'type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.drive_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.drive_get_response.DriveGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Drive]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Drive]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.drive_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.drive_response.DriveResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Drive]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.eradication_config module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.eradication_config.EradicationConfig(eradication_delay=None, disabled_delay=None, enabled_delay=None, manual_eradication=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(eradication_delay=None, disabled_delay=None, enabled_delay=None, manual_eradication=None)
- Keyword Arguments
eradication_delay (int) – Eradication delay in milliseconds for all destroyed objects. Automatically eradicate destroyed objects after the configured delay time passes. Updating this field will update both eradication_disabled_delay and eradication_enabled_delay if both eradication_disabled_delay and eradication_enabled_delay have the same value. If eradication_disabled_delay and eradication_enabled_delay have different values, trying to configure eradication_delay will result in an error. This field has been deprecated and will be removed in a future REST version. Valid values are 86400000 and any multiple of 86400000 in the range of 86400000 and 2592000000. Any other values are rounded down to the nearest multiple of 86400000.
disabled_delay (int) – The eradication delay in milliseconds for destroyed objects that cannot be manually eradicated. Destroyed objects that cannot be manually eradicated will be automatically eradicated after the configured delay time passes. Valid values are 86400000 and any multiple of 86400000 in the range of 86400000 and 2592000000. Any other values are rounded down to the nearest multiple of 86400000.
enabled_delay (int) – The eradication delay in milliseconds for destroyed objects that can be manually eradicated. Destroyed objects that can be manually eradicated will be automatically eradicated after the configured delay time passes. Valid values are 86400000 and any multiple of 86400000 in the range of 86400000 and 2592000000. Any other values are rounded down to the nearest multiple of 86400000.
manual_eradication (str) – Manual eradication status applied on the array level. If status is all-disabled, you cannot eradicate objects, files, and directories. If at least one local object has manual_eradication disabled, then the status will be partially-disabled. Values include all-disabled, partially-disabled, and all-enabled. If the user does not have sufficient access, this field will return null.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'disabled_delay': 'disabled_delay', 'enabled_delay': 'enabled_delay', 'eradication_delay': 'eradication_delay', 'manual_eradication': 'manual_eradication'}
- keys()
- required_args = {}
- swagger_types = {'disabled_delay': 'int', 'enabled_delay': 'int', 'eradication_delay': 'int', 'manual_eradication': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.error_context_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.error_context_response.ErrorContextResponse(errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(errors=None)
- Keyword Arguments
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'errors': 'errors'}
- keys()
- required_args = {}
- swagger_types = {'errors': 'list[ErrorcontextresponseErrors]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.errorcontextresponse_errors module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.errorcontextresponse_errors.ErrorcontextresponseErrors(context=None, location_context=None, message=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, location_context=None, message=None)
- Keyword Arguments
context (str) – Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be null for more general errors.
location_context (FixedReferenceWithType) – Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be null for more general errors, or if no explicit context parameter was provided with the request.
message (str) – A description of the error which occurred.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'location_context': 'location_context', 'message': 'message'}
- keys()
- required_args = {}
- swagger_types = {'context': 'str', 'location_context': 'FixedReferenceWithType', 'message': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.eula module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.eula.Eula(agreement=None, signature=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(agreement=None, signature=None)
- Keyword Arguments
agreement (str) – The End User Agreement text.
signature (EulaSignature) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'agreement': 'agreement', 'signature': 'signature'}
- keys()
- required_args = {}
- swagger_types = {'agreement': 'str', 'signature': 'EulaSignature'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.eula_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.eula_get_response.EulaGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Eula]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Eula]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.eula_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.eula_response.EulaResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Eula]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.eula_signature module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.eula_signature.EulaSignature(name=None, accepted=None, company=None, title=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, accepted=None, company=None, title=None)
- Keyword Arguments
name (str) – The name of the person who accepted the End User Agreement. This field is deprecated and the response will be null. Modification to this field will be ignored.
accepted (int) – Accepted time in milliseconds since the UNIX epoch.
company (str) – The company of the person who accepted the End User Agreement. This field is deprecated and the response will be null. Modification to this field will be ignored.
title (str) – The title of the person who accepted the End User Agreement. This field is deprecated and the response will be null. Modification to this field will be ignored.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'accepted': 'accepted', 'company': 'company', 'name': 'name', 'title': 'title'}
- keys()
- required_args = {}
- swagger_types = {'accepted': 'int', 'company': 'str', 'name': 'str', 'title': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.export_policy_attachment_mixin module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.export_policy_attachment_mixin.ExportPolicyAttachmentMixin(export_name=None, enabled=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(export_name=None, enabled=None, status=None)
- Keyword Arguments
export_name (str) – The export name for accessing this export.
enabled (bool) – Returns a value of true if and only if the export policy that manages this export is enabled AND this export is enabled.
status (str) – Explains why enabled is false, or whether there is a name conflict with another export. Valid values include policy_disabled, export_disabled, and name_conflict.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'export_name': 'export_name', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'export_name': 'str', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.file_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.file_post.FilePost(source=None, source_path=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(source=None, source_path=None)
- Keyword Arguments
source (ReferenceWithType) – The source information of a file copy.
source_path (str) – The source file path relative to the source directory.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'source': 'source', 'source_path': 'source_path'}
- keys()
- required_args = {}
- swagger_types = {'source': 'ReferenceWithType', 'source_path': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.file_system module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.file_system.FileSystem(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, measured in milliseconds until the destroyed file system is permanently eradicated. Before the time_remaining period has elapsed, the destroyed file system can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the file system has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed file system is permanently eradicated. Before the time_remaining period has elapsed, the destroyed file system can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the file system is permanently eradicated and can no longer be recovered.
pod (Reference) – The reference to the pod this file systems belongs to, or null if it is not in a pod.
created (int) – The file system creation time, measured in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'pod': 'pod', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'pod': 'Reference', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.file_system_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.file_system_get_response.FileSystemGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[FileSystem]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[FileSystem]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.file_system_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.file_system_patch.FileSystemPatch(destroyed=None, name=None, pod=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None, name=None, pod=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
name (str) – The new name for the resource.
pod (Reference) – The pod to move existing file systems into.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'name': 'name', 'pod': 'pod'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'name': 'str', 'pod': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.file_system_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.file_system_response.FileSystemResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[FileSystem]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[FileSystem]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fixed_name_resource_no_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fixed_name_resource_no_id.FixedNameResourceNoId(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and cannot be changed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fixed_reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fixed_reference.FixedReference(name=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fixed_reference_no_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fixed_reference_no_id.FixedReferenceNoId(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fixed_reference_with_type module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fixed_reference_with_type.FixedReferenceWithType(name=None, id=None, resource_type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, resource_type=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
resource_type (str) – Type of the object (full name of the endpoint). Valid values include hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, policies/snapshot, and policies/quota, etc.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'resource_type': 'resource_type'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fixed_reference_with_type_and_location module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fixed_reference_with_type_and_location.FixedReferenceWithTypeAndLocation(name=None, id=None, is_local=None, resource_type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, is_local=None, resource_type=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
is_local (bool) – If set to true, the location reference is to the local array. If set to false, the location reference is to a remote location, such as a remote array or offload target.
resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a fleet would have a resource_type of fleets.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'is_local': 'is_local', 'name': 'name', 'resource_type': 'resource_type'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'is_local': 'bool', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet.Fleet(name=None, id=None, is_local=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, is_local=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
is_local (bool) – If set to true, the current array is a member of the fleet.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'is_local': 'is_local', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'is_local': 'bool', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_get_response.FleetGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Fleet]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Fleet]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_key module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_key.FleetKey(expires=None, created=None, fleet_key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(expires=None, created=None, fleet_key=None)
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'expires': 'expires', 'fleet_key': 'fleet_key'}
- keys()
- required_args = {}
- swagger_types = {'created': 'int', 'expires': 'int', 'fleet_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_key_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_key_get_response.FleetKeyGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[FleetKey]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[FleetKey]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_key_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_key_response.FleetKeyResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[FleetKey]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_member module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_member.FleetMember(fleet=None, member=None, status_details=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(fleet=None, member=None, status_details=None, status=None)
- Keyword Arguments
fleet (FixedReferenceWithTypeAndLocation) –
member (FixedReferenceWithTypeAndLocation) –
status_details (str) – Describes the error, if any.
status (str) – 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.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'fleet': 'fleet', 'member': 'member', 'status': 'status', 'status_details': 'status_details'}
- keys()
- required_args = {}
- swagger_types = {'fleet': 'FixedReferenceWithTypeAndLocation', 'member': 'FixedReferenceWithTypeAndLocation', 'status': 'str', 'status_details': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_member_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_member_get_response.FleetMemberGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[FleetMember]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[FleetMember]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_member_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_member_post.FleetMemberPost(members=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(members=None)
- Keyword Arguments
members (list[FleetmemberpostMembers]) – Details about the members being added to fleet.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'members': 'members'}
- keys()
- required_args = {}
- swagger_types = {'members': 'list[FleetmemberpostMembers]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_member_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_member_response.FleetMemberResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[FleetMember]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[FleetMember]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_patch.FleetPatch(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – The new name for the resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleet_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleet_response.FleetResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Fleet]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Fleet]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleetmemberpost_member module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleetmemberpost_member.FleetmemberpostMember(name=None, resource_type=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, resource_type=None, id=None)
- Keyword Arguments
name (str) – The resource name.
resource_type (str) – Type of the object (e.g. remote-arrays)
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'resource_type': 'resource_type'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.fleetmemberpost_members module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.fleetmemberpost_members.FleetmemberpostMembers(member=None, key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(member=None, key=None)
- Keyword Arguments
member (FleetmemberpostMember) –
key (str) – Provide the fleet key generated from any array in the fleet.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'key': 'key', 'member': 'member'}
- keys()
- required_args = {}
- swagger_types = {'key': 'str', 'member': 'FleetmemberpostMember'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.hardware module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.hardware.Hardware(name=None, identify_enabled=None, serial=None, temperature=None, index=None, details=None, model=None, slot=None, type=None, speed=None, status=None, voltage=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, identify_enabled=None, serial=None, temperature=None, index=None, details=None, model=None, slot=None, type=None, speed=None, status=None, voltage=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
identify_enabled (bool) – If true, the ID LED is lit to visually identify the component.
serial (str) – Serial number of the hardware component.
temperature (int) – Temperature (in degrees Celsius) reported by the component.
index (int) – Number that identifies the relative position of a hardware component within the array.
details (str) – Details about the status of the component if not healthy.
model (str) – Model number of the hardware component.
slot (int) – Slot number occupied by the PCI Express card that hosts the component.
type (str) – Type of hardware component. Values include bay, ct, ch, eth, fan, fb, fc, fm, ib, iom, nvb, pwr, sas, sh, and tmp.
speed (int) – Speed (in bytes per second) at which the component is operating.
status (str) – Component status. Values include critical, healthy, identifying, unhealthy, unknown, and unused.
voltage (int) – Voltage (in Volts) reported by the component.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'identify_enabled': 'identify_enabled', 'index': 'index', 'model': 'model', 'name': 'name', 'serial': 'serial', 'slot': 'slot', 'speed': 'speed', 'status': 'status', 'temperature': 'temperature', 'type': 'type', 'voltage': 'voltage'}
- keys()
- required_args = {}
- swagger_types = {'details': 'str', 'identify_enabled': 'bool', 'index': 'int', 'model': 'str', 'name': 'str', 'serial': 'str', 'slot': 'int', 'speed': 'int', 'status': 'str', 'temperature': 'int', 'type': 'str', 'voltage': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.hardware_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.hardware_get_response.HardwareGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Hardware]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Hardware]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.hardware_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.hardware_patch.HardwarePatch(name=None, identify_enabled=None, index=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, identify_enabled=None, index=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
identify_enabled (bool) – State of an LED used to visually identify the component.
index (int) – Number that identifies the relative position of a hardware component within the array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'identify_enabled': 'identify_enabled', 'index': 'index', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'identify_enabled': 'bool', 'index': 'int', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.hardware_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.hardware_response.HardwareResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Hardware]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host.Host(name=None, context=None, space=None, time_remaining=None, host_group=None, destroyed=None, port_connectivity=None, wwns=None, personality=None, vlan=None, connection_count=None, chap=None, nqns=None, iqns=None, is_local=None, preferred_arrays=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, context=None, space=None, time_remaining=None, host_group=None, destroyed=None, port_connectivity=None, wwns=None, personality=None, vlan=None, connection_count=None, chap=None, nqns=None, iqns=None, is_local=None, preferred_arrays=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
space (Space) – Displays provisioned (virtual) size and physical storage consumption information for the sum of all volumes connected to the specified host.
time_remaining (int) – The amount of time left until the destroyed host is permanently eradicated, measured in milliseconds.
host_group (ReferenceNoId) – The host group to which the host should be associated.
destroyed (bool) – Returns a value of true if the host has been destroyed with its container realm and is pending eradication. The time_remaining value displays the amount of time left until the destroyed host is permanently eradicated. Before the time_remaining period has elapsed, the destroyed host will be recovered if its container realm is recovered. Once the time_remaining period has elapsed, the host is permanently eradicated and can no longer be recovered.
port_connectivity (HostPortConnectivity) –
wwns (list[str]) – The Fibre Channel World Wide Name (WWN) associated with the host.
personality (str) – Determines how the system tunes the array to ensure that it works optimally with the host. Set personality to the name of the host operating system or virtual memory system. Valid values are aix, esxi, hitachi-vsp, hpux, oracle-vm-server, solaris, and vms. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.
vlan (str) – The VLAN ID that the host is associated with. If set to any, the host can access any VLAN. If set to untagged, the host can only access untagged VLANs. If set to a number between 1 and 4094, the host can only access the specified VLAN with that number.
connection_count (int) – The number of volumes connected to the specified host.
chap (Chap) –
nqns (list[str]) – The NVMe Qualified Name (NQN) associated with the host.
iqns (list[str]) – The iSCSI qualified name (IQN) associated with the host.
is_local (bool) – If set to true, the location reference is to the local array. If set to false, the location reference is to a remote location, such as a remote array or offload target.
preferred_arrays (list[Reference]) – For synchronous replication configurations, sets a host’s preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, preferred_arrays cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'chap': 'chap', 'connection_count': 'connection_count', 'context': 'context', 'destroyed': 'destroyed', 'host_group': 'host_group', 'iqns': 'iqns', 'is_local': 'is_local', 'name': 'name', 'nqns': 'nqns', 'personality': 'personality', 'port_connectivity': 'port_connectivity', 'preferred_arrays': 'preferred_arrays', 'space': 'space', 'time_remaining': 'time_remaining', 'vlan': 'vlan', 'wwns': 'wwns'}
- keys()
- required_args = {}
- swagger_types = {'chap': 'Chap', 'connection_count': 'int', 'context': 'FixedReference', 'destroyed': 'bool', 'host_group': 'ReferenceNoId', 'iqns': 'list[str]', 'is_local': 'bool', 'name': 'str', 'nqns': 'list[str]', 'personality': 'str', 'port_connectivity': 'HostPortConnectivity', 'preferred_arrays': 'list[Reference]', 'space': 'Space', 'time_remaining': 'int', 'vlan': 'str', 'wwns': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_get_response.HostGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Host]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Host]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_group module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_group.HostGroup(name=None, context=None, time_remaining=None, destroyed=None, connection_count=None, host_count=None, is_local=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, context=None, time_remaining=None, destroyed=None, connection_count=None, host_count=None, is_local=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left until the destroyed host group is permanently eradicated, measured in milliseconds.
destroyed (bool) – Returns a value of true if the host group has been destroyed with its container realm and is pending eradication. The time_remaining value displays the amount of time left until the destroyed host group is permanently eradicated. Before the time_remaining period has elapsed, the destroyed host group will be recovered if its container realm is recovered. Once the time_remaining period has elapsed, the host group is permanently eradicated and can no longer be recovered.
connection_count (int) – The number of volumes connected to the host group.
host_count (int) – The number of hosts in the host group.
is_local (bool) – Returns a value of true if the host or host group belongs to the current array. Returns a value of false if the host or host group belongs to a remote array.
space (Space) – Displays provisioned (virtual) size and physical storage consumption information for the sum of all volumes connected to the specified host.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'connection_count': 'connection_count', 'context': 'context', 'destroyed': 'destroyed', 'host_count': 'host_count', 'is_local': 'is_local', 'name': 'name', 'space': 'space', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'connection_count': 'int', 'context': 'FixedReference', 'destroyed': 'bool', 'host_count': 'int', 'is_local': 'bool', 'name': 'str', 'space': 'Space', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_group_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_group_get_response.HostGroupGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[HostGroup]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[HostGroup]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_group_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_group_patch.HostGroupPatch(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – The new name for the resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_group_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_group_post.HostGroupPost(tags=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(tags=None)
- Keyword Arguments
tags (list[NonCopyableTag]) – The list of tags to be upserted with the object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'tags': 'tags'}
- keys()
- required_args = {}
- swagger_types = {'tags': 'list[NonCopyableTag]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_group_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_group_response.HostGroupResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[HostGroup]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[HostGroup]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_patch.HostPatch(name=None, remove_wwns=None, host_group=None, add_nqns=None, wwns=None, remove_iqns=None, personality=None, vlan=None, add_iqns=None, chap=None, add_wwns=None, nqns=None, iqns=None, preferred_arrays=None, remove_nqns=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, remove_wwns=None, host_group=None, add_nqns=None, wwns=None, remove_iqns=None, personality=None, vlan=None, add_iqns=None, chap=None, add_wwns=None, nqns=None, iqns=None, preferred_arrays=None, remove_nqns=None)
- Keyword Arguments
name (str) – The new name for the resource.
remove_wwns (list[str]) – Disassociates the specified Fibre Channel World Wide Names (WWNs) from the specified host.
host_group (ReferenceNoId) – The host group to which the host should be associated.
add_nqns (list[str]) – Adds the specified NVMe Qualified Names (NQNs) to those already associated with the specified host.
wwns (list[str]) – The Fibre Channel World Wide Name (WWN) associated with the host.
remove_iqns (list[str]) – Disassociates the specified iSCSI Qualified Names (IQNs) from the specified host.
personality (str) – Determines how the system tunes the array to ensure that it works optimally with the host. Set personality to the name of the host operating system or virtual memory system. Valid values are aix, esxi, hitachi-vsp, hpux, oracle-vm-server, solaris, and vms. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.
vlan (str) – The VLAN ID that the host is associated with. If not set, there is no change in VLAN. If set to any, the host can access any VLAN. If set to untagged, the host can only access untagged VLANs. If set to a number between 1 and 4094, the host can only access the specified VLAN with that number.
add_iqns (list[str]) – Adds the specified iSCSI Qualified Names (IQNs) to those already associated with the specified host.
chap (Chap) –
add_wwns (list[str]) – Adds the specified Fibre Channel World Wide Names (WWNs) to those already associated with the specified host.
nqns (list[str]) – The NVMe Qualified Name (NQN) associated with the host.
iqns (list[str]) – The iSCSI qualified name (IQN) associated with the host.
preferred_arrays (list[Reference]) – For synchronous replication configurations, sets a host’s preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, preferred_arrays cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.
remove_nqns (list[str]) – Disassociates the specified NVMe Qualified Names (NQNs) from the specified host.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'add_iqns': 'add_iqns', 'add_nqns': 'add_nqns', 'add_wwns': 'add_wwns', 'chap': 'chap', 'host_group': 'host_group', 'iqns': 'iqns', 'name': 'name', 'nqns': 'nqns', 'personality': 'personality', 'preferred_arrays': 'preferred_arrays', 'remove_iqns': 'remove_iqns', 'remove_nqns': 'remove_nqns', 'remove_wwns': 'remove_wwns', 'vlan': 'vlan', 'wwns': 'wwns'}
- keys()
- required_args = {}
- swagger_types = {'add_iqns': 'list[str]', 'add_nqns': 'list[str]', 'add_wwns': 'list[str]', 'chap': 'Chap', 'host_group': 'ReferenceNoId', 'iqns': 'list[str]', 'name': 'str', 'nqns': 'list[str]', 'personality': 'str', 'preferred_arrays': 'list[Reference]', 'remove_iqns': 'list[str]', 'remove_nqns': 'list[str]', 'remove_wwns': 'list[str]', 'vlan': 'str', 'wwns': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_performance_balance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_performance_balance.HostPerformanceBalance(name=None, context=None, op_count=None, initiator=None, time=None, fraction_relative_to_max=None, target=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, context=None, op_count=None, initiator=None, time=None, fraction_relative_to_max=None, target=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
op_count (int) – Count of I/O operations for the host path, over the specified resolution.
initiator (PortCommon) –
time (int) – Sample time in milliseconds since UNIX epoch.
fraction_relative_to_max (float) – The path with the highest number of operation counts is displayed with a fraction_relative_to_max of 1.0. The fraction values of all other paths in the host are then calculated relative to the path with the highest number of operation counts.
target (PortInitiatorTarget) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'fraction_relative_to_max': 'fraction_relative_to_max', 'initiator': 'initiator', 'name': 'name', 'op_count': 'op_count', 'target': 'target', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'fraction_relative_to_max': 'float', 'initiator': 'PortCommon', 'name': 'str', 'op_count': 'int', 'target': 'PortInitiatorTarget', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_performance_balance_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_performance_balance_get_response.HostPerformanceBalanceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[HostPerformanceBalance]) – A list of entries indicating count and percentage of I/O operations across various data paths between the host and the array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[HostPerformanceBalance]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_port_connectivity module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_port_connectivity.HostPortConnectivity(details=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(details=None, status=None)
- Keyword Arguments
details (str) – The host connection status. Values include Redundant, N/A, Redundant-Failover, Uneven, Unused Port, Single Controller, Single Controller-Failover, and None.
status (str) – The host connection health status. Values include healthy, unhealthy, and critical.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'details': 'str', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_post.HostPost(wwns=None, personality=None, vlan=None, chap=None, nqns=None, iqns=None, preferred_arrays=None, tags=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(wwns=None, personality=None, vlan=None, chap=None, nqns=None, iqns=None, preferred_arrays=None, tags=None)
- Keyword Arguments
wwns (list[str]) – The Fibre Channel World Wide Name (WWN) associated with the host.
personality (str) – Determines how the system tunes the array to ensure that it works optimally with the host. Set personality to the name of the host operating system or virtual memory system. Valid values are aix, esxi, hitachi-vsp, hpux, oracle-vm-server, solaris, and vms. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.
vlan (str) – The VLAN ID that the host is associated with. If not set or set to any, the host can access any VLAN. If set to untagged, the host can only access untagged VLANs. If set to a number between 1 and 4094, the host can only access the specified VLAN with that number.
chap (Chap) –
nqns (list[str]) – The NVMe Qualified Name (NQN) associated with the host.
iqns (list[str]) – The iSCSI qualified name (IQN) associated with the host.
preferred_arrays (list[Reference]) – For synchronous replication configurations, sets a host’s preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, preferred_arrays cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.
tags (list[NonCopyableTag]) – The list of tags to be upserted with the object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'chap': 'chap', 'iqns': 'iqns', 'nqns': 'nqns', 'personality': 'personality', 'preferred_arrays': 'preferred_arrays', 'tags': 'tags', 'vlan': 'vlan', 'wwns': 'wwns'}
- keys()
- required_args = {}
- swagger_types = {'chap': 'Chap', 'iqns': 'list[str]', 'nqns': 'list[str]', 'personality': 'str', 'preferred_arrays': 'list[Reference]', 'tags': 'list[NonCopyableTag]', 'vlan': 'str', 'wwns': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.host_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.host_response.HostResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Host]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Host]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.inline_response400 module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.inline_response400.InlineResponse400(error_description=None, error=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(error_description=None, error=None)
- Keyword Arguments
error_description (str) –
error (str) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'error': 'error', 'error_description': 'error_description'}
- keys()
- required_args = {}
- swagger_types = {'error': 'str', 'error_description': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.inline_response401 module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.inline_response401.InlineResponse401(error_description=None, error=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(error_description=None, error=None)
- Keyword Arguments
error_description (str) –
error (str) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'error': 'error', 'error_description': 'error_description'}
- keys()
- required_args = {}
- swagger_types = {'error': 'str', 'error_description': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.kmip module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.kmip.Kmip(ca_certificate=None, uris=None, certificate=None, name=None, kmip_objects=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(ca_certificate=None, uris=None, certificate=None, name=None, kmip_objects=None)
- Keyword Arguments
ca_certificate (str) – CA certificate text for the KMIP server.
uris (list[str]) – List of URIs for the configured KMIP servers.
certificate (KmipCertificate) – The certificate used to verify FlashArray authenticity to the KMIP servers.
name (str) – A locally unique, system-generated name. The name cannot be modified.
kmip_objects (list[KmipObject]) – List of the name and UID of the KMIP objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ca_certificate': 'ca_certificate', 'certificate': 'certificate', 'kmip_objects': 'kmip_objects', 'name': 'name', 'uris': 'uris'}
- keys()
- required_args = {}
- swagger_types = {'ca_certificate': 'str', 'certificate': 'KmipCertificate', 'kmip_objects': 'list[KmipObject]', 'name': 'str', 'uris': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.kmip_certificate module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.kmip_certificate.KmipCertificate(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.kmip_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.kmip_get_response.KmipGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Kmip]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Kmip]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.kmip_object module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.kmip_object.KmipObject(uid=None, name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(uid=None, name=None)
- Keyword Arguments
uid (str) – User ID of the KMIP object.
name (str) – Name of the KMIP object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'uid': 'uid'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str', 'uid': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.kmip_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.kmip_patch.KmipPatch(ca_certificate=None, uris=None, certificate=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(ca_certificate=None, uris=None, certificate=None)
- Keyword Arguments
ca_certificate (str) – The text of the CA certificate for the KMIP server.
uris (list[str]) – List of URIs for the configured KMIP servers.
certificate (ReferenceNoId) – The certificate used to verify FlashArray authenticity to the KMIP servers.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ca_certificate': 'ca_certificate', 'certificate': 'certificate', 'uris': 'uris'}
- keys()
- required_args = {}
- swagger_types = {'ca_certificate': 'str', 'certificate': 'ReferenceNoId', 'uris': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.kmip_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.kmip_post.KmipPost(ca_certificate=None, uris=None, certificate=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(ca_certificate=None, uris=None, certificate=None)
- Keyword Arguments
ca_certificate (str) – The text of the CA certificate for the KMIP server.
uris (list[str]) – List of URIs for the configured KMIP servers.
certificate (ReferenceNoId) – The certificate used to verify FlashArray authenticity to the KMIP servers.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ca_certificate': 'ca_certificate', 'certificate': 'certificate', 'uris': 'uris'}
- keys()
- required_args = {}
- swagger_types = {'ca_certificate': 'str', 'certificate': 'ReferenceNoId', 'uris': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.kmip_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.kmip_response.KmipResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Kmip]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.kmip_test_result module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.kmip_test_result.KmipTestResult(success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None)
- Keyword Arguments
success (bool) – Expresses whether communication between the FlashArray and the KMIP server succeeded or not.
component_name (str) – Name of the component running the test.
destination (str) – The URI of the target server being tested.
description (str) – Description of what is being tested.
component_address (str) – Address of the component running the test.
enabled (bool) – Expresses whether the service is enabled or not.
result_details (str) – Additional information about the test result.
test_type (str) – Description of what is being tested.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'component_address': 'component_address', 'component_name': 'component_name', 'description': 'description', 'destination': 'destination', 'enabled': 'enabled', 'result_details': 'result_details', 'success': 'success', 'test_type': 'test_type'}
- keys()
- required_args = {}
- swagger_types = {'component_address': 'str', 'component_name': 'str', 'description': 'str', 'destination': 'str', 'enabled': 'bool', 'result_details': 'str', 'success': 'bool', 'test_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.kmip_test_result_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.kmip_test_result_get_response.KmipTestResultGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[KmipTestResult]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[KmipTestResult]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.limited_by module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.limited_by.LimitedBy(member=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(member=None, policy=None)
- Keyword Arguments
member (FixedReferenceWithType) – Reference to the resource to which the effective quota policy is attached.
policy (FixedReferenceWithType) – Reference to the effective quota policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'member': 'member', 'policy': 'policy'}
- keys()
- required_args = {}
- swagger_types = {'member': 'FixedReferenceWithType', 'policy': 'FixedReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_group module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_group.LocalGroup(gid=None, built_in=None, name=None, email=None, sid=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(gid=None, built_in=None, name=None, email=None, sid=None)
- Keyword Arguments
gid (int) – The POSIX user ID of this object (group ID).
built_in (bool) – Returns a value of true if the local group is built in. Returns a value of false if the group has been created manually.
name (str) – The local group name.
email (str) – The email address of the local group.
sid (str) – The SID (security ID) of the local group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'built_in': 'built_in', 'email': 'email', 'gid': 'gid', 'name': 'name', 'sid': 'sid'}
- keys()
- required_args = {}
- swagger_types = {'built_in': 'bool', 'email': 'str', 'gid': 'int', 'name': 'str', 'sid': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_group_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_group_get_response.LocalGroupGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[LocalGroup]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[LocalGroup]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_group_membership_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_group_membership_post.LocalGroupMembershipPost(members=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(members=None)
- Keyword Arguments
members (list[LocalgroupmembershippostMembers]) – A list of resources to be a member of the group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'members': 'members'}
- keys()
- required_args = {}
- swagger_types = {'members': 'list[LocalgroupmembershippostMembers]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_group_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_group_post.LocalGroupPost(gid=None, email=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(gid=None, email=None)
- Keyword Arguments
gid (int) – Optional field to set the GID of the local group.
email (str) – Optional field to set the email address of the local group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'email': 'email', 'gid': 'gid'}
- keys()
- required_args = {}
- swagger_types = {'email': 'str', 'gid': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_group_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_group_response.LocalGroupResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[LocalGroup]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[LocalGroup]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_member module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_member.LocalMember(member_id=None, group_gid=None, member=None, is_primary_group=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(member_id=None, group_gid=None, member=None, is_primary_group=None, group=None)
- Keyword Arguments
member_id (int) – GID if the member_type is Group and UID if the member_type is User.
group_gid (int) – GID of the group to which the member belongs.
member (FixedReferenceWithType) – Reference to the member of the group.
is_primary_group (bool) – When a membership of member_type has the value User, this specifies whether this membership is a primary-group mapping or not. In any other case, this field will be false.
group (FixedReferenceWithType) – Reference to the group to which the member belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'group': 'group', 'group_gid': 'group_gid', 'is_primary_group': 'is_primary_group', 'member': 'member', 'member_id': 'member_id'}
- keys()
- required_args = {}
- swagger_types = {'group': 'FixedReferenceWithType', 'group_gid': 'int', 'is_primary_group': 'bool', 'member': 'FixedReferenceWithType', 'member_id': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_membership_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_membership_get_response.LocalMembershipGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[LocalMember]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[LocalMember]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_membership_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_membership_response.LocalMembershipResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[LocalMember]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[LocalMember]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_user module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_user.LocalUser(uid=None, primary_group=None, built_in=None, name=None, email=None, enabled=None, sid=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(uid=None, primary_group=None, built_in=None, name=None, email=None, enabled=None, sid=None)
- Keyword Arguments
uid (int) – The POSIX user ID of this object (user ID).
primary_group (ReferenceWithType) – Primary group of the local user.
built_in (bool) – Returns a value of true if the local user is built in. Otherwise returns a value of false if the user has been created manually.
name (str) – The name of the local user.
email (str) – The email address of the local user.
enabled (bool) – Returns a value of true if the local user is enabled.
sid (str) – The SID (security ID) of the local user.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'built_in': 'built_in', 'email': 'email', 'enabled': 'enabled', 'name': 'name', 'primary_group': 'primary_group', 'sid': 'sid', 'uid': 'uid'}
- keys()
- required_args = {}
- swagger_types = {'built_in': 'bool', 'email': 'str', 'enabled': 'bool', 'name': 'str', 'primary_group': 'ReferenceWithType', 'sid': 'str', 'uid': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_user_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_user_get_response.LocalUserGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[LocalUser]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[LocalUser]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_user_membership_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_user_membership_post.LocalUserMembershipPost(is_primary=None, groups=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(is_primary=None, groups=None)
- Keyword Arguments
is_primary (bool) – Determines whether memberships are primary group memberships or not.
groups (list[LocalusermembershippostGroups]) – A list of groups of which the user is a member.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'groups': 'groups', 'is_primary': 'is_primary'}
- keys()
- required_args = {}
- swagger_types = {'groups': 'list[LocalusermembershippostGroups]', 'is_primary': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_user_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_user_patch.LocalUserPatch(uid=None, password=None, primary_group=None, name=None, email=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(uid=None, password=None, primary_group=None, name=None, email=None, enabled=None)
- Keyword Arguments
uid (int) – Optional field to set the UID of the local user.
password (str) – The password of the local user. This field is only required if the enabled field is true.
primary_group (ReferenceWithType) – Local group that would be assigned as the primary group of the local user.
name (str) – The local user name.
email (str) – Optional field to set the email of the local user.
enabled (bool) – If this field is false, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional from the beginning.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'email': 'email', 'enabled': 'enabled', 'name': 'name', 'password': 'password', 'primary_group': 'primary_group', 'uid': 'uid'}
- keys()
- required_args = {}
- swagger_types = {'email': 'str', 'enabled': 'bool', 'name': 'str', 'password': 'str', 'primary_group': 'ReferenceWithType', 'uid': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_user_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_user_post.LocalUserPost(uid=None, password=None, primary_group=None, email=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(uid=None, password=None, primary_group=None, email=None, enabled=None)
- Keyword Arguments
uid (int) – Optional field to set the UID of the local user.
password (str) – The password of the local user. This field is only required if the enabled field is true.
primary_group (ReferenceWithType) – Local group that would be assigned as the primary group of the local user.
email (str) – Optional field to set the email of the local user.
enabled (bool) – If this field is false, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'email': 'email', 'enabled': 'enabled', 'password': 'password', 'primary_group': 'primary_group', 'uid': 'uid'}
- keys()
- required_args = {}
- swagger_types = {'email': 'str', 'enabled': 'bool', 'password': 'str', 'primary_group': 'ReferenceWithType', 'uid': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.local_user_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.local_user_response.LocalUserResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[LocalUser]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[LocalUser]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.localgroupmembershippost_members module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.localgroupmembershippost_members.LocalgroupmembershippostMembers(member_id=None, member=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(member_id=None, member=None)
- Keyword Arguments
member_id (int) – The member ID that should be mapped.
member (ReferenceWithType) – Reference to the resource that will be a member of the group. The id or name parameter is required, but cannot be set together.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'member': 'member', 'member_id': 'member_id'}
- keys()
- required_args = {}
- swagger_types = {'member': 'ReferenceWithType', 'member_id': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.localusermembershippost_groups module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.localusermembershippost_groups.LocalusermembershippostGroups(group_gid=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(group_gid=None, group=None)
- Keyword Arguments
group_gid (int) – The group GID that should be mapped.
group (ReferenceWithType) – Reference to a group of which the user is a member. The id or name parameter is required, but cannot be set together.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'group': 'group', 'group_gid': 'group_gid'}
- keys()
- required_args = {}
- swagger_types = {'group': 'ReferenceWithType', 'group_gid': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.location_reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.location_reference.LocationReference(name=None, id=None, is_local=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, is_local=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
is_local (bool) – If set to true, the location reference is to the local array. If set to false, the location reference is to a remote location, such as a remote array or offload target.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'is_local': 'is_local', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'is_local': 'bool', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.log_target module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.log_target.LogTarget(name=None, context=None, target_type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, context=None, target_type=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and cannot be changed.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
target_type (str) – The type of log target. Valid values include file, and syslog.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'name': 'name', 'target_type': 'target_type'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'name': 'str', 'target_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.log_target_file module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.log_target_file.LogTargetFile(name=None, context=None, target_type=None, keep_for=None, directory=None, keep_size=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, context=None, target_type=None, keep_for=None, directory=None, keep_size=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and cannot be changed.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
target_type (str) – The type of log target. Valid values include file, and syslog.
keep_for (int) – Specifies the period that audit logs are retained before they are deleted, in milliseconds. Default value is null which means size based retention does not apply. Use 0 to reset the value to null. At least one of the keep_for or keep_size parameters is required, and they can be set together.
directory (ReferenceWithType) – Directory name to be used as log target.
keep_size (int) – Specifies the maximum size of audit logs to be retained. Measured in bytes. When exceeded, older logs will be deleted. Default value is null which means size-based retention does not apply. Use 0 to reset the value to null.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'directory': 'directory', 'keep_for': 'keep_for', 'keep_size': 'keep_size', 'name': 'name', 'target_type': 'target_type'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'directory': 'ReferenceWithType', 'keep_for': 'int', 'keep_size': 'int', 'name': 'str', 'target_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.log_target_file_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.log_target_file_get_response.LogTargetFileGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[LogTargetFile]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[LogTargetFile]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.log_target_file_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.log_target_file_response.LogTargetFileResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[LogTargetFile]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[LogTargetFile]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.log_targets_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.log_targets_get_response.LogTargetsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[LogTarget]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[LogTarget]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.log_targets_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.log_targets_response.LogTargetsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[LogTarget]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.maintenance_window module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.maintenance_window.MaintenanceWindow(name=None, expires=None, created=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, expires=None, created=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
expires (int) – The maintenance window end time, measured in milliseconds since the UNIX epoch.
created (int) – The maintenance window start time, measured in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'expires': 'expires', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'created': 'int', 'expires': 'int', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.maintenance_window_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.maintenance_window_post.MaintenanceWindowPost(timeout=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(timeout=None)
- Keyword Arguments
timeout (int) – The specified length of time that alerts are suppressed during a maintenance window, measured in milliseconds. The maintenance window timeout value must be between 60000 (1 minute) and 86400000 (24 hours). The value entered is rounded down to the nearest minute. The names and timeout parameters must be set together, and the names parameter must be set to environment.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'timeout': 'timeout'}
- keys()
- required_args = {}
- swagger_types = {'timeout': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.maintenance_windows_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.maintenance_windows_get_response.MaintenanceWindowsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[MaintenanceWindow]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[MaintenanceWindow]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.maintenance_windows_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.maintenance_windows_response.MaintenanceWindowsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[MaintenanceWindow]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[MaintenanceWindow]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.mapping_policy module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.mapping_policy.MappingPolicy(id=None, context=None, mapping=None, policy_type=None, remote_policy=None, local_policy=None, direction=None, pod_replica_link=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(id=None, context=None, mapping=None, policy_type=None, remote_policy=None, local_policy=None, direction=None, pod_replica_link=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
mapping (str) – The mapping for this policy mapping. Valid values are connected and disconnected.
policy_type (str) – The type of policies involved in this policy mapping.
remote_policy (ReferenceWithType) – Reference to a remote policy.
local_policy (ReferenceWithType) – Reference to a local policy.
direction (str) – The direction of replication. Valid values include inbound and outbound.
pod_replica_link (PodReplicaLinkReference) – Reference to a pod replica link.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'direction': 'direction', 'id': 'id', 'local_policy': 'local_policy', 'mapping': 'mapping', 'pod_replica_link': 'pod_replica_link', 'policy_type': 'policy_type', 'remote_policy': 'remote_policy'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'direction': 'str', 'id': 'str', 'local_policy': 'ReferenceWithType', 'mapping': 'str', 'pod_replica_link': 'PodReplicaLinkReference', 'policy_type': 'str', 'remote_policy': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.mapping_policy_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.mapping_policy_patch.MappingPolicyPatch(mapping=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(mapping=None)
- Keyword Arguments
mapping (str) – The mapping to set on this policy mapping. Valid values are connected and disconnected.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'mapping': 'mapping'}
- keys()
- required_args = {}
- swagger_types = {'mapping': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member.Member(context=None, member=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, member=None, group=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
member (Reference) –
group (Reference) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'group': 'group', 'member': 'member'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'group': 'Reference', 'member': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_get_response.MemberGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Member]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Member]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_no_id_all module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_no_id_all.MemberNoIdAll(context=None, member=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, member=None, group=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
member (ReferenceNoId) – The member of the resource.
group (ReferenceNoId) – The resource in which the host, volume, or other item in the environment is a member.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'group': 'group', 'member': 'member'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'group': 'ReferenceNoId', 'member': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_no_id_all_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_no_id_all_get_response.MemberNoIdAllGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[MemberNoIdAll]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[MemberNoIdAll]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_no_id_all_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_no_id_all_response.MemberNoIdAllResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[MemberNoIdAll]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[MemberNoIdAll]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_no_id_group module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_no_id_group.MemberNoIdGroup(member=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(member=None, group=None)
- Keyword Arguments
member (Reference) –
group (ReferenceNoId) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'group': 'group', 'member': 'member'}
- keys()
- required_args = {}
- swagger_types = {'group': 'ReferenceNoId', 'member': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_no_id_member module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_no_id_member.MemberNoIdMember(context=None, member=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, member=None, group=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
member (ReferenceNoId) – The member of the resource.
group (Reference) – The resource in which the host, volume, or other item in the environment is a member.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'group': 'group', 'member': 'member'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'group': 'Reference', 'member': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_no_id_member_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_no_id_member_get_response.MemberNoIdMemberGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[MemberNoIdMember]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[MemberNoIdMember]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_no_id_member_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_no_id_member_response.MemberNoIdMemberResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[MemberNoIdMember]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[MemberNoIdMember]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_response.MemberResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Member]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Member]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.member_with_type module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.member_with_type.MemberWithType(member=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(member=None, group=None)
- Keyword Arguments
member (ReferenceWithType) –
group (ReferenceWithType) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'group': 'group', 'member': 'member'}
- keys()
- required_args = {}
- swagger_types = {'group': 'ReferenceWithType', 'member': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface.NetworkInterface(name=None, eth=None, services=None, interface_type=None, fc=None, enabled=None, speed=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, eth=None, services=None, interface_type=None, fc=None, enabled=None, speed=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
eth (NetworkInterfaceEth) –
services (list[str]) – The services provided by the specified network interface or Fibre Channel port.
interface_type (str) – The interface type. Valid values are eth and fc.
fc (NetworkInterfaceFc) –
enabled (bool) – Returns a value of true if the specified network interface or Fibre Channel port is enabled. Returns a value of false if the specified network interface or Fibre Channel port is disabled.
speed (int) – Configured speed of the specified network interface or Fibre Channel port (in Gb/s). Typically this is the maximum speed of the port or bond represented by the network interface.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'eth': 'eth', 'fc': 'fc', 'interface_type': 'interface_type', 'name': 'name', 'services': 'services', 'speed': 'speed'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'eth': 'NetworkInterfaceEth', 'fc': 'NetworkInterfaceFc', 'interface_type': 'str', 'name': 'str', 'services': 'list[str]', 'speed': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_eth module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_eth.NetworkInterfaceEth(subnet=None, address=None, vlan=None, netmask=None, subtype=None, mac_address=None, subinterfaces=None, gateway=None, mtu=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(subnet=None, address=None, vlan=None, netmask=None, subtype=None, mac_address=None, subinterfaces=None, gateway=None, mtu=None)
- Keyword Arguments
subnet (ReferenceNoId) – Subnet that is associated with the specified network interface.
address (str) – The IPv4 or IPv6 address to be associated with the specified network interface.
vlan (int) – VLAN ID
netmask (str) – Netmask of the specified network interface that, when combined with the address of the interface, determines the network address of the interface.
subtype (str) – The subtype of the specified network interface. Only interfaces of subtype virtual can be created. Configurable on POST only. Valid values are failover_bond, lacp_bond, physical, and virtual.
mac_address (str) – The media access control address associated with the specified network interface.
subinterfaces (list[FixedReferenceNoId]) – List of network interfaces configured to be a subinterface of the specified network interface.
gateway (str) – The IPv4 or IPv6 address of the gateway through which the specified network interface is to communicate with the network.
mtu (int) – Maximum message transfer unit (packet) size for the network interface, in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'address': 'address', 'gateway': 'gateway', 'mac_address': 'mac_address', 'mtu': 'mtu', 'netmask': 'netmask', 'subinterfaces': 'subinterfaces', 'subnet': 'subnet', 'subtype': 'subtype', 'vlan': 'vlan'}
- keys()
- required_args = {}
- swagger_types = {'address': 'str', 'gateway': 'str', 'mac_address': 'str', 'mtu': 'int', 'netmask': 'str', 'subinterfaces': 'list[FixedReferenceNoId]', 'subnet': 'ReferenceNoId', 'subtype': 'str', 'vlan': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_fc module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_fc.NetworkInterfaceFc(wwn=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(wwn=None)
- Keyword Arguments
wwn (str) – World Wide Name of the specified Fibre Channel port.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'wwn': 'wwn'}
- keys()
- required_args = {}
- swagger_types = {'wwn': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_get_response.NetworkInterfaceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[NetworkInterface]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterface]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_neighbor module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_neighbor.NetworkInterfaceNeighbor(initial_ttl_in_sec=None, local_port=None, neighbor_port=None, neighbor_chassis=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(initial_ttl_in_sec=None, local_port=None, neighbor_port=None, neighbor_chassis=None)
- Keyword Arguments
initial_ttl_in_sec (int) – The initial time to live in seconds from when the local port received notice that the neighbor information is regarded as valid. The time is not measured from when this endpoint was queried.
local_port (FixedReferenceNoId) – A reference to the local network interface the neighbor is connected to.
neighbor_port (NetworkInterfaceNeighborNeighborPort) –
neighbor_chassis (NetworkInterfaceNeighborNeighborChassis) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'initial_ttl_in_sec': 'initial_ttl_in_sec', 'local_port': 'local_port', 'neighbor_chassis': 'neighbor_chassis', 'neighbor_port': 'neighbor_port'}
- keys()
- required_args = {}
- swagger_types = {'initial_ttl_in_sec': 'int', 'local_port': 'FixedReferenceNoId', 'neighbor_chassis': 'NetworkInterfaceNeighborNeighborChassis', 'neighbor_port': 'NetworkInterfaceNeighborNeighborPort'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_capability module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_capability.NetworkInterfaceNeighborCapability(enabled=None, supported=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None, supported=None)
- Keyword Arguments
enabled (bool) – If true, this capability is enabled by this neighbor; false otherwise.
supported (bool) – If true, this capability is supported by this neighbor; false otherwise.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'supported': 'supported'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'supported': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_get_response.NetworkInterfaceNeighborGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[NetworkInterfaceNeighbor]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterfaceNeighbor]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_neighbor_chassis module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_neighbor_chassis.NetworkInterfaceNeighborNeighborChassis(station_only=None, addresses=None, router=None, wlan_access_point=None, name=None, description=None, telephone=None, bridge=None, id=None, docsis_cable_device=None, repeater=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(station_only=None, addresses=None, router=None, wlan_access_point=None, name=None, description=None, telephone=None, bridge=None, id=None, docsis_cable_device=None, repeater=None)
- Keyword Arguments
station_only (NetworkInterfaceNeighborCapability) – Station only status of the neighbor system.
addresses (list[str]) – Management IP addresses of the neighbor.
router (NetworkInterfaceNeighborCapability) – IP router capability of the neighbor system.
wlan_access_point (NetworkInterfaceNeighborCapability) – WLAN access point capability of the neighbor system.
name (str) – Administratively assigned name of the neighbour.
description (str) – The textual description of the neighbor. The description may include the full name and version identification of the system hardware type, software operating system, and networking software.
telephone (NetworkInterfaceNeighborCapability) – Telephone capability of the neighbor system.
bridge (NetworkInterfaceNeighborCapability) – Bridge capability of the neighbor system.
docsis_cable_device (NetworkInterfaceNeighborCapability) – DOCSIS cable device capability of the neighbor system.
repeater (NetworkInterfaceNeighborCapability) – Neighbor system’s repeater capability.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'addresses': 'addresses', 'bridge': 'bridge', 'description': 'description', 'docsis_cable_device': 'docsis_cable_device', 'id': 'id', 'name': 'name', 'repeater': 'repeater', 'router': 'router', 'station_only': 'station_only', 'telephone': 'telephone', 'wlan_access_point': 'wlan_access_point'}
- keys()
- required_args = {}
- swagger_types = {'addresses': 'list[str]', 'bridge': 'NetworkInterfaceNeighborCapability', 'description': 'str', 'docsis_cable_device': 'NetworkInterfaceNeighborCapability', 'id': 'NetworkInterfaceNeighborNeighborChassisId', 'name': 'str', 'repeater': 'NetworkInterfaceNeighborCapability', 'router': 'NetworkInterfaceNeighborCapability', 'station_only': 'NetworkInterfaceNeighborCapability', 'telephone': 'NetworkInterfaceNeighborCapability', 'wlan_access_point': 'NetworkInterfaceNeighborCapability'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_neighbor_chassis_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_neighbor_chassis_id.NetworkInterfaceNeighborNeighborChassisId(type=None, value=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(type=None, value=None)
- Keyword Arguments
type (str) – The chassis ID subtype. Valid values are ifname, ifalias, local, mac, ip, and unhandled.
value (str) – The specific identifier for the particular chassis.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'type': 'type', 'value': 'value'}
- keys()
- required_args = {}
- swagger_types = {'type': 'str', 'value': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_neighbor_port module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_neighbor_port.NetworkInterfaceNeighborNeighborPort(description=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(description=None, id=None)
- Keyword Arguments
description (str) – A description of the neighbor port.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'description': 'description', 'id': 'id'}
- keys()
- required_args = {}
- swagger_types = {'description': 'str', 'id': 'NetworkInterfaceNeighborNeighborPortId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_neighbor_port_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_neighbor_port_id.NetworkInterfaceNeighborNeighborPortId(type=None, value=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(type=None, value=None)
- Keyword Arguments
type (str) – The port ID subtype. Valid values are ifname, ifalias, local, mac, ip, and unhandled.
value (str) – The specific identifier for the particular port.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'type': 'type', 'value': 'value'}
- keys()
- required_args = {}
- swagger_types = {'type': 'str', 'value': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_neighbor_response.NetworkInterfaceNeighborResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[NetworkInterfaceNeighbor]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[NetworkInterfaceNeighbor]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_patch.NetworkInterfacePatch(eth=None, override_npiv_check=None, services=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(eth=None, override_npiv_check=None, services=None, enabled=None)
- Keyword Arguments
eth (NetworkinterfacepatchEth) –
override_npiv_check (bool) – N-Port ID Virtualization (NPIV) requires a balanced configuration of Fibre Channel ports configured for SCSI on both controllers. Enabling or Disabling a Fibre Channel port configured for SCSI might cause the NPIV status to change from enabled to disabled or vice versa. Set this option to proceed with enabling or disabling the port.
services (list[str]) – The services provided by the specified network interface or Fibre Channel port.
enabled (bool) – Returns a value of true if the specified network interface or Fibre Channel port is enabled. Returns a value of false if the specified network interface or Fibre Channel port is disabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'eth': 'eth', 'override_npiv_check': 'override_npiv_check', 'services': 'services'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'eth': 'NetworkinterfacepatchEth', 'override_npiv_check': 'bool', 'services': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_performance.NetworkInterfacePerformance(name=None, eth=None, time=None, interface_type=None, fc=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, eth=None, time=None, interface_type=None, fc=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
eth (NetworkInterfacePerformanceEth) –
time (int) – Sample time in milliseconds since UNIX epoch.
interface_type (str) – The interface type. Valid values are eth and fc.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'eth': 'eth', 'fc': 'fc', 'interface_type': 'interface_type', 'name': 'name', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'eth': 'NetworkInterfacePerformanceEth', 'fc': 'NetworkInterfacePerformanceFc', 'interface_type': 'str', 'name': 'str', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_performance_eth module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_performance_eth.NetworkInterfacePerformanceEth(flow_control_transmitted_lossless_bytes_per_sec=None, transmitted_dropped_errors_per_sec=None, rdma_received_sequence_errors_per_sec=None, transmitted_carrier_errors_per_sec=None, flow_control_transmitted_pause_frames_per_sec=None, received_bytes_per_sec=None, flow_control_transmitted_congestion_packets_per_sec=None, rdma_transmitted_local_ack_timeout_errors_per_sec=None, flow_control_received_discarded_packets_per_sec=None, received_packets_per_sec=None, flow_control_received_lossless_bytes_per_sec=None, flow_control_received_pause_frames_per_sec=None, received_crc_errors_per_sec=None, rdma_received_req_cqe_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_bytes_per_sec=None, flow_control_received_congestion_packets_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, total_errors_per_sec=None, flow_control_transmitted_discarded_packets_per_sec=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(flow_control_transmitted_lossless_bytes_per_sec=None, transmitted_dropped_errors_per_sec=None, rdma_received_sequence_errors_per_sec=None, transmitted_carrier_errors_per_sec=None, flow_control_transmitted_pause_frames_per_sec=None, received_bytes_per_sec=None, flow_control_transmitted_congestion_packets_per_sec=None, rdma_transmitted_local_ack_timeout_errors_per_sec=None, flow_control_received_discarded_packets_per_sec=None, received_packets_per_sec=None, flow_control_received_lossless_bytes_per_sec=None, flow_control_received_pause_frames_per_sec=None, received_crc_errors_per_sec=None, rdma_received_req_cqe_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_bytes_per_sec=None, flow_control_received_congestion_packets_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, total_errors_per_sec=None, flow_control_transmitted_discarded_packets_per_sec=None)
- Keyword Arguments
flow_control_transmitted_lossless_bytes_per_sec (int) – Bytes transmitted per second with lossless flow control settings.
transmitted_dropped_errors_per_sec (int) – Transmitted packets dropped per second.
rdma_received_sequence_errors_per_sec (int) – The number of received RDMA packet sequence errors per second.
transmitted_carrier_errors_per_sec (int) – Transmission carrier errors per second.
flow_control_transmitted_pause_frames_per_sec (int) – Transmitted pause frames per second.
received_bytes_per_sec (int) – Bytes received per second.
flow_control_transmitted_congestion_packets_per_sec (int) – Number of congestion control packets transmitted per second.
rdma_transmitted_local_ack_timeout_errors_per_sec (int) – The number of times RDMA ack timer expired for QPs per second.
flow_control_received_discarded_packets_per_sec (int) – Number of received packets that were physically discarded by the NIC per second due to errors or other reasons.
received_packets_per_sec (int) – Packets received per second.
flow_control_received_lossless_bytes_per_sec (int) – Bytes received per second with lossless flow control settings.
flow_control_received_pause_frames_per_sec (int) – Received pause frames per second.
received_crc_errors_per_sec (int) – Reception CRC errors per second.
rdma_received_req_cqe_errors_per_sec (int) – The number of times port detected RDMA CQEs with error per second.
transmitted_packets_per_sec (int) – Packets transmitted per second.
transmitted_bytes_per_sec (int) – Bytes transmitted per second.
flow_control_received_congestion_packets_per_sec (int) – Number of congestion control packets received per second.
received_frame_errors_per_sec (int) – Received packet frame errors per second.
other_errors_per_sec (int) – This field has been deprecated. Since Purity version 6.6.8, this will always return null. The sum of unspecified reception and transmission errors per second.
total_errors_per_sec (int) – The sum of all reception and transmission errors per second.
flow_control_transmitted_discarded_packets_per_sec (int) – Number of transmitted packets that were physically discarded by the NIC per second due to errors or other reasons.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'flow_control_received_congestion_packets_per_sec': 'flow_control_received_congestion_packets_per_sec', 'flow_control_received_discarded_packets_per_sec': 'flow_control_received_discarded_packets_per_sec', 'flow_control_received_lossless_bytes_per_sec': 'flow_control_received_lossless_bytes_per_sec', 'flow_control_received_pause_frames_per_sec': 'flow_control_received_pause_frames_per_sec', 'flow_control_transmitted_congestion_packets_per_sec': 'flow_control_transmitted_congestion_packets_per_sec', 'flow_control_transmitted_discarded_packets_per_sec': 'flow_control_transmitted_discarded_packets_per_sec', 'flow_control_transmitted_lossless_bytes_per_sec': 'flow_control_transmitted_lossless_bytes_per_sec', 'flow_control_transmitted_pause_frames_per_sec': 'flow_control_transmitted_pause_frames_per_sec', 'other_errors_per_sec': 'other_errors_per_sec', 'rdma_received_req_cqe_errors_per_sec': 'rdma_received_req_cqe_errors_per_sec', 'rdma_received_sequence_errors_per_sec': 'rdma_received_sequence_errors_per_sec', 'rdma_transmitted_local_ack_timeout_errors_per_sec': 'rdma_transmitted_local_ack_timeout_errors_per_sec', 'received_bytes_per_sec': 'received_bytes_per_sec', 'received_crc_errors_per_sec': 'received_crc_errors_per_sec', 'received_frame_errors_per_sec': 'received_frame_errors_per_sec', 'received_packets_per_sec': 'received_packets_per_sec', 'total_errors_per_sec': 'total_errors_per_sec', 'transmitted_bytes_per_sec': 'transmitted_bytes_per_sec', 'transmitted_carrier_errors_per_sec': 'transmitted_carrier_errors_per_sec', 'transmitted_dropped_errors_per_sec': 'transmitted_dropped_errors_per_sec', 'transmitted_packets_per_sec': 'transmitted_packets_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'flow_control_received_congestion_packets_per_sec': 'int', 'flow_control_received_discarded_packets_per_sec': 'int', 'flow_control_received_lossless_bytes_per_sec': 'int', 'flow_control_received_pause_frames_per_sec': 'int', 'flow_control_transmitted_congestion_packets_per_sec': 'int', 'flow_control_transmitted_discarded_packets_per_sec': 'int', 'flow_control_transmitted_lossless_bytes_per_sec': 'int', 'flow_control_transmitted_pause_frames_per_sec': 'int', 'other_errors_per_sec': 'int', 'rdma_received_req_cqe_errors_per_sec': 'int', 'rdma_received_sequence_errors_per_sec': 'int', 'rdma_transmitted_local_ack_timeout_errors_per_sec': 'int', 'received_bytes_per_sec': 'int', 'received_crc_errors_per_sec': 'int', 'received_frame_errors_per_sec': 'int', 'received_packets_per_sec': 'int', 'total_errors_per_sec': 'int', 'transmitted_bytes_per_sec': 'int', 'transmitted_carrier_errors_per_sec': 'int', 'transmitted_dropped_errors_per_sec': 'int', 'transmitted_packets_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_performance_fc module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_performance_fc.NetworkInterfacePerformanceFc(received_crc_errors_per_sec=None, transmitted_frames_per_sec=None, received_link_failures_per_sec=None, transmitted_invalid_words_per_sec=None, received_loss_of_signal_per_sec=None, received_loss_of_sync_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, total_errors_per_sec=None, received_frames_per_sec=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(received_crc_errors_per_sec=None, transmitted_frames_per_sec=None, received_link_failures_per_sec=None, transmitted_invalid_words_per_sec=None, received_loss_of_signal_per_sec=None, received_loss_of_sync_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, total_errors_per_sec=None, received_frames_per_sec=None)
- Keyword Arguments
received_crc_errors_per_sec (int) – Fibre Channel frame CRC errors per second.
transmitted_frames_per_sec (int) – Fibre Channel frames transmitted per second.
received_link_failures_per_sec (int) – Loss of connectivity errors per second.
transmitted_invalid_words_per_sec (int) – Bit errors in transmission word per second.
received_loss_of_signal_per_sec (int) – Loss of signal errors on Fibre Channel port per second.
received_loss_of_sync_per_sec (int) – Loss of sync errors on Fibre Channel port per second.
transmitted_bytes_per_sec (int) – Bytes transmitted per second.
received_bytes_per_sec (int) – Bytes received per second.
total_errors_per_sec (int) – The sum of all reception and transmission errors per second.
received_frames_per_sec (int) – Fibre Channel frames received per second.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'received_bytes_per_sec': 'received_bytes_per_sec', 'received_crc_errors_per_sec': 'received_crc_errors_per_sec', 'received_frames_per_sec': 'received_frames_per_sec', 'received_link_failures_per_sec': 'received_link_failures_per_sec', 'received_loss_of_signal_per_sec': 'received_loss_of_signal_per_sec', 'received_loss_of_sync_per_sec': 'received_loss_of_sync_per_sec', 'total_errors_per_sec': 'total_errors_per_sec', 'transmitted_bytes_per_sec': 'transmitted_bytes_per_sec', 'transmitted_frames_per_sec': 'transmitted_frames_per_sec', 'transmitted_invalid_words_per_sec': 'transmitted_invalid_words_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'received_bytes_per_sec': 'int', 'received_crc_errors_per_sec': 'int', 'received_frames_per_sec': 'int', 'received_link_failures_per_sec': 'int', 'received_loss_of_signal_per_sec': 'int', 'received_loss_of_sync_per_sec': 'int', 'total_errors_per_sec': 'int', 'transmitted_bytes_per_sec': 'int', 'transmitted_frames_per_sec': 'int', 'transmitted_invalid_words_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_performance_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_performance_get_response.NetworkInterfacePerformanceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
total (list[NetworkInterfacePerformance]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful.
items (list[NetworkInterfacePerformance]) – A list of performance objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterfacePerformance]', 'more_items_remaining': 'bool', 'total': 'list[NetworkInterfacePerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_rx_los module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_rx_los.NetworkInterfacePortDetailsRxLos(flag=None, channel=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(flag=None, channel=None)
- Keyword Arguments
flag (bool) – A value of true indicates Rx Loss-of-Signal.
channel (int) – The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'channel': 'channel', 'flag': 'flag'}
- keys()
- required_args = {}
- swagger_types = {'channel': 'int', 'flag': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_rx_power module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_rx_power.NetworkInterfacePortDetailsRxPower(channel=None, measurement=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(channel=None, measurement=None, status=None)
- Keyword Arguments
channel (int) – The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.
measurement (float) – Rx input power in mW.
status (str) – Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Rx input power. Valid values are alarm low, alarm high, warn low, warn high, and ok.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'channel': 'channel', 'measurement': 'measurement', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'channel': 'int', 'measurement': 'float', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static.NetworkInterfacePortDetailsStatic(vendor_serial_number=None, voltage_thresholds=None, signaling_rate=None, fc_link_lengths=None, specifications=None, tx_bias_thresholds=None, tx_power_thresholds=None, fc_speeds=None, link_length=None, cable_technology=None, connector_type=None, signaling_rate_min=None, vendor_part_number=None, temperature_thresholds=None, wavelength=None, identifier=None, fc_technology=None, rx_power_thresholds=None, extended_identifier=None, vendor_name=None, signaling_rate_max=None, vendor_oui=None, encoding=None, vendor_date_code=None, rate_identifier=None, fc_transmission_media=None, vendor_revision=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(vendor_serial_number=None, voltage_thresholds=None, signaling_rate=None, fc_link_lengths=None, specifications=None, tx_bias_thresholds=None, tx_power_thresholds=None, fc_speeds=None, link_length=None, cable_technology=None, connector_type=None, signaling_rate_min=None, vendor_part_number=None, temperature_thresholds=None, wavelength=None, identifier=None, fc_technology=None, rx_power_thresholds=None, extended_identifier=None, vendor_name=None, signaling_rate_max=None, vendor_oui=None, encoding=None, vendor_date_code=None, rate_identifier=None, fc_transmission_media=None, vendor_revision=None)
- Keyword Arguments
vendor_serial_number (str) – The serial number provided by the SFP vendor.
voltage_thresholds (NetworkInterfacePortDetailsStaticVoltageThresholds) –
signaling_rate (str) – The nominal signaling rate in MBd, rounded off to the nearest 100 MBd, or if greater than 25400 MBd, rounded off to the nearest 250 MBd. The value can be unspecified.
fc_link_lengths (list[str]) – The Fibre Channel distance capabilities supported by the transceiver.
specifications (list[str]) – The Ethernet, 10G Ethernet, ESCON, Infiniband, SONET, and other specifications supported by the transceiver.
tx_bias_thresholds (NetworkInterfacePortDetailsStaticTxBiasThresholds) –
tx_power_thresholds (NetworkInterfacePortDetailsStaticTxPowerThresholds) –
fc_speeds (str) – The Fibre Channel speeds supported by the transceiver. Speeds are in units of 100 MBytes/sec, which correspond to GFC (Gb/s).
link_length (str) – Link length and cable attenuation (for active or copper cables) for the specified transceiver. Values are comma-separated lists of fields and values, where each field is separated from its corresponding value by a colon. Valid fields include Copper Cable Attenuation (12.9 GHz), Copper Cable Attenuation (25.78 GHz), Copper Cable, SMF, OM2, OM1, OM4, and OM3. The unit for attenuation is dB, and the units for length are meters or kilometers. Unspecified fields are omitted.
cable_technology (list[str]) – The SFP+ cable technology supported by the transceiver.
connector_type (str) – The media connector type of the transceiver.
signaling_rate_min (str) – The lower signaling rate limit at which the transceiver still meets its specifications, specified as a percentage below the nominal signaling rate. The value can be unspecified.
vendor_part_number (str) – The part number provided by the SFP vendor.
temperature_thresholds (NetworkInterfacePortDetailsStaticTemperatureThresholds) –
wavelength (str) – Laser wavelength (for optical variants) at room temperature, in units of nm. For passive and active cable variants, the value is unspecified.
identifier (str) – The transceiver type.
fc_technology (list[str]) – The Fibre Channel technologies supported by the transceiver.
rx_power_thresholds (NetworkInterfacePortDetailsStaticRxPowerThresholds) –
extended_identifier (str) – The extended identifier of the transceiver type.
vendor_name (str) – The SFP vendor name.
signaling_rate_max (str) – The upper signaling rate limit at which the transceiver still meets its specifications, specified as a percentage above the nominal signaling rate. The value can be unspecified.
vendor_oui (str) – The SFP vendor IEEE company ID.
encoding (str) – The serial encoding algorithm of the transceiver.
vendor_date_code (str) – The SFP vendor’s manufacturing date code. The first six characters are the date in YYMMDD format, and the last two characters are the vendor specific lot code. The last two characters are optional.
rate_identifier (str) – The type of rate select functionality of the transceiver.
fc_transmission_media (list[str]) – The Fibre Channel transmission media supported by the transceiver.
vendor_revision (str) – The revision level for the part number provided by the SFP vendor.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'cable_technology': 'cable_technology', 'connector_type': 'connector_type', 'encoding': 'encoding', 'extended_identifier': 'extended_identifier', 'fc_link_lengths': 'fc_link_lengths', 'fc_speeds': 'fc_speeds', 'fc_technology': 'fc_technology', 'fc_transmission_media': 'fc_transmission_media', 'identifier': 'identifier', 'link_length': 'link_length', 'rate_identifier': 'rate_identifier', 'rx_power_thresholds': 'rx_power_thresholds', 'signaling_rate': 'signaling_rate', 'signaling_rate_max': 'signaling_rate_max', 'signaling_rate_min': 'signaling_rate_min', 'specifications': 'specifications', 'temperature_thresholds': 'temperature_thresholds', 'tx_bias_thresholds': 'tx_bias_thresholds', 'tx_power_thresholds': 'tx_power_thresholds', 'vendor_date_code': 'vendor_date_code', 'vendor_name': 'vendor_name', 'vendor_oui': 'vendor_oui', 'vendor_part_number': 'vendor_part_number', 'vendor_revision': 'vendor_revision', 'vendor_serial_number': 'vendor_serial_number', 'voltage_thresholds': 'voltage_thresholds', 'wavelength': 'wavelength'}
- keys()
- required_args = {}
- swagger_types = {'cable_technology': 'list[str]', 'connector_type': 'str', 'encoding': 'str', 'extended_identifier': 'str', 'fc_link_lengths': 'list[str]', 'fc_speeds': 'str', 'fc_technology': 'list[str]', 'fc_transmission_media': 'list[str]', 'identifier': 'str', 'link_length': 'str', 'rate_identifier': 'str', 'rx_power_thresholds': 'NetworkInterfacePortDetailsStaticRxPowerThresholds', 'signaling_rate': 'str', 'signaling_rate_max': 'str', 'signaling_rate_min': 'str', 'specifications': 'list[str]', 'temperature_thresholds': 'NetworkInterfacePortDetailsStaticTemperatureThresholds', 'tx_bias_thresholds': 'NetworkInterfacePortDetailsStaticTxBiasThresholds', 'tx_power_thresholds': 'NetworkInterfacePortDetailsStaticTxPowerThresholds', 'vendor_date_code': 'str', 'vendor_name': 'str', 'vendor_oui': 'str', 'vendor_part_number': 'str', 'vendor_revision': 'str', 'vendor_serial_number': 'str', 'voltage_thresholds': 'NetworkInterfacePortDetailsStaticVoltageThresholds', 'wavelength': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_rx_power_thresholds module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_rx_power_thresholds.NetworkInterfacePortDetailsStaticRxPowerThresholds(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
- Keyword Arguments
warn_low (float) – The warn low threshold for Rx input power in mW.
warn_high (float) – The warn high threshold for Rx input power in mW.
alarm_high (float) – The alarm high threshold for Rx input power in mW.
alarm_low (float) – The alarm low threshold for Rx input power in mW.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'alarm_high': 'alarm_high', 'alarm_low': 'alarm_low', 'warn_high': 'warn_high', 'warn_low': 'warn_low'}
- keys()
- required_args = {}
- swagger_types = {'alarm_high': 'float', 'alarm_low': 'float', 'warn_high': 'float', 'warn_low': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_temperature_thresholds module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_temperature_thresholds.NetworkInterfacePortDetailsStaticTemperatureThresholds(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
- Keyword Arguments
warn_low (float) – The warn low threshold for temperature in degrees Celsius.
warn_high (float) – The warn high threshold for temperature in degrees Celsius.
alarm_high (float) – The alarm high threshold for temperature in degrees Celsius.
alarm_low (float) – The alarm low threshold for temperature in degrees Celsius.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'alarm_high': 'alarm_high', 'alarm_low': 'alarm_low', 'warn_high': 'warn_high', 'warn_low': 'warn_low'}
- keys()
- required_args = {}
- swagger_types = {'alarm_high': 'float', 'alarm_low': 'float', 'warn_high': 'float', 'warn_low': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_tx_bias_thresholds module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_tx_bias_thresholds.NetworkInterfacePortDetailsStaticTxBiasThresholds(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
- Keyword Arguments
warn_low (float) – The warn low threshold for Tx bias current in mA.
warn_high (float) – The warn high threshold for Tx bias current in mA.
alarm_high (float) – The alarm high threshold for Tx bias current in mA.
alarm_low (float) – The alarm low threshold for Tx bias current in mA.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'alarm_high': 'alarm_high', 'alarm_low': 'alarm_low', 'warn_high': 'warn_high', 'warn_low': 'warn_low'}
- keys()
- required_args = {}
- swagger_types = {'alarm_high': 'float', 'alarm_low': 'float', 'warn_high': 'float', 'warn_low': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_tx_power_thresholds module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_tx_power_thresholds.NetworkInterfacePortDetailsStaticTxPowerThresholds(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
- Keyword Arguments
warn_low (float) – The warn low threshold for Tx output power in mW.
warn_high (float) – The warn high threshold for Tx output power in mW.
alarm_high (float) – The alarm high threshold for Tx output power in mW.
alarm_low (float) – The alarm low threshold for Tx output power in mW.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'alarm_high': 'alarm_high', 'alarm_low': 'alarm_low', 'warn_high': 'warn_high', 'warn_low': 'warn_low'}
- keys()
- required_args = {}
- swagger_types = {'alarm_high': 'float', 'alarm_low': 'float', 'warn_high': 'float', 'warn_low': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_voltage_thresholds module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_static_voltage_thresholds.NetworkInterfacePortDetailsStaticVoltageThresholds(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(warn_low=None, warn_high=None, alarm_high=None, alarm_low=None)
- Keyword Arguments
warn_low (float) – The warn low threshold for supply voltage in volts.
warn_high (float) – The warn high threshold for supply voltage in volts.
alarm_high (float) – The alarm high threshold for supply voltage in volts.
alarm_low (float) – The alarm low threshold for supply voltage in volts.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'alarm_high': 'alarm_high', 'alarm_low': 'alarm_low', 'warn_high': 'warn_high', 'warn_low': 'warn_low'}
- keys()
- required_args = {}
- swagger_types = {'alarm_high': 'float', 'alarm_low': 'float', 'warn_high': 'float', 'warn_low': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_temperature module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_temperature.NetworkInterfacePortDetailsTemperature(channel=None, measurement=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(channel=None, measurement=None, status=None)
- Keyword Arguments
channel (int) – The channel number if the diagnostic has an associated channel number. If not specified, defaults to null.
measurement (float) – Temperature in degrees Celsius.
status (str) – Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for temperature. Valid values are alarm low, alarm high, warn low, warn high, and ok.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'channel': 'channel', 'measurement': 'measurement', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'channel': 'int', 'measurement': 'float', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_tx_bias module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_tx_bias.NetworkInterfacePortDetailsTxBias(channel=None, measurement=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(channel=None, measurement=None, status=None)
- Keyword Arguments
channel (int) – The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.
measurement (float) – Tx bias current in mA.
status (str) – Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Tx bias current. Valid values are alarm low, alarm high, warn low, warn high, and ok.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'channel': 'channel', 'measurement': 'measurement', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'channel': 'int', 'measurement': 'float', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_tx_fault module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_tx_fault.NetworkInterfacePortDetailsTxFault(flag=None, channel=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(flag=None, channel=None)
- Keyword Arguments
flag (bool) – A value of true indicates transmitter/laser fault.
channel (int) – The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'channel': 'channel', 'flag': 'flag'}
- keys()
- required_args = {}
- swagger_types = {'channel': 'int', 'flag': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_tx_power module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_tx_power.NetworkInterfacePortDetailsTxPower(channel=None, measurement=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(channel=None, measurement=None, status=None)
- Keyword Arguments
channel (int) – The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.
measurement (float) – Tx output power in mW.
status (str) – Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Tx output power. Valid values are alarm low, alarm high, warn low, warn high, and ok.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'channel': 'channel', 'measurement': 'measurement', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'channel': 'int', 'measurement': 'float', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_port_details_voltage module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_port_details_voltage.NetworkInterfacePortDetailsVoltage(channel=None, measurement=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(channel=None, measurement=None, status=None)
- Keyword Arguments
channel (int) – The channel number if the diagnostic has an associated channel number. If not specified, defaults to null.
measurement (float) – Supply voltage in volts.
status (str) – Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for supply voltage. Valid values are alarm low, alarm high, warn low, warn high, and ok.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'channel': 'channel', 'measurement': 'measurement', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'channel': 'int', 'measurement': 'float', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_post.NetworkInterfacePost(name=None, eth=None, services=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, eth=None, services=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
eth (NetworkinterfacepostEth) –
services (list[str]) – The services provided by the specified network interface or Fibre Channel port.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'eth': 'eth', 'name': 'name', 'services': 'services'}
- keys()
- required_args = {}
- swagger_types = {'eth': 'NetworkinterfacepostEth', 'name': 'str', 'services': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interface_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interface_response.NetworkInterfaceResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[NetworkInterface]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[NetworkInterface]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interfaces_port_details module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interfaces_port_details.NetworkInterfacesPortDetails(name=None, rx_power=None, static=None, tx_bias=None, tx_power=None, rx_los=None, temperature=None, interface_type=None, tx_fault=None, voltage=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, rx_power=None, static=None, tx_bias=None, tx_power=None, rx_los=None, temperature=None, interface_type=None, tx_fault=None, voltage=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
rx_power (list[NetworkInterfacePortDetailsRxPower]) – Displays real-time measurement of Rx input power and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.
static (NetworkInterfacePortDetailsStatic) –
tx_bias (list[NetworkInterfacePortDetailsTxBias]) – Displays real-time measurement of Tx bias current and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.
tx_power (list[NetworkInterfacePortDetailsTxPower]) – Displays real-time measurement of Tx output power and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.
rx_los (list[NetworkInterfacePortDetailsRxLos]) – Displays status flags for Rx LOS. A value of true indicates Rx Loss-of-Signal. For four-lane modules, the array contains a flag for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.
temperature (list[NetworkInterfacePortDetailsTemperature]) – Displays real-time measurement of transceiver temperature and range. If the transceiver does not support digital diagnostic monitoring, the array is empty.
interface_type (str) – The interface type. Valid values are eth and fc.
tx_fault (list[NetworkInterfacePortDetailsTxFault]) – Displays status flags for Tx Fault. A value of true indicates transmitter/laser fault. For four-lane modules, the array contains a flag for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.
voltage (list[NetworkInterfacePortDetailsVoltage]) – Displays real-time measurement of supply voltage and whether it is within range. If the transceiver does not support digital diagnostic monitoring, the array is empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'interface_type': 'interface_type', 'name': 'name', 'rx_los': 'rx_los', 'rx_power': 'rx_power', 'static': 'static', 'temperature': 'temperature', 'tx_bias': 'tx_bias', 'tx_fault': 'tx_fault', 'tx_power': 'tx_power', 'voltage': 'voltage'}
- keys()
- required_args = {}
- swagger_types = {'interface_type': 'str', 'name': 'str', 'rx_los': 'list[NetworkInterfacePortDetailsRxLos]', 'rx_power': 'list[NetworkInterfacePortDetailsRxPower]', 'static': 'NetworkInterfacePortDetailsStatic', 'temperature': 'list[NetworkInterfacePortDetailsTemperature]', 'tx_bias': 'list[NetworkInterfacePortDetailsTxBias]', 'tx_fault': 'list[NetworkInterfacePortDetailsTxFault]', 'tx_power': 'list[NetworkInterfacePortDetailsTxPower]', 'voltage': 'list[NetworkInterfacePortDetailsVoltage]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interfaces_port_details_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interfaces_port_details_get_response.NetworkInterfacesPortDetailsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[NetworkInterfacesPortDetails]) – A list of port details objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterfacesPortDetails]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.network_interfaces_port_details_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.network_interfaces_port_details_response.NetworkInterfacesPortDetailsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[NetworkInterfacesPortDetails]) – A list of port details objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[NetworkInterfacesPortDetails]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.networkinterfacepatch_eth module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.networkinterfacepatch_eth.NetworkinterfacepatchEth(add_subinterfaces=None, subnet=None, address=None, netmask=None, remove_subinterfaces=None, subinterfaces=None, gateway=None, mtu=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(add_subinterfaces=None, subnet=None, address=None, netmask=None, remove_subinterfaces=None, subinterfaces=None, gateway=None, mtu=None)
- Keyword Arguments
add_subinterfaces (list[ReferenceNoId]) – Child devices to be added to the specified bond interface.
subnet (ReferenceNoId) – Subnet that is associated with the specified network interface.
address (str) – The IPv4 or IPv6 address to be associated with the specified network interface.
netmask (str) – Netmask of the specified network interface that, when combined with the address of the interface, determines the network address of the interface.
remove_subinterfaces (list[ReferenceNoId]) – Child devices to be removed from the specified bond interface.
subinterfaces (list[ReferenceNoId]) – Child devices to be added to the specified bond interface.
gateway (str) – The IPv4 or IPv6 address of the gateway through which the specified network interface is to communicate with the network.
mtu (int) – Maximum message transfer unit (packet) size for the network interface in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'add_subinterfaces': 'add_subinterfaces', 'address': 'address', 'gateway': 'gateway', 'mtu': 'mtu', 'netmask': 'netmask', 'remove_subinterfaces': 'remove_subinterfaces', 'subinterfaces': 'subinterfaces', 'subnet': 'subnet'}
- keys()
- required_args = {}
- swagger_types = {'add_subinterfaces': 'list[ReferenceNoId]', 'address': 'str', 'gateway': 'str', 'mtu': 'int', 'netmask': 'str', 'remove_subinterfaces': 'list[ReferenceNoId]', 'subinterfaces': 'list[ReferenceNoId]', 'subnet': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.networkinterfacepost_eth module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.networkinterfacepost_eth.NetworkinterfacepostEth(subnet=None, address=None, subtype=None, subinterfaces=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(subnet=None, address=None, subtype=None, subinterfaces=None)
- Keyword Arguments
subnet (ReferenceNoId) – Subnet that is associated with the specified network interface.
address (str) – The IPv4 or IPv6 address to be associated with the specified network interface.
subtype (str) – The subtype of the specified network interface. Only interfaces of subtype vif and lacp_bond can be created. Configurable on POST only. Valid values are failover_bond, lacp_bond, physical, and vif. If the subtype is vif, the services parameter must not be set.
subinterfaces (list[ReferenceNoId]) – List of network interfaces configured to be a subinterface of the specified network interface.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'address': 'address', 'subinterfaces': 'subinterfaces', 'subnet': 'subnet', 'subtype': 'subtype'}
- keys()
- required_args = {}
- swagger_types = {'address': 'str', 'subinterfaces': 'list[ReferenceNoId]', 'subnet': 'ReferenceNoId', 'subtype': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.new_name module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.new_name.NewName(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – The new name for the resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.non_copyable_tag module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.non_copyable_tag.NonCopyableTag(resource=None, namespace=None, value=None, key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(resource=None, namespace=None, value=None, key=None)
- Keyword Arguments
resource (FixedReference) –
namespace (str) – Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace default. The pure* namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.
value (str) – Value of the tag. Supports up to 256 Unicode characters.
key (str) – Key of the tag. Supports up to 64 Unicode characters.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'key': 'key', 'namespace': 'namespace', 'resource': 'resource', 'value': 'value'}
- keys()
- required_args = {}
- swagger_types = {'key': 'str', 'namespace': 'str', 'resource': 'FixedReference', 'value': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.oauth_token_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.oauth_token_response.OauthTokenResponse(access_token=None, issued_token_type=None, token_type=None, expires_in=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(access_token=None, issued_token_type=None, token_type=None, expires_in=None)
- Keyword Arguments
access_token (str) – 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.
issued_token_type (str) – The type of token that is issued. The Pure Storage REST API supports OAuth 2.0 access tokens.
token_type (str) – Indicates how the API client can use the access token issued. The Pure Storage REST API supports the Bearer token.
expires_in (int) – The duration after which the access token will expire. Measured in seconds. This differs from other duration fields that are expressed in milliseconds.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_token': 'access_token', 'expires_in': 'expires_in', 'issued_token_type': 'issued_token_type', 'token_type': 'token_type'}
- keys()
- required_args = {}
- swagger_types = {'access_token': 'str', 'expires_in': 'int', 'issued_token_type': 'str', 'token_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.offload module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.offload.Offload(s3=None, google_cloud=None, nfs=None, azure=None, name=None, context=None, protocol=None, target_id=None, space=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(s3=None, google_cloud=None, nfs=None, azure=None, name=None, context=None, protocol=None, target_id=None, space=None, status=None)
- Keyword Arguments
s3 (OffloadS3) – S3 settings.
google_cloud (OffloadGoogleCloud) – Google Cloud Storage settings.
nfs (OffloadNfs) – NFS settings. Deprecated from version 6.6.0 onwards - Contact support for additional information.
azure (OffloadAzure) – Microsoft Azure Blob storage settings.
name (str) – A user-specified name. The name must be locally unique and can be changed.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
protocol (str) – Type of offload. Valid values include azure, google-cloud, nfs, and s3.
target_id (str) – Unique ID for the offload target. When multiple connections to one offload target are created, they each have distinct IDs but share the same target_id.
space (Space) –
status (str) – Offload status. Valid values are connecting, connected, disconnecting, not connected, and scanning.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'azure': 'azure', 'context': 'context', 'google_cloud': 'google-cloud', 'name': 'name', 'nfs': 'nfs', 'protocol': 'protocol', 's3': 's3', 'space': 'space', 'status': 'status', 'target_id': 'target_id'}
- keys()
- required_args = {}
- swagger_types = {'azure': 'OffloadAzure', 'context': 'FixedReference', 'google_cloud': 'OffloadGoogleCloud', 'name': 'str', 'nfs': 'OffloadNfs', 'protocol': 'str', 's3': 'OffloadS3', 'space': 'Space', 'status': 'str', 'target_id': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.offload_azure module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.offload_azure.OffloadAzure(container_name=None, account_name=None, profile=None, secret_access_key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(container_name=None, account_name=None, profile=None, secret_access_key=None)
- Keyword Arguments
container_name (str) – The name of the container in the Azure Blob storage account to where the data will be offloaded. The name must be a valid DNS name. If not specified, defaults to offload.
account_name (str) – The name of the existing Azure Blob storage account.
profile (str) – The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the protocol parameter. Values include azure.
secret_access_key (str) – The secret access key that goes with the account name (account_name) of the Azure Blob storage account. The secret access key is only accepted when creating the connection between the array and the Azure Blob storage account. The account_name and container_name, and secret_access_key parameters must be set together.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'account_name': 'account_name', 'container_name': 'container_name', 'profile': 'profile', 'secret_access_key': 'secret_access_key'}
- keys()
- required_args = {}
- swagger_types = {'account_name': 'str', 'container_name': 'str', 'profile': 'str', 'secret_access_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.offload_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.offload_get_response.OffloadGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Offload]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[Offload]) – The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Offload]', 'more_items_remaining': 'bool', 'total': 'list[Offload]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.offload_google_cloud module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.offload_google_cloud.OffloadGoogleCloud(access_key_id=None, bucket=None, profile=None, secret_access_key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(access_key_id=None, bucket=None, profile=None, secret_access_key=None)
- Keyword Arguments
access_key_id (str) – The access key ID of the Google Cloud account used to create a connection between the array and a Google Cloud offload target. The access key ID is 24 characters in length and is only accepted when creating the connection between the array and the Google Cloud offload target. The access_key_id, secret_access_key, and bucket parameters must be set together.
bucket (str) – The name of the Google Cloud Storage bucket to which the data will be offloaded. Grant basic read and write access permissions to the bucket and verify that the bucket is empty of all objects. The access_key_id, secret_access_key, and bucket parameters must be set together.
profile (str) – The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the protocol parameter. Values include gcp.
secret_access_key (str) – The secret access key that goes with the access key ID of the Google Cloud account. The secret access key is 40 characters in length is only accepted when creating the connection between the array and the Google Cloud offload target. The access_key_id, secret_access_key, and bucket parameters must be set together.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_key_id': 'access_key_id', 'bucket': 'bucket', 'profile': 'profile', 'secret_access_key': 'secret_access_key'}
- keys()
- required_args = {}
- swagger_types = {'access_key_id': 'str', 'bucket': 'str', 'profile': 'str', 'secret_access_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.offload_nfs module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.offload_nfs.OffloadNfs(address=None, mount_options=None, mount_point=None, profile=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(address=None, mount_options=None, mount_point=None, profile=None)
- Keyword Arguments
address (str) – The hostname or IP address of the NFS server to where the data will be offloaded. An array can be connected to one offload target at a time, while multiple arrays can be connected to the same offload target. If the protection group is in a stretched pod, for high availability, connect both arrays in the stretched pod to the offload target.
mount_options (str) – The custom mount options on the NFS server. Enter multiple mount options in comma-separated format. Valid values include port, rsize, wsize, nfsvers, and tcp or udp. These mount options are common to all NFS file systems.
mount_point (str) – The mount point of the NFS export on the NFS server. For example, /mnt. The access_key_id, secret_access_key, and bucket parameters must be set together.
profile (str) – The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the protocol parameter. Values include nfs, and nfs-flashblade.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'address': 'address', 'mount_options': 'mount_options', 'mount_point': 'mount_point', 'profile': 'profile'}
- keys()
- required_args = {}
- swagger_types = {'address': 'str', 'mount_options': 'str', 'mount_point': 'str', 'profile': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.offload_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.offload_post.OffloadPost(s3=None, google_cloud=None, nfs=None, azure=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(s3=None, google_cloud=None, nfs=None, azure=None)
- Keyword Arguments
s3 (OffloadS3) – S3 settings.
google_cloud (OffloadGoogleCloud) – Google Cloud Storage settings.
nfs (OffloadNfs) – NFS settings. Deprecated from version 6.6.0 onwards - Contact support for additional information.
azure (OffloadAzure) – Microsoft Azure Blob storage settings.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'azure': 'azure', 'google_cloud': 'google-cloud', 'nfs': 'nfs', 's3': 's3'}
- keys()
- required_args = {}
- swagger_types = {'azure': 'OffloadAzure', 'google_cloud': 'OffloadGoogleCloud', 'nfs': 'OffloadNfs', 's3': 'OffloadS3'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.offload_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.offload_response.OffloadResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Offload]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.offload_s3 module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.offload_s3.OffloadS3(access_key_id=None, bucket=None, placement_strategy=None, auth_region=None, profile=None, secret_access_key=None, uri=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(access_key_id=None, bucket=None, placement_strategy=None, auth_region=None, profile=None, secret_access_key=None, uri=None)
- Keyword Arguments
access_key_id (str) – The access key ID of the AWS account used to create a connection between the array and an Amazon S3 offload target. The access key ID is 20 characters in length and is only accepted when creating the connection between the array and the S3 offload target. The access_key_id, secret_access_key, and bucket parameters must be set together.
bucket (str) – The name of the Amazon S3 bucket to where the data will be offloaded. Grant basic read and write ACL permissions to the bucket, and enable default (server-side) encryption for the bucket. Also verify that the bucket is empty of all objects and does not have any lifecycle policies. The access_key_id, secret_access_key, and bucket parameters must be set together.
placement_strategy (str) – The storage placement strategy used for the dynamic placement of data in an Amazon S3 offload target. Valid values are aws-intelligent-tiering, aws-standard-class, and retention-based. If set to aws-intelligent-tiering, data is stored in the Amazon S3 INTELLIGENT_TIERING storage class regardless of the retention period. If set to aws-standard-access, the data is stored in the Amazon S3 STANDARD storage class regardless of the retention period. If set to retention-based, the data for protection groups with longer retention periods is placed in the Amazon S3 STANDARD_IA (infrequently accessed, more cost-effective) storage class. All other data is placed in the STANDARD storage class. When the array is initially connected to an S3 offload target, placement_strategy is automatically set to retention-based. The placement_strategy or uri parameter is required, but they cannot be set together.
auth_region (str) – The region that will be used for initial authentication request. This parameter is optional and should be used only when region autodetection fails.
profile (str) – The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the protocol parameter. Values include s3-aws, s3-flashblade, s3-scality-ring, s3-wasabi-pay-as-you-go, s3-wasabi-rcs, and s3-other.
secret_access_key (str) – The secret access key that goes with the access key ID (access_key_id) of the AWS account. The secret access key is 40 characters in length is only accepted when creating the connection between the array and the S3 offload target. The access_key_id, secret_access_key, and bucket parameters must be set together.
uri (str) – The URI used to create a connection between the array and a non-AWS S3 offload target. Storage placement strategies are not supported for non-AWS S3 offload targets. Both the HTTP and HTTPS protocols are allowed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_key_id': 'access_key_id', 'auth_region': 'auth_region', 'bucket': 'bucket', 'placement_strategy': 'placement_strategy', 'profile': 'profile', 'secret_access_key': 'secret_access_key', 'uri': 'uri'}
- keys()
- required_args = {}
- swagger_types = {'access_key_id': 'str', 'auth_region': 'str', 'bucket': 'str', 'placement_strategy': 'str', 'profile': 'str', 'secret_access_key': 'str', 'uri': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.override_check module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.override_check.OverrideCheck(args=None, name=None, persistent=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(args=None, name=None, persistent=None)
- Keyword Arguments
args (str) – The name of the specific check within the override check to ignore so that the system can continue with the software upgrade. The name parameter of the override check must be specified with the args parameter. For example, if the HostIOCheck check fails on hosts host01 and host02, the system displays a list of these host names in the failed check. To override the HostIOCheck checks for host01 and host02, set name=HostIOCheck, and set args=host01,host02. Enter multiple args in comma-separated format. Note that not all checks have args values.
name (str) – The name of the upgrade check to be overridden so the software upgrade can continue if the check failed or is anticipated to fail during the upgrade process. Overriding the check forces the system to ignore the check failure and continue with the upgrade. If the check includes more specific checks that failed or are anticipated to fail, set them using the args parameter. For example, the HostIOCheck check may include a list of hosts that have failed or are anticipated to fail the upgrade check.
persistent (bool) – If set to true, the system always ignores the failure of the specified upgrade check and continues with the upgrade process. If set to false, the system ignores the failure of the specified upgrade check until the upgrade check finishes and the upgrade process is continued. For example, the continue command is successfully issued in an interactive mode, or the first upgrade check step successfully finishes in a one-click mode.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'args': 'args', 'name': 'name', 'persistent': 'persistent'}
- keys()
- required_args = {}
- swagger_types = {'args': 'str', 'name': 'str', 'persistent': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.page_info module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.page_info.PageInfo(continuation_token=None, more_items_remaining=None, total_item_count=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.page_info_without_total_item_count_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.page_info_without_total_item_count_response.PageInfoWithoutTotalItemCountResponse(continuation_token=None, more_items_remaining=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query parameter to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination, then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Displays a value of true if subsequent items can be retrieved.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'more_items_remaining': 'more_items_remaining'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'more_items_remaining': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.performance.Performance(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod.Pod(name=None, id=None, context=None, quota_limit=None, promotion_status=None, failover_preferences=None, eradication_config=None, source=None, link_target_count=None, space=None, time_remaining=None, destroyed=None, footprint=None, array_count=None, link_source_count=None, members=None, requested_promotion_state=None, arrays=None, mediator=None, mediator_version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, quota_limit=None, promotion_status=None, failover_preferences=None, eradication_config=None, source=None, link_target_count=None, space=None, time_remaining=None, destroyed=None, footprint=None, array_count=None, link_source_count=None, members=None, requested_promotion_state=None, arrays=None, mediator=None, mediator_version=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
quota_limit (int) – The logical quota limit of the pod, measured in bytes.
promotion_status (str) – Current promotion status of a pod. Values include promoted, demoted, and promoting. The promoted status indicates that the pod has been promoted. The pod takes writes from hosts instead of incorporating replicated data. This is the default mode for a pod when it is created. The demoted status indicates that the pod has been demoted. The pod does not accept write requests and is ready to be used as a link target. The promoting status indicates that the pod is in an intermediate status between demoted and promoted while the promotion process is taking place.
failover_preferences (list[Reference]) – Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, failover_preferences=null, meaning no arrays have been configured for failover preference.
eradication_config (ContainerEradicationConfig) –
source (FixedReference) – The source pod from where data is cloned to create the new pod.
link_target_count (int) – The number of target pods that link to the pod.
space (PodSpace) – Displays provisioned size and physical storage consumption information for the sum of all volumes connected to the specified host.
time_remaining (int) – The amount of time left until the destroyed pod is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed pod can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the pod has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed pod is permanently eradicated. Before the time_remaining period has elapsed, the destroyed pod can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the pod is permanently eradicated and can no longer be recovered.
footprint (int) – This field has been deprecated. Use the space.footprint field in the future, as it contains the same information. The maximum amount of space the pod would take up on any array, ignoring any data shared outside the pod. Measured in bytes. The footprint metric is mostly used for capacity planning.
array_count (int) – The number of arrays a pod connects to.
link_source_count (int) – The number of source pods that link to the pod.
members (list[ReferenceWithType]) – A list of arrays or realms over which the pod is stretched. If there are two or more members in the stretched pod, all data in the pod is synchronously replicated between all of the members within the pod.
requested_promotion_state (str) – Values include promoted and demoted. Patch requested_promotion_state to demoted to demote the pod so that it can be used as a link target for continuous replication between pods. Demoted pods do not accept write requests, and a destroyed version of the pod with undo-demote appended to the pod name is created on the array with the state of the pod when it was in the promoted state. Patch requested_promotion_state to promoted to start the process of promoting the pod. The promotion_status indicates when the pod has been successfully promoted. Promoted pods stop incorporating replicated data from the source pod and start accepting write requests. The replication process does not stop as the source pod continues replicating data to the pod. The space consumed by the unique replicated data is tracked by the space.journal field of the pod.
arrays (list[PodArrayStatus]) – A list of arrays over which the pod is stretched. If there are two or more arrays in the stretched pod, all data in the pod is synchronously replicated between all of the arrays within the pod.
mediator (str) – The URL of the mediator for the pod. By default, the Pure1 Cloud Mediator (purestorage) serves as the mediator.
mediator_version (str) – The mediator version.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'array_count': 'array_count', 'arrays': 'arrays', 'context': 'context', 'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'failover_preferences': 'failover_preferences', 'footprint': 'footprint', 'id': 'id', 'link_source_count': 'link_source_count', 'link_target_count': 'link_target_count', 'mediator': 'mediator', 'mediator_version': 'mediator_version', 'members': 'members', 'name': 'name', 'promotion_status': 'promotion_status', 'quota_limit': 'quota_limit', 'requested_promotion_state': 'requested_promotion_state', 'source': 'source', 'space': 'space', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'array_count': 'int', 'arrays': 'list[PodArrayStatus]', 'context': 'FixedReference', 'destroyed': 'bool', 'eradication_config': 'ContainerEradicationConfig', 'failover_preferences': 'list[Reference]', 'footprint': 'int', 'id': 'str', 'link_source_count': 'int', 'link_target_count': 'int', 'mediator': 'str', 'mediator_version': 'str', 'members': 'list[ReferenceWithType]', 'name': 'str', 'promotion_status': 'str', 'quota_limit': 'int', 'requested_promotion_state': 'str', 'source': 'FixedReference', 'space': 'PodSpace', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_array_status module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_array_status.PodArrayStatus(name=None, id=None, pre_elected=None, member=None, mediator_status=None, progress=None, frozen_at=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, pre_elected=None, member=None, mediator_status=None, progress=None, frozen_at=None, status=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
pre_elected (bool) – If set to true, the array has been pre-elected to remain online in the rare event that the mediator is inaccessible on both arrays within the stretched pod, and then later, the arrays within the stretched pod become disconnected from each other. If set to false, either the array has been pre-elected to remain offline while its peer array remains online, or pre-election is not in effect. One and only one array within each pod is pre-elected at a given point in time, so while a pre-elected array is keeping the pod online, the pod on its non-elected peer array remains offline during the communication failure. Users cannot pre-elect arrays.
member (ReferenceWithType) – A reference to the member associated with the pod’s array status.
mediator_status (str) – The status of the mediator, which determines whether it is available to mediate a high availability event. Valid values are flummoxed, online, unknown, and unreachable. Only mediators in the online status can mediate high availability events. If set to flummoxed, the array can reach a mediator, but it is talking to the wrong one. Verify that the DNS in the environment is properly configured. This status might also appear if the pod has been offline on one array for an extended period of time and the peer array is unreachable. If set to online, the array is successfully communicating with the mediator, and the mediator is available to mediate a high availability event. If set to unreachable, the array cannot reach the mediator, either due to network issues or because the mediator is down. When a mediator is unreachable, synchronous replication continues to function provided all arrays are healthy and communicating, but a high availability event without mediator access can result in an outage.
progress (float) – The percentage progress of the pod resyncing process for this array. The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00.
frozen_at (int) – The timestamp of when the data on the pod was frozen when the array went offline. Measured in milliseconds since the UNIX epoch. Also known as the recovery point. If the pod is in sync, a value of null will be returned.
status (str) – The status of the array within the stretched pod. Valid values are offline, online, resyncing, suspended, and unknown. If set to offline, the array is experiencing problems and may not have the latest pod data. The array cannot handle I/O to the pod and cannot take over during a high availability event. If set to online, the array is online and has the latest pod data. The array can handle I/O to the pod and take over during a high availability event. If set to suspended, the array is experiencing a short connection glitch of the pod. This is a temporary status and would transition to either online or offline soon. suspended is a new status that is exposed, starting from version 6.6.0. If set to resyncing, the array is actively getting the latest pod data so that it becomes fully synchronized with its peer array. During the resyncing process, the array cannot handle I/O to the pod. Once the arrays are fully synchronized, the array changes to online status. If set to unknown, the status of the peer array is unknown because this array is offline and cannot determine the state of the pod on the peer array. Only the peer array can ever be in unknown status; this unknown status is unique to the local array and will differ when viewed from its peer array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'frozen_at': 'frozen_at', 'id': 'id', 'mediator_status': 'mediator_status', 'member': 'member', 'name': 'name', 'pre_elected': 'pre_elected', 'progress': 'progress', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'frozen_at': 'int', 'id': 'str', 'mediator_status': 'str', 'member': 'ReferenceWithType', 'name': 'str', 'pre_elected': 'bool', 'progress': 'float', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_eradication_config module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_eradication_config.PodEradicationConfig(manual_eradication=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(manual_eradication=None)
- Keyword Arguments
manual_eradication (str) – The manual eradication status of pod. If all-enabled, the pod and its contents can be eradicated. If partially-disabled, the pod cannot be eradicated because the pod contains some non-empty protection groups that are retention-locked. If all-disabled, the pod and its contents cannot be eradicated. Values include all-disabled, all-enabled, and partially-disabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'manual_eradication': 'manual_eradication'}
- keys()
- required_args = {}
- swagger_types = {'manual_eradication': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_get_response.PodGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Pod]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[Pod]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Pod]', 'more_items_remaining': 'bool', 'total': 'list[Pod]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_member module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_member.PodMember(context=None, pod=None, member=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, pod=None, member=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
pod (ReferenceWithType) –
member (ReferenceWithType) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'member': 'member', 'pod': 'pod'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'member': 'ReferenceWithType', 'pod': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_member_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_member_get_response.PodMemberGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PodMember]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PodMember]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_member_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_member_response.PodMemberResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PodMember]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PodMember]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_patch.PodPatch(name=None, id=None, quota_limit=None, destroyed=None, failover_preferences=None, requested_promotion_state=None, mediator=None, ignore_usage=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, quota_limit=None, destroyed=None, failover_preferences=None, requested_promotion_state=None, mediator=None, ignore_usage=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
quota_limit (int) – The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.
destroyed (bool) – If set to true, the pod has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed pod is permanently eradicated. A pod can only be destroyed if it is empty, so before destroying a pod, ensure all volumes and protection groups inside the pod have been either moved out of the pod or destroyed. A stretched pod cannot be destroyed unless you unstretch it first. Before the time_remaining period has elapsed, the destroyed pod can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the pod is permanently eradicated and can no longer be recovered.
failover_preferences (list[Reference]) – Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, failover_preferences=null, meaning no arrays have been configured for failover preference. Enter multiple arrays in comma-separated format.
requested_promotion_state (str) – Patch requested_promotion_state to demoted to demote the pod so that it can be used as a link target for continuous replication between pods. Demoted pods do not accept write requests, and a destroyed version of the pod with undo-demote appended to the pod name is created on the array with the state of the pod when it was in the promoted state. Patch requested_promotion_state to promoted to start the process of promoting the pod. The promotion_status indicates when the pod has been successfully promoted. Promoted pods stop incorporating replicated data from the source pod and start accepting write requests. The replication process does not stop when the source pod continues replicating data to the pod. The space consumed by the unique replicated data is tracked by the space.journal field of the pod.
mediator (str) – Sets the URL of the mediator for this pod, replacing the URL of the current mediator. By default, the Pure1 Cloud Mediator (purestorage) serves as the mediator.
ignore_usage (bool) – Set to true to set a quota_limit that is lower than the existing usage. This ensures that no new volumes can be created until the existing usage drops below the quota_limit. If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'failover_preferences': 'failover_preferences', 'id': 'id', 'ignore_usage': 'ignore_usage', 'mediator': 'mediator', 'name': 'name', 'quota_limit': 'quota_limit', 'requested_promotion_state': 'requested_promotion_state'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'failover_preferences': 'list[Reference]', 'id': 'str', 'ignore_usage': 'bool', 'mediator': 'str', 'name': 'str', 'quota_limit': 'int', 'requested_promotion_state': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_performance.PodPerformance(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None, others_per_sec=None, usec_per_other_op=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None, others_per_sec=None, usec_per_other_op=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
others_per_sec (int) – The number of other requests processed per second.
usec_per_other_op (int) – The average time it takes the pod to process an I/O other request, measured in microseconds.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'context': 'context', 'id': 'id', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'others_per_sec': 'others_per_sec', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_other_op': 'usec_per_other_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'context': 'FixedReference', 'id': 'str', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'others_per_sec': 'int', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_other_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_performance_by_array module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_performance_by_array.PodPerformanceByArray(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None, others_per_sec=None, usec_per_other_op=None, array=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None, others_per_sec=None, usec_per_other_op=None, array=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
others_per_sec (int) – The number of other requests processed per second.
usec_per_other_op (int) – The average time it takes the pod to process an I/O other request, measured in microseconds.
array (Resource) – The array on which the performance metrics were recorded.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'array': 'array', 'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'context': 'context', 'id': 'id', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'others_per_sec': 'others_per_sec', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_other_op': 'usec_per_other_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'array': 'Resource', 'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'context': 'FixedReference', 'id': 'str', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'others_per_sec': 'int', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_other_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_performance_by_array_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_performance_by_array_get_response.PodPerformanceByArrayGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[PodPerformanceByArray]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.
items (list[PodPerformanceByArray]) – Performance data, broken down by array. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PodPerformanceByArray]', 'more_items_remaining': 'bool', 'total': 'list[PodPerformanceByArray]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_performance_replication module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_performance_replication.PodPerformanceReplication(context=None, total_bytes_per_sec=None, sync_bytes_per_sec=None, periodic_bytes_per_sec=None, pod=None, continuous_bytes_per_sec=None, resync_bytes_per_sec=None, time=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, total_bytes_per_sec=None, sync_bytes_per_sec=None, periodic_bytes_per_sec=None, pod=None, continuous_bytes_per_sec=None, resync_bytes_per_sec=None, time=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
total_bytes_per_sec (int) – Total bytes transmitted and received per second for all types of replication.
sync_bytes_per_sec (ReplicationPerformanceWithTotal) – Total bytes transmitted or received per second for synchronous replication.
periodic_bytes_per_sec (ReplicationPerformanceWithTotal) – Total bytes transmitted or received per second for periodic replication.
pod (FixedReference) – Reference to the pod that the performance data is associated with.
continuous_bytes_per_sec (ReplicationPerformanceWithTotal) – Total bytes transmitted or received per second for continuous replication. The continuous replication feature is used for disaster recovery on FlashArray and provides a recovery point objective (RPO) of significantly less than 30s.
resync_bytes_per_sec (ReplicationPerformanceWithTotal) – Total bytes transmitted or received per second during resync replication. Resync replication is the mechanism to bring two arrays into sync. This may occur during an initial pod stretch, or, in case of outage, when two arrays reestablish connection. After the connection is restored, the array that was online starts replicating pod data to its peer array until the pod is once again in sync.
time (int) – Sample time in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'continuous_bytes_per_sec': 'continuous_bytes_per_sec', 'periodic_bytes_per_sec': 'periodic_bytes_per_sec', 'pod': 'pod', 'resync_bytes_per_sec': 'resync_bytes_per_sec', 'sync_bytes_per_sec': 'sync_bytes_per_sec', 'time': 'time', 'total_bytes_per_sec': 'total_bytes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'continuous_bytes_per_sec': 'ReplicationPerformanceWithTotal', 'periodic_bytes_per_sec': 'ReplicationPerformanceWithTotal', 'pod': 'FixedReference', 'resync_bytes_per_sec': 'ReplicationPerformanceWithTotal', 'sync_bytes_per_sec': 'ReplicationPerformanceWithTotal', 'time': 'int', 'total_bytes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_performance_replication_by_array module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_performance_replication_by_array.PodPerformanceReplicationByArray(context=None, total_bytes_per_sec=None, sync_bytes_per_sec=None, periodic_bytes_per_sec=None, pod=None, continuous_bytes_per_sec=None, resync_bytes_per_sec=None, time=None, array=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, total_bytes_per_sec=None, sync_bytes_per_sec=None, periodic_bytes_per_sec=None, pod=None, continuous_bytes_per_sec=None, resync_bytes_per_sec=None, time=None, array=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
total_bytes_per_sec (int) – Total bytes transmitted and received per second for all types of replication.
sync_bytes_per_sec (ReplicationPerformanceWithTotal) – Total bytes transmitted or received per second for synchronous replication.
periodic_bytes_per_sec (ReplicationPerformanceWithTotal) – Total bytes transmitted or received per second for periodic replication.
pod (FixedReference) – Reference to the pod that the performance data is associated with.
continuous_bytes_per_sec (ReplicationPerformanceWithTotal) – Total bytes transmitted or received per second for continuous replication. The continuous replication feature is used for disaster recovery on FlashArray and provides a recovery point objective (RPO) of significantly less than 30s.
resync_bytes_per_sec (ReplicationPerformanceWithTotal) – Total bytes transmitted or received per second during resync replication. Resync replication is the mechanism to bring two arrays into sync. This may occur during an initial pod stretch, or, in case of outage, when two arrays reestablish connection. After the connection is restored, the array that was online starts replicating pod data to its peer array until the pod is once again in sync.
time (int) – Sample time in milliseconds since the UNIX epoch.
array (Resource) – Array that shares this pod.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'array': 'array', 'context': 'context', 'continuous_bytes_per_sec': 'continuous_bytes_per_sec', 'periodic_bytes_per_sec': 'periodic_bytes_per_sec', 'pod': 'pod', 'resync_bytes_per_sec': 'resync_bytes_per_sec', 'sync_bytes_per_sec': 'sync_bytes_per_sec', 'time': 'time', 'total_bytes_per_sec': 'total_bytes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'array': 'Resource', 'context': 'FixedReference', 'continuous_bytes_per_sec': 'ReplicationPerformanceWithTotal', 'periodic_bytes_per_sec': 'ReplicationPerformanceWithTotal', 'pod': 'FixedReference', 'resync_bytes_per_sec': 'ReplicationPerformanceWithTotal', 'sync_bytes_per_sec': 'ReplicationPerformanceWithTotal', 'time': 'int', 'total_bytes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_performance_replication_by_array_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_performance_replication_by_array_get_response.PodPerformanceReplicationByArrayGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
total (list[PodPerformanceReplicationByArray]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful.
items (list[PodPerformanceReplicationByArray]) – A list of pod performance replication objects, arranged by array.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PodPerformanceReplicationByArray]', 'more_items_remaining': 'bool', 'total': 'list[PodPerformanceReplicationByArray]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_performance_replication_by_array_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_performance_replication_by_array_response.PodPerformanceReplicationByArrayResponse(total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(total=None, items=None)
- Keyword Arguments
total (list[PodPerformanceReplicationByArray]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful.
items (list[PodPerformanceReplicationByArray]) – A list of pod performance replication objects, arranged by array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items', 'total': 'total'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PodPerformanceReplicationByArray]', 'total': 'list[PodPerformanceReplicationByArray]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_performance_replication_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_performance_replication_get_response.PodPerformanceReplicationGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
total (list[PodPerformanceReplication]) – The aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful.
items (list[PodPerformanceReplication]) – A list of pod performance replication objects.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PodPerformanceReplication]', 'more_items_remaining': 'bool', 'total': 'list[PodPerformanceReplication]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_performance_replication_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_performance_replication_response.PodPerformanceReplicationResponse(total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(total=None, items=None)
- Keyword Arguments
total (list[PodPerformanceReplication]) – The aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful.
items (list[PodPerformanceReplication]) – A list of pod performance replication objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items', 'total': 'total'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PodPerformanceReplication]', 'total': 'list[PodPerformanceReplication]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_post.PodPost(name=None, id=None, quota_limit=None, failover_preferences=None, source=None, tags=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, quota_limit=None, failover_preferences=None, source=None, tags=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
quota_limit (int) – The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.
failover_preferences (list[Reference]) – Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, failover_preferences=null, meaning no arrays have been configured for failover preference. Enter multiple arrays in comma-separated format. To clear the list of failover preferences, set to an empty list [].
source (Reference) – The source pod from where data is cloned to create the new pod.
tags (list[Tag]) – The list of tags to be upserted with the object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'failover_preferences': 'failover_preferences', 'id': 'id', 'name': 'name', 'quota_limit': 'quota_limit', 'source': 'source', 'tags': 'tags'}
- keys()
- required_args = {}
- swagger_types = {'failover_preferences': 'list[Reference]', 'id': 'str', 'name': 'str', 'quota_limit': 'int', 'source': 'Reference', 'tags': 'list[Tag]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link.PodReplicaLink(id=None, context=None, paused=None, lag=None, recovery_point=None, remotes=None, remote_pod=None, local_pod=None, direction=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(id=None, context=None, paused=None, lag=None, recovery_point=None, remotes=None, remote_pod=None, local_pod=None, direction=None, status=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
paused (bool) – Returns a value of true if the replica link is in a paused state. Returns a value of false if the replica link is not in a paused state.
lag (int) – Duration in milliseconds that represents how far behind the replication target is from the source. This is the time difference between current time and recovery_point.
recovery_point (int) – 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.
remotes (list[FixedReference]) – A list of remote arrays that share this pod.
remote_pod (FixedReference) – Reference to a remote pod.
local_pod (FixedReference) – Reference to a local pod.
direction (str) – The direction of replication. Valid values include inbound and outbound.
status (str) – Status of the replica-link. Valid values include replicating, baselining, paused, quiescing, quiesced, idle, and unhealthy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'direction': 'direction', 'id': 'id', 'lag': 'lag', 'local_pod': 'local_pod', 'paused': 'paused', 'recovery_point': 'recovery_point', 'remote_pod': 'remote_pod', 'remotes': 'remotes', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'direction': 'str', 'id': 'str', 'lag': 'int', 'local_pod': 'FixedReference', 'paused': 'bool', 'recovery_point': 'int', 'remote_pod': 'FixedReference', 'remotes': 'list[FixedReference]', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_get_response.PodReplicaLinkGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PodReplicaLink]) – A list of pod replica link objects.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PodReplicaLink]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_lag module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_lag.PodReplicaLinkLag(id=None, context=None, lag=None, recovery_point=None, remotes=None, remote_pod=None, time=None, local_pod=None, direction=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(id=None, context=None, lag=None, recovery_point=None, remotes=None, remote_pod=None, time=None, local_pod=None, direction=None, status=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
lag (ReplicaLinkLag) – Duration in milliseconds that indicates how far behind the replication target is from the source.
recovery_point (int) – Time when the last piece of data was replicated, in milliseconds since the UNIX epoch, and the recovery point if the pod is promoted. If the pod is baselining then the value is null.
remotes (list[FixedReference]) – Reference to a remote array.
remote_pod (FixedReference) – Reference to a remote pod.
time (int) – Sample time in milliseconds since the UNIX epoch.
local_pod (FixedReference) – Reference to a local pod.
direction (str) – The direction of replication. Valid values include inbound and outbound.
status (str) – Status of the replica-link. Valid values include replicating, baselining, paused, quiescing, quiesced, idle, and unhealthy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'direction': 'direction', 'id': 'id', 'lag': 'lag', 'local_pod': 'local_pod', 'recovery_point': 'recovery_point', 'remote_pod': 'remote_pod', 'remotes': 'remotes', 'status': 'status', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'direction': 'str', 'id': 'str', 'lag': 'ReplicaLinkLag', 'local_pod': 'FixedReference', 'recovery_point': 'int', 'remote_pod': 'FixedReference', 'remotes': 'list[FixedReference]', 'status': 'str', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_lag_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_lag_get_response.PodReplicaLinkLagGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PodReplicaLinkLag]) – A list of pod replica link lag objects.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PodReplicaLinkLag]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_lag_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_lag_response.PodReplicaLinkLagResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PodReplicaLinkLag]) – A list of pod replica link lag objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PodReplicaLinkLag]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_mapping_policy_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_mapping_policy_get_response.PodReplicaLinkMappingPolicyGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[MappingPolicy]) – A list of policy mappings.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[MappingPolicy]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_mapping_policy_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_mapping_policy_response.PodReplicaLinkMappingPolicyResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[MappingPolicy]) – A list of policy mappings.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[MappingPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_patch.PodReplicaLinkPatch(paused=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(paused=None)
- Keyword Arguments
paused (bool) – Returns a value of true if the replica link is to be created in a paused state. Returns a value of false if the replica link is to be created not in a paused state. If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'paused': 'paused'}
- keys()
- required_args = {}
- swagger_types = {'paused': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_performance_replication module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_performance_replication.PodReplicaLinkPerformanceReplication(id=None, bytes_per_sec_total=None, bytes_per_sec_from_remote=None, remotes=None, bytes_per_sec_to_remote=None, remote_pod=None, time=None, local_pod=None, direction=None, context=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(id=None, bytes_per_sec_total=None, bytes_per_sec_from_remote=None, remotes=None, bytes_per_sec_to_remote=None, remote_pod=None, time=None, local_pod=None, direction=None, context=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
bytes_per_sec_total (int) – Total bytes transmitted and received per second.
bytes_per_sec_from_remote (int) – The number of bytes received per second from a remote array.
remotes (list[FixedReference]) – Reference to a remote array.
bytes_per_sec_to_remote (int) – The number of bytes transmitted per second to a remote array.
remote_pod (FixedReference) – Reference to a remote pod.
time (int) – Sample time in milliseconds since the UNIX epoch.
local_pod (FixedReference) – Reference to a local pod.
direction (str) – The direction of replication. Valid values are inbound and outbound.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_sec_from_remote': 'bytes_per_sec_from_remote', 'bytes_per_sec_to_remote': 'bytes_per_sec_to_remote', 'bytes_per_sec_total': 'bytes_per_sec_total', 'context': 'context', 'direction': 'direction', 'id': 'id', 'local_pod': 'local_pod', 'remote_pod': 'remote_pod', 'remotes': 'remotes', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_sec_from_remote': 'int', 'bytes_per_sec_to_remote': 'int', 'bytes_per_sec_total': 'int', 'context': 'FixedReference', 'direction': 'str', 'id': 'str', 'local_pod': 'FixedReference', 'remote_pod': 'FixedReference', 'remotes': 'list[FixedReference]', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_performance_replication_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_performance_replication_get_response.PodReplicaLinkPerformanceReplicationGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
total (list[PodReplicaLinkPerformanceReplication]) – The aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful.
items (list[PodReplicaLinkPerformanceReplication]) – A list of pod replica link performance objects.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PodReplicaLinkPerformanceReplication]', 'more_items_remaining': 'bool', 'total': 'list[PodReplicaLinkPerformanceReplication]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_performance_replication_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_performance_replication_response.PodReplicaLinkPerformanceReplicationResponse(total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(total=None, items=None)
- Keyword Arguments
total (list[PodReplicaLinkPerformanceReplication]) – The aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful.
items (list[PodReplicaLinkPerformanceReplication]) – A list of pod replica link performance objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items', 'total': 'total'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PodReplicaLinkPerformanceReplication]', 'total': 'list[PodReplicaLinkPerformanceReplication]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_reference.PodReplicaLinkReference(id=None, remotes=None, remote_pod=None, local_pod=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(id=None, remotes=None, remote_pod=None, local_pod=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
remotes (list[FixedReference]) – Reference to remote arrays.
remote_pod (FixedReference) – Reference to a remote pod.
local_pod (FixedReference) – Reference to a local pod.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'local_pod': 'local_pod', 'remote_pod': 'remote_pod', 'remotes': 'remotes'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'local_pod': 'FixedReference', 'remote_pod': 'FixedReference', 'remotes': 'list[FixedReference]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_replica_link_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_replica_link_response.PodReplicaLinkResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PodReplicaLink]) – A list of pod replica link objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PodReplicaLink]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_response.PodResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Pod]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.pod_space module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.pod_space.PodSpace(data_reduction=None, shared=None, virtual=None, used_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None, snapshots=None, total_physical=None, footprint=None, system=None, unique=None, total_provisioned=None, replication=None, replication_effective=None, shared_effective=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(data_reduction=None, shared=None, virtual=None, used_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None, snapshots=None, total_physical=None, footprint=None, system=None, unique=None, total_provisioned=None, replication=None, replication_effective=None, shared_effective=None)
- Keyword Arguments
data_reduction (float) – The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.
shared (int) – The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.
virtual (int) – The amount of logically written data that a volume or a snapshot references. Measured in bytes.
used_provisioned (int) – The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container.
total_reduction (float) – The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.
total_used (int) – The total space contributed by customer data, measured in bytes.
thin_provisioning (float) – The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.
snapshots (int) – The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.
total_physical (int) – This field has been deprecated. Use the total_used field, as it contains the same information.
footprint (int) – The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.
system (int) – The physical space occupied by internal array metadata. Measured in bytes.
unique (int) – The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.
total_provisioned (int) – The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.
replication (int) – The space consumed by unique data that has not been replicated to the target pod, on source pods. The space consumed by unique data that has been replicated to the target, but not yet incorporated into the target pod, on target pods. On Evergreen//One arrays, the effective space consumed by unique data that has not been replicated to the target pod, on source pods. The effective space consumed by unique data that has been replicated to the target, but not yet incorporated into the target pod, on target pods.
replication_effective (int) – This field has been deprecated. The effective space consumed by unique data that has not been replicated to the target pod, on source pods. The effective space consumed by unique data that has been replicated to the target but not yet incorporated into the target pod, on target pods. Please use the replication field in the future, as it contains the same information for Evergreen//One arrays.
shared_effective (int) – This field has been deprecated. The effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes. Please use the shared field in the future, as it contains the same information for Evergreen//One arrays.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'data_reduction': 'data_reduction', 'footprint': 'footprint', 'replication': 'replication', 'replication_effective': 'replication_effective', 'shared': 'shared', 'shared_effective': 'shared_effective', 'snapshots': 'snapshots', 'system': 'system', 'thin_provisioning': 'thin_provisioning', 'total_physical': 'total_physical', 'total_provisioned': 'total_provisioned', 'total_reduction': 'total_reduction', 'total_used': 'total_used', 'unique': 'unique', 'used_provisioned': 'used_provisioned', 'virtual': 'virtual'}
- keys()
- required_args = {}
- swagger_types = {'data_reduction': 'float', 'footprint': 'int', 'replication': 'int', 'replication_effective': 'int', 'shared': 'int', 'shared_effective': 'int', 'snapshots': 'int', 'system': 'int', 'thin_provisioning': 'float', 'total_physical': 'int', 'total_provisioned': 'int', 'total_reduction': 'float', 'total_used': 'int', 'unique': 'int', 'used_provisioned': 'int', 'virtual': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy.Policy(name=None, id=None, context=None, time_remaining=None, destroyed=None, policy_type=None, pod=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, policy_type=None, pod=None, enabled=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated.
destroyed (bool) – Returns a value of true if the policy has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the policy is permanently eradicated and can no longer be recovered.
policy_type (str) – The type of policy. Valid values include autodir, nfs, smb, snapshot, and quota.
pod (Reference) – A reference to the pod.
enabled (bool) – Returns a value of true if the policy is enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destroyed': 'destroyed', 'enabled': 'enabled', 'id': 'id', 'name': 'name', 'pod': 'pod', 'policy_type': 'policy_type', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'destroyed': 'bool', 'enabled': 'bool', 'id': 'str', 'name': 'str', 'pod': 'Reference', 'policy_type': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_assignment_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_assignment_post.PolicyAssignmentPost(policies=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(policies=None)
- Keyword Arguments
policies (list[PolicyAssignmentPostPolicy]) – A list of policies to apply to the resource. One of id or name is required in each policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'policies': 'policies'}
- keys()
- required_args = {}
- swagger_types = {'policies': 'list[PolicyAssignmentPostPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_assignment_post_policy module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_assignment_post_policy.PolicyAssignmentPostPolicy(policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(policy=None)
- Keyword Arguments
policy (Reference) – Reference to the policy to apply to the resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'policy': 'policy'}
- keys()
- required_args = {}
- swagger_types = {'policy': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_audit_file module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_audit_file.PolicyAuditFile(name=None, id=None, context=None, time_remaining=None, destroyed=None, policy_type=None, pod=None, enabled=None, log_targets=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, policy_type=None, pod=None, enabled=None, log_targets=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated.
destroyed (bool) – Returns a value of true if the policy has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the policy is permanently eradicated and can no longer be recovered.
policy_type (str) – The type of policy. Valid values include autodir, nfs, smb, snapshot, and quota.
pod (Reference) – A reference to the pod.
enabled (bool) – Returns a value of true if the policy is enabled.
log_targets (list[ReferenceNoIdWithType]) – A list of targets to which audit logs will be sent.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destroyed': 'destroyed', 'enabled': 'enabled', 'id': 'id', 'log_targets': 'log_targets', 'name': 'name', 'pod': 'pod', 'policy_type': 'policy_type', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'destroyed': 'bool', 'enabled': 'bool', 'id': 'str', 'log_targets': 'list[ReferenceNoIdWithType]', 'name': 'str', 'pod': 'Reference', 'policy_type': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_audit_file_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_audit_file_get_response.PolicyAuditFileGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyAuditFile]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyAuditFile]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_audit_file_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_audit_file_patch.PolicyAuditFilePatch(name=None, enabled=None, log_targets=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, enabled=None, log_targets=None)
- Keyword Arguments
name (str) – The new name for the resource.
enabled (bool) – If set to true, enables the policy. If set to false, disables the policy.
log_targets (list[ReferenceNoIdWithType]) – A list of targets to which audit logs will be sent. This list, if sent, overrides existing target list.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'log_targets': 'log_targets', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'log_targets': 'list[ReferenceNoIdWithType]', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_audit_file_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_audit_file_post.PolicyAuditFilePost(enabled=None, log_targets=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None, log_targets=None)
- Keyword Arguments
enabled (bool) – If set to true, enables the policy. If set to false, disables the policy.
log_targets (list[ReferenceNoIdWithType]) – A list of targets to which audit logs will be sent.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'log_targets': 'log_targets'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'log_targets': 'list[ReferenceNoIdWithType]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_audit_file_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_audit_file_response.PolicyAuditFileResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyAuditFile]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyAuditFile]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_get_response.PolicyGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Policy]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Policy]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_management_access module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_management_access.PolicyManagementAccess(name=None, id=None, context=None, policy_type=None, rules=None, aggregation_strategy=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, policy_type=None, rules=None, aggregation_strategy=None, enabled=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
policy_type (str) – The type of policy. Valid values include management-access, autodir, nfs, smb, snapshot, and quota.
rules (list[PolicyrulemanagementaccessRules]) – List the rules that defines the scoped roles.
aggregation_strategy (str) – When this is set to least-common-permissions, any users to whom this policy applies can receive no access rights exceeding those defined in this policy’s rules. When this is set to all-permissions, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them.
enabled (bool) – Returns a value of true if the policy is enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'aggregation_strategy': 'aggregation_strategy', 'context': 'context', 'enabled': 'enabled', 'id': 'id', 'name': 'name', 'policy_type': 'policy_type', 'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'aggregation_strategy': 'str', 'context': 'FixedReference', 'enabled': 'bool', 'id': 'str', 'name': 'str', 'policy_type': 'str', 'rules': 'list[PolicyrulemanagementaccessRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_management_access_effective module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_management_access_effective.PolicyManagementAccessEffective(details=None, rules=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(details=None, rules=None)
- Keyword Arguments
details (str) – Additional details about policy resolution.
rules (list[PolicyrulemanagementaccessRules]) – List the rules that defines the scoped roles.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'details': 'str', 'rules': 'list[PolicyrulemanagementaccessRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_management_access_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_management_access_get_response.PolicyManagementAccessGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyManagementAccess]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyManagementAccess]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_management_access_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_management_access_patch.PolicyManagementAccessPatch(name=None, rules=None, aggregation_strategy=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, rules=None, aggregation_strategy=None, enabled=None)
- Keyword Arguments
name (str) – The new name for the resource.
rules (list[PolicyrulemanagementaccessRules]) – List the rules that defines the scoped roles.
aggregation_strategy (str) – When this is set to least-common-permissions, any users to whom this policy applies can receive no access rights exceeding those defined in this policy’s capability and resource. When this is set to all-permissions, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them.
enabled (bool) – Sets whether the policy is enabled and grants the permissions specified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'aggregation_strategy': 'aggregation_strategy', 'enabled': 'enabled', 'name': 'name', 'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'aggregation_strategy': 'str', 'enabled': 'bool', 'name': 'str', 'rules': 'list[PolicyrulemanagementaccessRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_management_access_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_management_access_post.PolicyManagementAccessPost(enabled=None, rules=None, aggregation_strategy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None, rules=None, aggregation_strategy=None)
- Keyword Arguments
enabled (bool) – If set to true, enables the policy. If set to false, disables the policy.
rules (list[PolicyrulemanagementaccessRules]) – List the rules that defines the scoped roles.
aggregation_strategy (str) – When set to least-common-permissions, any users to whom this policy applies can receive no access rights exceeding those defined in this policy’s capability and resource. When this is set to all-permissions, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them. If not specified, defaults to all-permissions.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'aggregation_strategy': 'aggregation_strategy', 'enabled': 'enabled', 'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'aggregation_strategy': 'str', 'enabled': 'bool', 'rules': 'list[PolicyrulemanagementaccessRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_management_access_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_management_access_response.PolicyManagementAccessResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyManagementAccess]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyManagementAccess]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member.PolicyMember(context=None, time_remaining=None, destroyed=None, member=None, enabled=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, time_remaining=None, destroyed=None, member=None, enabled=None, policy=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, in milliseconds, until the destroyed policy member is permanently eradicated.
destroyed (bool) – Returns a value of true if the member is destroyed.
member (FixedReferenceWithType) – Reference to the resource that the policy is applied to.
enabled (bool) – Returns a value of true if the policy is enabled.
policy (FixedReferenceWithType) – Reference to the policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destroyed': 'destroyed', 'enabled': 'enabled', 'member': 'member', 'policy': 'policy', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'destroyed': 'bool', 'enabled': 'bool', 'member': 'FixedReferenceWithType', 'policy': 'FixedReferenceWithType', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_clean module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_clean.PolicyMemberClean(context=None, member=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, member=None, policy=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
member (FixedReferenceWithType) – Reference to the resource that the policy is applied to.
policy (FixedReferenceWithType) – Reference to the policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'member': 'member', 'policy': 'policy'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'member': 'FixedReferenceWithType', 'policy': 'FixedReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_clean_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_clean_get_response.PolicyMemberCleanGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyMemberClean]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyMemberClean]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_clean_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_clean_response.PolicyMemberCleanResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyMemberClean]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyMemberClean]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_export module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_export.PolicyMemberExport(context=None, time_remaining=None, destroyed=None, member=None, enabled=None, policy=None, export_name=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, time_remaining=None, destroyed=None, member=None, enabled=None, policy=None, export_name=None, status=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, in milliseconds, until the destroyed policy member is permanently eradicated.
destroyed (bool) – Returns a value of true if the member is destroyed.
member (FixedReferenceWithType) – Reference to the resource that the policy is applied to.
enabled (bool) – Returns a value of true if and only if the export policy that manages this export is enabled AND this export is enabled.
policy (FixedReferenceWithType) – Reference to the policy.
export_name (str) – The export name for accessing this export.
status (str) – Explains why enabled is false, or whether there is a name conflict with another export. Valid values include policy_disabled, export_disabled, and name_conflict.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destroyed': 'destroyed', 'enabled': 'enabled', 'export_name': 'export_name', 'member': 'member', 'policy': 'policy', 'status': 'status', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'destroyed': 'bool', 'enabled': 'bool', 'export_name': 'str', 'member': 'FixedReferenceWithType', 'policy': 'FixedReferenceWithType', 'status': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_export_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_export_get_response.PolicyMemberExportGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyMemberExport]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyMemberExport]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_export_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_export_post.PolicyMemberExportPost(members=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(members=None)
- Keyword Arguments
members (list[PolicymemberexportpostMembers]) – A list of directories to which the export policy may be applied.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'members': 'members'}
- keys()
- required_args = {}
- swagger_types = {'members': 'list[PolicymemberexportpostMembers]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_export_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_export_response.PolicyMemberExportResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyMemberExport]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyMemberExport]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_get_response.PolicyMemberGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyMember]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyMember]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_post.PolicyMemberPost(members=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(members=None)
- Keyword Arguments
members (list[PolicymemberpostMembers]) – A list of resources to which the policy may be applied.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'members': 'members'}
- keys()
- required_args = {}
- swagger_types = {'members': 'list[PolicymemberpostMembers]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_member_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_member_response.PolicyMemberResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyMember]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyMember]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_nfs module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_nfs.PolicyNfs(name=None, id=None, context=None, time_remaining=None, destroyed=None, policy_type=None, pod=None, enabled=None, security=None, policy_mapping=None, user_mapping_enabled=None, nfs_version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, policy_type=None, pod=None, enabled=None, security=None, policy_mapping=None, user_mapping_enabled=None, nfs_version=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated.
destroyed (bool) – Returns a value of true if the policy has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the policy is permanently eradicated and can no longer be recovered.
policy_type (str) – The type of policy. Valid values include autodir, nfs, smb, snapshot, and quota.
pod (Reference) – A reference to the pod.
enabled (bool) – Returns a value of true if the policy is enabled.
security (list[str]) – The security flavors to use for accessing files on this mount point. Values include auth_sys, auth_sys-partial, krb5, krb5-partial, krb5i, and krb5p. If the server does not support the requested flavor, the mount operation fails. If auth_sys, the client is trusted to specify the identity of the user. If krb5, cryptographic proof of the identity of the user is provided in each RPC request. Note that additional configuration besides adding this mount option is required in order to enable Kerberos security. If krb5i, integrity checking is added to krb5, to ensure the data has not been tampered with. If krb5p, integrity checking and encryption are added to krb5. This is the most secure setting, but it also involves the most performance overhead. If security option is allowed for all rules of the policy, it is cascaded exactly. Examples: auth_sys, krb5. If the security option is supported partially by the rules of the policy, it will be cascaded with the -partial suffix. Examples include: auth_sys-partial, krb5-partial. If the security option is not supported by any rules or there are no rules of the policy, then it will not be in the result array. If there are no rules in the policy the array of values will be empty. If there are two rules, one supporting auth_sys and the other supporting auth_sys and krb5 the array of values would contain auth_sys and krb5-partial.
policy_mapping (PolicyNfsPolicyMapping) – Specifies the mapping of this policy across a pod replica link. If this policy is not inside a pod of a pod replica link, mapping is null.
user_mapping_enabled (bool) – Returns true if user mapping is enabled on the policy. If true, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If false, users are defined by UID/GID pair.
nfs_version (list[str]) – NFS protocol version allowed for the export. If NFS version is allowed for all rules of the policy it is cascaded exactly as: nfsv3, nfsv4. If the NFS version is supported partially by the rules of the policy it will be cascaded as: nfsv3-partial, nfsv4-partial. If the NFS version is not supported by any rules or there are no rules of the policy then it will not be in the result array. If there are no rules in the policy the array will be empty. If there are two rules, one supporting nfsv3 and the other supporting nfsv3 and nfsv4 then the array would contain nfsv3 and nfsv4-partial.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destroyed': 'destroyed', 'enabled': 'enabled', 'id': 'id', 'name': 'name', 'nfs_version': 'nfs_version', 'pod': 'pod', 'policy_mapping': 'policy_mapping', 'policy_type': 'policy_type', 'security': 'security', 'time_remaining': 'time_remaining', 'user_mapping_enabled': 'user_mapping_enabled'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'destroyed': 'bool', 'enabled': 'bool', 'id': 'str', 'name': 'str', 'nfs_version': 'list[str]', 'pod': 'Reference', 'policy_mapping': 'PolicyNfsPolicyMapping', 'policy_type': 'str', 'security': 'list[str]', 'time_remaining': 'int', 'user_mapping_enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_nfs_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_nfs_get_response.PolicyNfsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyNfs]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyNfs]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_nfs_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_nfs_patch.PolicyNfsPatch(name=None, enabled=None, security=None, user_mapping_enabled=None, nfs_version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, enabled=None, security=None, user_mapping_enabled=None, nfs_version=None)
- Keyword Arguments
name (str) – The new name for the resource.
enabled (bool) – If set to true, enables the policy. If set to false, disables the policy.
security (list[str]) – The security flavors to use for accessing files on this mount point. Values include auth_sys, krb5, krb5i, and krb5p. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If auth_sys, the client is trusted to specify the identity of the user. If krb5, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If krb5i, integrity checking is added to krb5. This ensures the data has not been tampered with. If krb5p, integrity checking and encryption is added to krb5. This is the most secure setting, but it also involves the most performance overhead.
user_mapping_enabled (bool) – If set to true, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If set to false, users are defined by UID/GID pair.
nfs_version (list[str]) – NFS protocol version allowed for the export to set for the policy. This operation updates all rules of the specified policy. Valid values are nfsv3 and nfsv4.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'name': 'name', 'nfs_version': 'nfs_version', 'security': 'security', 'user_mapping_enabled': 'user_mapping_enabled'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'name': 'str', 'nfs_version': 'list[str]', 'security': 'list[str]', 'user_mapping_enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_nfs_policy_mapping module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_nfs_policy_mapping.PolicyNfsPolicyMapping(mapping=None, remote_policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(mapping=None, remote_policy=None)
- Keyword Arguments
mapping (str) – The mapping of this policy. Valid values are connected and disconnected.
remote_policy (str) – The policy on the remote pod of the pod replica link for this policy mapping.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'mapping': 'mapping', 'remote_policy': 'remote_policy'}
- keys()
- required_args = {}
- swagger_types = {'mapping': 'str', 'remote_policy': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_nfs_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_nfs_post.PolicyNfsPost(enabled=None, policy_mapping=None, user_mapping_enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None, policy_mapping=None, user_mapping_enabled=None)
- Keyword Arguments
enabled (bool) – If set to true, enables the policy. If set to false, disables the policy.
policy_mapping (PolicynfspostPolicyMapping) –
user_mapping_enabled (bool) – If set to true, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If set to false, users are defined by UID/GID pair. If not specified, defaults to true.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'policy_mapping': 'policy_mapping', 'user_mapping_enabled': 'user_mapping_enabled'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'policy_mapping': 'PolicynfspostPolicyMapping', 'user_mapping_enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_nfs_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_nfs_response.PolicyNfsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyNfs]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyNfs]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_password module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_password.PolicyPassword(name=None, id=None, context=None, max_password_age=None, enforce_dictionary_check=None, lockout_duration=None, policy_type=None, min_password_length=None, min_character_groups=None, max_login_attempts=None, enforce_username_check=None, min_characters_per_group=None, enabled=None, password_history=None, min_password_age=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, max_password_age=None, enforce_dictionary_check=None, lockout_duration=None, policy_type=None, min_password_length=None, min_character_groups=None, max_login_attempts=None, enforce_username_check=None, min_characters_per_group=None, enabled=None, password_history=None, min_password_age=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
max_password_age (int) – The maximum age of password before password change is required. Ranges from 1 day to 99999 days, with 0 meaning password expiration is disabled.
enforce_dictionary_check (bool) – If true, test password against dictionary of known leaked passwords. Only applies to passwords longer than 6 characters.
lockout_duration (int) – The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days.
policy_type (str) – The type of policy. Valid values include autodir, nfs, password, smb, snapshot, and quota.
min_password_length (int) – Minimum password length. If not specified, defaults to 1.
min_character_groups (int) – The minimum number of character groups ([a-z], [A-Z], [0-9], other) required to be present in a password.
max_login_attempts (int) – Maximum number of failed login attempts allowed before the user is locked out.
enforce_username_check (bool) – If true, the username cannot be a substring of the password. It only applies to usernames of 3 characters and longer.
min_characters_per_group (int) – The minimum number of characters per group to count the group as present. Maximum is limited by the minimum password length divided by the number of character groups (e.g. min_password_length = 9, min_character_groups = 4, then maximum is 2).
enabled (bool) – Returns a value of true if the policy is enabled.
password_history (int) – The number of passwords tracked to prevent reuse of passwords.
min_password_age (int) – The minimum age, in milliseconds, of password before password change is allowed. Ranges from 0 ms to 7 days
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'enabled': 'enabled', 'enforce_dictionary_check': 'enforce_dictionary_check', 'enforce_username_check': 'enforce_username_check', 'id': 'id', 'lockout_duration': 'lockout_duration', 'max_login_attempts': 'max_login_attempts', 'max_password_age': 'max_password_age', 'min_character_groups': 'min_character_groups', 'min_characters_per_group': 'min_characters_per_group', 'min_password_age': 'min_password_age', 'min_password_length': 'min_password_length', 'name': 'name', 'password_history': 'password_history', 'policy_type': 'policy_type'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'enabled': 'bool', 'enforce_dictionary_check': 'bool', 'enforce_username_check': 'bool', 'id': 'str', 'lockout_duration': 'int', 'max_login_attempts': 'int', 'max_password_age': 'int', 'min_character_groups': 'int', 'min_characters_per_group': 'int', 'min_password_age': 'int', 'min_password_length': 'int', 'name': 'str', 'password_history': 'int', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_password_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_password_get_response.PolicyPasswordGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyPassword]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyPassword]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_password_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_password_response.PolicyPasswordResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyPassword]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyPassword]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_patch.PolicyPatch(name=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, enabled=None)
- Keyword Arguments
name (str) – The new name for the resource.
enabled (bool) – If set to true, enables the policy. If set to false, disables the policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_post.PolicyPost(enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None)
- Keyword Arguments
enabled (bool) – If set to true, enables the policy. If set to false, disables the policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_response.PolicyResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Policy]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Policy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher.PolicyRuleAlertWatcher(context=None, name=None, minimum_notification_severity=None, included_codes=None, email=None, excluded_codes=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, name=None, minimum_notification_severity=None, included_codes=None, email=None, excluded_codes=None, policy=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
name (str) – Name of this rule. The name is automatically generated by the system.
minimum_notification_severity (str) – The minimum severity that an alert must have in order for emails to be sent to the recipient. Possible values include info, warning, and critical.
included_codes (list[int]) – An alert must have one of these codes in order for emails to be sent to the recipient. Cannot be specified with exclude_codes. If specified while exclude_codes is already set, exclude_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes and emails for all alert codes will be sent.
email (str) – The email address that will receive the alert notification emails.
excluded_codes (list[int]) – An alert with one of these codes will not have emails sent to the recipient. Cannot be specified with include_codes. If specified while include_codes is already set, include_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes and emails for all alert codes will be sent.
policy (FixedReferenceWithType) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'email': 'email', 'excluded_codes': 'excluded_codes', 'included_codes': 'included_codes', 'minimum_notification_severity': 'minimum_notification_severity', 'name': 'name', 'policy': 'policy'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'email': 'str', 'excluded_codes': 'list[int]', 'included_codes': 'list[int]', 'minimum_notification_severity': 'str', 'name': 'str', 'policy': 'FixedReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher_get_response.PolicyRuleAlertWatcherGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyRuleAlertWatcher]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyRuleAlertWatcher]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher_patch.PolicyRuleAlertWatcherPatch(rules=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(rules=None)
- Keyword Arguments
rules (list[PolicyrulealertwatcherpatchRules]) – Updates an alert-watcher rule in a policy. Only one update object will be accepted.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'rules': 'list[PolicyrulealertwatcherpatchRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher_post.PolicyRuleAlertWatcherPost(rules=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(rules=None)
- Keyword Arguments
rules (list[PolicyrulealertwatcherpostRules]) – A list of alert-watcher policy rules to create.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'rules': 'list[PolicyrulealertwatcherpostRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_alert_watcher_response.PolicyRuleAlertWatcherResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyRuleAlertWatcher]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyRuleAlertWatcher]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_nfs_client module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_nfs_client.PolicyRuleNfsClient(context=None, time_remaining=None, destroyed=None, security=None, access=None, anonuid=None, anongid=None, name=None, client=None, permission=None, nfs_version=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, time_remaining=None, destroyed=None, security=None, access=None, anonuid=None, anongid=None, name=None, client=None, permission=None, nfs_version=None, policy=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, in milliseconds, until the destroyed NFS policy rule is permanently eradicated.
destroyed (bool) – Returns a value of true if the pod containing the NFS policy rule has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the NFS policy rule is permanently eradicated and can no longer be recovered.
security (list[str]) – The security flavors to use for accessing files on this mount point. Values include auth_sys, krb5, krb5i, and krb5p. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If auth_sys, the client is trusted to specify the identity of the user. If krb5, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If krb5i, integrity checking is added to krb5. This ensures the data has not been tampered with. If krb5p, integrity checking and encryption is added to krb5. This is the most secure setting, but it also involves the most performance overhead.
access (str) – Specifies access control for the export. Valid values are root-squash, all-squash, and no-root-squash. root-squash prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID 0 will have their UID mapped to anonuid. All users with GID 0 will have their GID mapped to anongid. all-squash maps all UIDs (including root) to anonuid and all GIDs (including root) to anongid. no-root-squash allows users and groups to access the file system with their UIDs and GIDs. The default is root-squash if not specified.
anonuid (str) – Any user whose UID is affected by an access of root_squash or all_squash will have their UID mapped to anonuid. The default anonuid is null, which means 65534. Use “” to clear.
anongid (str) – Any user whose GID is affected by an access of root_squash or all_squash will have their GID mapped to anongid. The default anongid is null, which means 65534. Use “” to clear. This value is ignored when user mapping is enabled - see User Guide for more details.
name (str) – Name of this rule. The name is automatically generated by the system.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation includes IP, IP mask, or hostname. The default is * if not specified.
permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro. The default is rw if not specified.
nfs_version (list[str]) – The NFS protocol version allowed for the export. Valid values are nfsv3 and nfsv4.
policy (FixedReferenceWithType) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access': 'access', 'anongid': 'anongid', 'anonuid': 'anonuid', 'client': 'client', 'context': 'context', 'destroyed': 'destroyed', 'name': 'name', 'nfs_version': 'nfs_version', 'permission': 'permission', 'policy': 'policy', 'security': 'security', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'access': 'str', 'anongid': 'str', 'anonuid': 'str', 'client': 'str', 'context': 'FixedReference', 'destroyed': 'bool', 'name': 'str', 'nfs_version': 'list[str]', 'permission': 'str', 'policy': 'FixedReferenceWithType', 'security': 'list[str]', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_nfs_client_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_nfs_client_get_response.PolicyRuleNfsClientGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyRuleNfsClient]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyRuleNfsClient]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_nfs_client_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_nfs_client_post.PolicyRuleNfsClientPost(rules=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(rules=None)
- Keyword Arguments
rules (list[PolicyrulenfsclientpostRules]) – A list of NFS policy rules to create.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'rules': 'list[PolicyrulenfsclientpostRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_nfs_client_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_nfs_client_response.PolicyRuleNfsClientResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyRuleNfsClient]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyRuleNfsClient]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_quota module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_quota.PolicyRuleQuota(context=None, quota_limit=None, time_remaining=None, enforced=None, destroyed=None, name=None, notifications=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, quota_limit=None, time_remaining=None, enforced=None, destroyed=None, name=None, notifications=None, policy=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
quota_limit (int) – Logical space limit of the quota assigned by the rule, measured in bytes. This value cannot be set to 0.
time_remaining (int) – The amount of time left, in milliseconds, until the destroyed quota policy rule is permanently eradicated.
enforced (bool) – Defines whether the quota rule is enforced or unenforced. If the quota rule is enforced and logical space usage exceeds the quota limit, any modification operations that result in a need for more space are blocked. If the quota rule is unenforced and logical space usage exceeds the quota limit, notification emails are sent to targets that are specified using the notification parameter. No client operations are blocked when an unenforced limit is exceeded. If set to true, the limit is enforced. If set to false, notification targets are informed when the usage exceeds 80 percent of the limit.
destroyed (bool) – Returns a value of true if the pod containing the quota policy rule has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the quota policy rule is permanently eradicated and can no longer be recovered.
name (str) – Name of this rule. The name is automatically generated by the system.
notifications (str) – Targets to notify when usage approaches the quota limit. The list of notification targets is a comma-separated string. Valid values are user, and group. If not specified, notification targets are not assigned for the rule.
policy (FixedReferenceWithType) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destroyed': 'destroyed', 'enforced': 'enforced', 'name': 'name', 'notifications': 'notifications', 'policy': 'policy', 'quota_limit': 'quota_limit', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'destroyed': 'bool', 'enforced': 'bool', 'name': 'str', 'notifications': 'str', 'policy': 'FixedReferenceWithType', 'quota_limit': 'int', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_quota_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_quota_get_response.PolicyRuleQuotaGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyRuleQuota]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyRuleQuota]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_quota_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_quota_patch.PolicyRuleQuotaPatch(rules=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(rules=None)
- Keyword Arguments
rules (list[PolicyrulequotapatchRules]) – Updates rules in a policy and accepts a single-rule update object. The list can contain only one item that will update all the specified rules.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'rules': 'list[PolicyrulequotapatchRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_quota_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_quota_post.PolicyRuleQuotaPost(rules=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(rules=None)
- Keyword Arguments
rules (list[PolicyrulequotapostRules]) – A list of quota policy rules to create.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'rules': 'list[PolicyrulequotapostRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_quota_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_quota_response.PolicyRuleQuotaResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyRuleQuota]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyRuleQuota]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_smb_client module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_smb_client.PolicyRuleSmbClient(context=None, time_remaining=None, destroyed=None, anonymous_access_allowed=None, name=None, client=None, smb_encryption_required=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, time_remaining=None, destroyed=None, anonymous_access_allowed=None, name=None, client=None, smb_encryption_required=None, policy=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, in milliseconds, until the destroyed SMB policy rule is permanently eradicated.
destroyed (bool) – Returns a value of true if the pod containing the SMB policy rule has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the SMB policy rule is permanently eradicated and can no longer be recovered.
anonymous_access_allowed (bool) – Specifies whether access to information is allowed for anonymous users. Returns a value of false if not specified.
name (str) – Name of this rule. The name is automatically generated by the system.
client (str) – Specifies which clients are given access to the export. Accepted notation includes IP, IP mask, or hostname. The default is * if not specified.
smb_encryption_required (bool) – Specifies whether the remote client is required to use SMB encryption. If not specified, defaults to false.
policy (FixedReferenceWithType) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'anonymous_access_allowed': 'anonymous_access_allowed', 'client': 'client', 'context': 'context', 'destroyed': 'destroyed', 'name': 'name', 'policy': 'policy', 'smb_encryption_required': 'smb_encryption_required', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'anonymous_access_allowed': 'bool', 'client': 'str', 'context': 'FixedReference', 'destroyed': 'bool', 'name': 'str', 'policy': 'FixedReferenceWithType', 'smb_encryption_required': 'bool', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_smb_client_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_smb_client_get_response.PolicyRuleSmbClientGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyRuleSmbClient]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyRuleSmbClient]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_smb_client_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_smb_client_post.PolicyRuleSmbClientPost(rules=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(rules=None)
- Keyword Arguments
rules (list[PolicyrulesmbclientpostRules]) – A list of SMB policy rules to create.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'rules': 'list[PolicyrulesmbclientpostRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_smb_client_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_smb_client_response.PolicyRuleSmbClientResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyRuleSmbClient]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyRuleSmbClient]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_snapshot module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_snapshot.PolicyRuleSnapshot(context=None, time_remaining=None, destroyed=None, at=None, name=None, keep_for=None, suffix=None, client_name=None, every=None, policy=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, time_remaining=None, destroyed=None, at=None, name=None, keep_for=None, suffix=None, client_name=None, every=None, policy=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, in milliseconds, until the destroyed snapshot policy rule is permanently eradicated.
destroyed (bool) – Returns a value of true if the pod containing the snapshot policy rule has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the snapshot policy rule is permanently eradicated and can no longer be recovered.
at (int) – Specifies the number of milliseconds since midnight at which to take a snapshot. The at value can only be set to an hour and must be between 0 and 82800000, inclusive. The at value can only be set on the rule with the smallest every value. The at value cannot be set if the every value is not measured in days. The at value can only be set for at most one rule in the same policy.
name (str) – Name of this rule. The name is automatically generated by the system.
keep_for (int) – Specifies the period that snapshots are retained before they are eradicated, in milliseconds. The keep_for value cannot be less than the every value of the rule. The keep_for value must be unique for each rule in the same policy. The keep_for value must be between 5 minutes and 5 years. The keep_for value cannot be less than the keep_for value of any rule in the same policy with a smaller every value.
suffix (str) – The snapshot suffix name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the snapshot client name, and SUFFIX is the snapshot suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX. The suffix value can only be set for one rule in the same policy. The suffix value can only be set on a rule with the same keep_for value and every value. The suffix value can only be set on the rule with the largest keep_for value. If not specified, defaults to a monotonically increasing number generated by the system.
client_name (str) – The snapshot client name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the snapshot client name, and SUFFIX is the snapshot suffix. The client visible snapshot name is CLIENT_NAME.SUFFIX.
every (int) – Specifies the interval between snapshots, in milliseconds. The every value for all rules must be multiples of one another. The every value must be unique for each rule in the same policy. The every value must be between 5 minutes and 1 year.
policy (FixedReferenceWithType) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'at': 'at', 'client_name': 'client_name', 'context': 'context', 'destroyed': 'destroyed', 'every': 'every', 'keep_for': 'keep_for', 'name': 'name', 'policy': 'policy', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'at': 'int', 'client_name': 'str', 'context': 'FixedReference', 'destroyed': 'bool', 'every': 'int', 'keep_for': 'int', 'name': 'str', 'policy': 'FixedReferenceWithType', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_snapshot_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_snapshot_get_response.PolicyRuleSnapshotGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicyRuleSnapshot]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicyRuleSnapshot]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_snapshot_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_snapshot_post.PolicyRuleSnapshotPost(rules=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(rules=None)
- Keyword Arguments
rules (list[PolicyrulesnapshotpostRules]) – A list of snapshot policy rules to create.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- keys()
- required_args = {}
- swagger_types = {'rules': 'list[PolicyrulesnapshotpostRules]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_rule_snapshot_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_rule_snapshot_response.PolicyRuleSnapshotResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicyRuleSnapshot]) – Displays a list of all items after filtering. The values are displayed for each name, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicyRuleSnapshot]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_smb module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_smb.PolicySmb(name=None, id=None, context=None, time_remaining=None, destroyed=None, policy_type=None, pod=None, enabled=None, policy_mapping=None, access_based_enumeration_enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, policy_type=None, pod=None, enabled=None, policy_mapping=None, access_based_enumeration_enabled=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated.
destroyed (bool) – Returns a value of true if the policy has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the policy is permanently eradicated and can no longer be recovered.
policy_type (str) – The type of policy. Valid values include autodir, nfs, smb, snapshot, and quota.
pod (Reference) – A reference to the pod.
enabled (bool) – Returns a value of true if the policy is enabled.
policy_mapping (PolicyNfsPolicyMapping) – Specifies the mapping of this policy across a pod replica link. If this policy is not inside a pod of a pod replica link, mapping is null.
access_based_enumeration_enabled (bool) – Returns a value of true if access based enumeration is enabled on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_based_enumeration_enabled': 'access_based_enumeration_enabled', 'context': 'context', 'destroyed': 'destroyed', 'enabled': 'enabled', 'id': 'id', 'name': 'name', 'pod': 'pod', 'policy_mapping': 'policy_mapping', 'policy_type': 'policy_type', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'access_based_enumeration_enabled': 'bool', 'context': 'FixedReference', 'destroyed': 'bool', 'enabled': 'bool', 'id': 'str', 'name': 'str', 'pod': 'Reference', 'policy_mapping': 'PolicyNfsPolicyMapping', 'policy_type': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_smb_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_smb_get_response.PolicySmbGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[PolicySmb]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PolicySmb]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_smb_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_smb_patch.PolicySmbPatch(name=None, enabled=None, access_based_enumeration_enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, enabled=None, access_based_enumeration_enabled=None)
- Keyword Arguments
name (str) – The new name for the resource.
enabled (bool) – If set to true, enables the policy. If set to false, disables the policy.
access_based_enumeration_enabled (bool) – If set to true, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_based_enumeration_enabled': 'access_based_enumeration_enabled', 'enabled': 'enabled', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'access_based_enumeration_enabled': 'bool', 'enabled': 'bool', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_smb_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_smb_post.PolicySmbPost(enabled=None, policy_mapping=None, access_based_enumeration_enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(enabled=None, policy_mapping=None, access_based_enumeration_enabled=None)
- Keyword Arguments
enabled (bool) – If set to true, enables the policy. If set to false, disables the policy.
policy_mapping (PolicynfspostPolicyMapping) –
access_based_enumeration_enabled (bool) – If set to true, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them. If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_based_enumeration_enabled': 'access_based_enumeration_enabled', 'enabled': 'enabled', 'policy_mapping': 'policy_mapping'}
- keys()
- required_args = {}
- swagger_types = {'access_based_enumeration_enabled': 'bool', 'enabled': 'bool', 'policy_mapping': 'PolicynfspostPolicyMapping'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policy_smb_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policy_smb_response.PolicySmbResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PolicySmb]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PolicySmb]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policymemberexportpost_members module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policymemberexportpost_members.PolicymemberexportpostMembers(export_enabled=None, export_name=None, member=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(export_enabled=None, export_name=None, member=None)
- Keyword Arguments
export_enabled (bool) – If set to true, the export is enabled. If not specified, defaults to true.
export_name (str) – The name of the export to create when applying the export policy to the directory. Export names must be unique within the same protocol.
member (ReferenceWithType) – Reference to the directory to which the export policy may be applied. The id or name parameter is required, but they cannot be set together. If the name parameter is set, resource_type must also be set.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'export_enabled': 'export_enabled', 'export_name': 'export_name', 'member': 'member'}
- keys()
- required_args = {}
- swagger_types = {'export_enabled': 'bool', 'export_name': 'str', 'member': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policymemberpost_members module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policymemberpost_members.PolicymemberpostMembers(member=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(member=None)
- Keyword Arguments
member (ReferenceWithType) – Reference to the resource to which the policy may be applied. The id or name parameter is required, but they cannot be set together. If the name parameter is set, resource_type must also be set.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'member': 'member'}
- keys()
- required_args = {}
- swagger_types = {'member': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policynfspost_policy_mapping module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policynfspost_policy_mapping.PolicynfspostPolicyMapping(mapping=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(mapping=None)
- Keyword Arguments
mapping (str) – The mapping of this policy. Valid values are connected and disconnected.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'mapping': 'mapping'}
- keys()
- required_args = {}
- swagger_types = {'mapping': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policyrulealertwatcherpatch_rules module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policyrulealertwatcherpatch_rules.PolicyrulealertwatcherpatchRules(minimum_notification_severity=None, included_codes=None, email=None, excluded_codes=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(minimum_notification_severity=None, included_codes=None, email=None, excluded_codes=None)
- Keyword Arguments
minimum_notification_severity (str) – The minimum severity that an alert must have in order for emails to be sent to the recipient. Possible values include info, warning, and critical.
included_codes (list[int]) – An alert must have one of these codes in order for emails to be sent to the recipient. Cannot be specified with exclude_codes. If specified while exclude_codes is already set, exclude_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes.
email (str) – The email address that will receive the alert notification emails.
excluded_codes (list[int]) – An alert with one of these codes will not have emails sent to the recipient. Cannot be specified with include_codes. If specified while include_codes is already set, include_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'email': 'email', 'excluded_codes': 'excluded_codes', 'included_codes': 'included_codes', 'minimum_notification_severity': 'minimum_notification_severity'}
- keys()
- required_args = {}
- swagger_types = {'email': 'str', 'excluded_codes': 'list[int]', 'included_codes': 'list[int]', 'minimum_notification_severity': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policyrulealertwatcherpost_rules module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policyrulealertwatcherpost_rules.PolicyrulealertwatcherpostRules(minimum_notification_severity=None, included_codes=None, email=None, excluded_codes=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(minimum_notification_severity=None, included_codes=None, email=None, excluded_codes=None)
- Keyword Arguments
minimum_notification_severity (str) – The minimum severity that an alert must have in order for emails to be sent to the recipient. Possible values include info, warning, and critical. If not specified, defaults to info.
included_codes (list[int]) – An alert must have one of these codes in order for emails to be sent to the recipient. Cannot be specified with exclude_codes. If specified while exclude_codes is already set, exclude_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes.
email (str) – The email address that will receive the alert notification emails.
excluded_codes (list[int]) – An alert with one of these codes will not have emails sent to the recipient. Cannot be specified with include_codes. If specified while include_codes is already set, include_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'email': 'email', 'excluded_codes': 'excluded_codes', 'included_codes': 'included_codes', 'minimum_notification_severity': 'minimum_notification_severity'}
- keys()
- required_args = {}
- swagger_types = {'email': 'str', 'excluded_codes': 'list[int]', 'included_codes': 'list[int]', 'minimum_notification_severity': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policyrulemanagementaccess_rules module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policyrulemanagementaccess_rules.PolicyrulemanagementaccessRules(role=None, scope=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(role=None, scope=None)
- Keyword Arguments
role (ReferenceNoId) – Role defines a set of permissions applicable in a scope. viewer grants users the ability to read a resource. support grants the ability to perform general support-related actions, as well as read resources. storage grants access to all storage operations on a resource. admin grants access to all operations.
scope (ReferenceWithType) – Reference to the resource (e.g. arrays, realms) which specifies the scope that the role applies. The id or name parameter is required, but they cannot be set together. Also, resource_type must be set.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'role': 'role', 'scope': 'scope'}
- keys()
- required_args = {}
- swagger_types = {'role': 'ReferenceNoId', 'scope': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policyrulenfsclientpost_rules module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policyrulenfsclientpost_rules.PolicyrulenfsclientpostRules(security=None, access=None, anonuid=None, anongid=None, client=None, permission=None, nfs_version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(security=None, access=None, anonuid=None, anongid=None, client=None, permission=None, nfs_version=None)
- Keyword Arguments
security (list[str]) – The security flavors to use for accessing files on this mount point. Values include auth_sys, krb5, krb5i, and krb5p. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If auth_sys, the client is trusted to specify the identity of the user. If krb5, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If krb5i, integrity checking is added to krb5. This ensures the data has not been tampered with. If krb5p, integrity checking and encryption is added to krb5. This is the most secure setting, but it also involves the most performance overhead.
access (str) – Specifies access control for the export. Valid values include root-squash, all-squash, and no-root-squash. The value root-squash prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID 0 will have their UID mapped to anonuid. All users with GID 0 will have their GID mapped to anongid. The value all-squash maps all UIDs (including root) to anonuid and all GIDs (including root) to anongid. The value no-root-squash allows users and groups to access the file system with their UIDs and GIDs. If not specified, the default value is root-squash.
anonuid (str) – Any user whose UID is affected by an access of root_squash or all_squash will have their UID mapped to anonuid. The default anonuid is null, which means 65534. Use “” to clear.
anongid (str) – Any user whose GID is affected by an access of root_squash or all_squash will have their GID mapped to anongid. The default anongid is null, which means 65534. Use “” to clear. This value is ignored when user mapping is enabled.
client (str) – Specifies which clients are given access. Valid values include IP, IP mask, or hostname. The default is * if not specified.
permission (str) – Specifies which read-write client access permissions are allowed for the export. Values include rw and ro. The default value is rw if not specified.
nfs_version (list[str]) – NFS protocol version allowed for the export. Valid values are nfsv3 and nfsv4. If not specified, defaults to nfsv3.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access': 'access', 'anongid': 'anongid', 'anonuid': 'anonuid', 'client': 'client', 'nfs_version': 'nfs_version', 'permission': 'permission', 'security': 'security'}
- keys()
- required_args = {}
- swagger_types = {'access': 'str', 'anongid': 'str', 'anonuid': 'str', 'client': 'str', 'nfs_version': 'list[str]', 'permission': 'str', 'security': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policyrulequotapatch_rules module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policyrulequotapatch_rules.PolicyrulequotapatchRules(quota_limit=None, enforced=None, notifications=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(quota_limit=None, enforced=None, notifications=None)
- Keyword Arguments
quota_limit (int) – Logical space limit of the quota (in bytes) assigned by the rule. This value cannot be set to 0.
enforced (bool) – If set to true, this rule describes an enforced quota. An out-of-space warning is issued if logical space usage exceeds the limit value described in this rule. If set to false, this rule describes an unenforced quota. Alerts and/or notifications are issued when logical space usage exceeds the limit value described in this rule.
notifications (str) – Targets to notify when usage approaches the quota limit. The list of notification targets is a comma-separated string. Valid values are one or more of user and group. To notify no targets, use none.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enforced': 'enforced', 'notifications': 'notifications', 'quota_limit': 'quota_limit'}
- keys()
- required_args = {}
- swagger_types = {'enforced': 'bool', 'notifications': 'str', 'quota_limit': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policyrulequotapost_rules module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policyrulequotapost_rules.PolicyrulequotapostRules(quota_limit=None, enforced=None, notifications=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(quota_limit=None, enforced=None, notifications=None)
- Keyword Arguments
quota_limit (int) – Logical space limit of the quota (in bytes) assigned by the rule. This value cannot be set to 0.
enforced (bool) – If set to true, this rule describes an enforced quota. An out-of-space warning is issued if logical space usage exceeds the limit value described in this rule. If set to false, this rule describes an unenforced quota. Alerts and/or notifications are issued when logical space usage exceeds the limit value described in this rule. If not specified, defaults to false.
notifications (str) – Targets to notify when usage approaches the quota limit. The list of notification targets is a comma-separated string. Valid values are one or more of user and group. To notify no targets, use none. If not specified, defaults to none.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enforced': 'enforced', 'notifications': 'notifications', 'quota_limit': 'quota_limit'}
- keys()
- required_args = {}
- swagger_types = {'enforced': 'bool', 'notifications': 'str', 'quota_limit': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policyrulesmbclientpost_rules module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policyrulesmbclientpost_rules.PolicyrulesmbclientpostRules(anonymous_access_allowed=None, client=None, smb_encryption_required=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(anonymous_access_allowed=None, client=None, smb_encryption_required=None)
- Keyword Arguments
anonymous_access_allowed (bool) – Specifies whether access to information is allowed for anonymous users. If not specified, defaults to false.
client (str) – Specifies which clients are given access. Accepted notation, IP, IP mask, or hostname. The default is * if not specified.
smb_encryption_required (bool) – Specifies whether the remote client is required to use SMB encryption. If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'anonymous_access_allowed': 'anonymous_access_allowed', 'client': 'client', 'smb_encryption_required': 'smb_encryption_required'}
- keys()
- required_args = {}
- swagger_types = {'anonymous_access_allowed': 'bool', 'client': 'str', 'smb_encryption_required': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.policyrulesnapshotpost_rules module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.policyrulesnapshotpost_rules.PolicyrulesnapshotpostRules(at=None, keep_for=None, suffix=None, client_name=None, every=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(at=None, keep_for=None, suffix=None, client_name=None, every=None)
- Keyword Arguments
at (int) – Specifies the number of milliseconds since midnight at which to take a snapshot. The at value can only be set to an hour and must be between 0 and 82800000, inclusive. The at value can only be set on the rule with the smallest every value. The at value cannot be set if the every value is not measured in days. The at value can only be set for at most one rule in the same policy.
keep_for (int) – Specifies the period that snapshots are retained before they are eradicated, in milliseconds. The keep_for value cannot be less than the every value of the rule. The keep_for value must be unique for each rule in the same policy. The keep_for value must be between 5 minutes and 5 years. The keep_for value cannot be less than the keep_for value of any rule in the same policy with a smaller every value.
suffix (str) – The snapshot suffix name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the snapshot client name, and SUFFIX is the snapshot suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX. The suffix value can only be set for one rule in the same policy. The suffix value can only be set on a rule with the same keep_for value and every value. The suffix value can only be set on the rule with the largest keep_for value. If not specified, defaults to a monotonically increasing number generated by the system.
client_name (str) – The snapshot client name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the snapshot client name, and SUFFIX is the snapshot suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX.
every (int) – Specifies the interval between snapshots, in milliseconds. The every value for all rules must be multiples of one another. The every value must be unique for each rule in the same policy. The every value must be between 5 minutes and 1 year.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'at': 'at', 'client_name': 'client_name', 'every': 'every', 'keep_for': 'keep_for', 'suffix': 'suffix'}
- keys()
- required_args = {}
- swagger_types = {'at': 'int', 'client_name': 'str', 'every': 'int', 'keep_for': 'int', 'suffix': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.port module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.port.Port(name=None, iqn=None, nqn=None, portal=None, wwn=None, failover=None, context=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, iqn=None, nqn=None, portal=None, wwn=None, failover=None, context=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
iqn (str) – The iSCSI Qualified Name (or null if target is not iSCSI).
nqn (str) – NVMe Qualified Name (or null if target is not NVMeoF).
portal (str) – IP and port number (or null if target is not iSCSI).
wwn (str) – Fibre Channel World Wide Name (or null if target is not Fibre Channel).
failover (str) – If the array port has failed over, returns the name of the port to which this port has failed over.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'failover': 'failover', 'iqn': 'iqn', 'name': 'name', 'nqn': 'nqn', 'portal': 'portal', 'wwn': 'wwn'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'failover': 'str', 'iqn': 'str', 'name': 'str', 'nqn': 'str', 'portal': 'str', 'wwn': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.port_common module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.port_common.PortCommon(iqn=None, nqn=None, portal=None, wwn=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(iqn=None, nqn=None, portal=None, wwn=None)
- Keyword Arguments
iqn (str) – The iSCSI Qualified Name (or null if target is not iSCSI).
nqn (str) – NVMe Qualified Name (or null if target is not NVMeoF).
portal (str) – IP and port number (or null if target is not iSCSI).
wwn (str) – Fibre Channel World Wide Name (or null if target is not Fibre Channel).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'iqn': 'iqn', 'nqn': 'nqn', 'portal': 'portal', 'wwn': 'wwn'}
- keys()
- required_args = {}
- swagger_types = {'iqn': 'str', 'nqn': 'str', 'portal': 'str', 'wwn': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.port_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.port_get_response.PortGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[Port]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Port]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.port_initiator module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.port_initiator.PortInitiator(context=None, initiator=None, target=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, initiator=None, target=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
initiator (PortCommon) –
target (PortInitiatorTarget) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'initiator': 'initiator', 'target': 'target'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'initiator': 'PortCommon', 'target': 'PortInitiatorTarget'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.port_initiator_target module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.port_initiator_target.PortInitiatorTarget(name=None, iqn=None, nqn=None, portal=None, wwn=None, failover=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, iqn=None, nqn=None, portal=None, wwn=None, failover=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
iqn (str) – The iSCSI Qualified Name (or null if target is not iSCSI).
nqn (str) – NVMe Qualified Name (or null if target is not NVMeoF).
portal (str) – IP and port number (or null if target is not iSCSI).
wwn (str) – Fibre Channel World Wide Name (or null if target is not Fibre Channel).
failover (str) – If the array port has failed over, returns the name of the port to which this port has failed over.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'failover': 'failover', 'iqn': 'iqn', 'name': 'name', 'nqn': 'nqn', 'portal': 'portal', 'wwn': 'wwn'}
- keys()
- required_args = {}
- swagger_types = {'failover': 'str', 'iqn': 'str', 'name': 'str', 'nqn': 'str', 'portal': 'str', 'wwn': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.port_initiators_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.port_initiators_get_response.PortInitiatorsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[PortInitiator]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PortInitiator]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload.PresetWorkload(volume_configurations, placement_configurations, workload_type, name=None, id=None, context=None, periodic_replication_configurations=None, description=None, workload_tags=None, parameters=None, qos_configurations=None, snapshot_configurations=None, revision=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(volume_configurations, placement_configurations, workload_type, name=None, id=None, context=None, periodic_replication_configurations=None, description=None, workload_tags=None, parameters=None, qos_configurations=None, snapshot_configurations=None, revision=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
volume_configurations (list[PresetWorkloadVolumeConfiguration], required) – The volumes that will be provisioned by the preset.
periodic_replication_configurations (list[PresetWorkloadPeriodicReplicationConfiguration]) – The periodic replication configurations that can be applied to storage resources (such as volumes) within the preset.
description (str) – A brief description of the workload the preset will configure. Supports up to 1KB of unicode characters.
placement_configurations (list[PresetWorkloadPlacementConfiguration], required) – The placement configurations that can be applied to storage resources (such as volumes) within the preset. All storage resources associated with the same placement will be colocated on the same array.
workload_tags (list[PresetWorkloadWorkloadTag]) – The tags that will be associated with workloads provisioned by the preset.
parameters (list[PresetWorkloadParameter]) – The parameters to prompt the user when they deploy workloads from the preset.
qos_configurations (list[PresetWorkloadQosConfiguration]) – The QoS configurations that can be applied to storage resources (such as volumes) within the preset.
snapshot_configurations (list[PresetWorkloadSnapshotConfiguration]) – The snapshot configurations that can be applied to storage resources (such as volumes) within the preset.
workload_type (str, required) – The type of workload the preset will configure. Valid values include VDI, File, MySQL etc.
revision (int) – A counter that is automatically incremented by the server when the preset is updated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'description': 'description', 'id': 'id', 'name': 'name', 'parameters': 'parameters', 'periodic_replication_configurations': 'periodic_replication_configurations', 'placement_configurations': 'placement_configurations', 'qos_configurations': 'qos_configurations', 'revision': 'revision', 'snapshot_configurations': 'snapshot_configurations', 'volume_configurations': 'volume_configurations', 'workload_tags': 'workload_tags', 'workload_type': 'workload_type'}
- keys()
- required_args = {'placement_configurations', 'volume_configurations', 'workload_type'}
- swagger_types = {'context': 'FixedReference', 'description': 'str', 'id': 'str', 'name': 'str', 'parameters': 'list[PresetWorkloadParameter]', 'periodic_replication_configurations': 'list[PresetWorkloadPeriodicReplicationConfiguration]', 'placement_configurations': 'list[PresetWorkloadPlacementConfiguration]', 'qos_configurations': 'list[PresetWorkloadQosConfiguration]', 'revision': 'int', 'snapshot_configurations': 'list[PresetWorkloadSnapshotConfiguration]', 'volume_configurations': 'list[PresetWorkloadVolumeConfiguration]', 'workload_tags': 'list[PresetWorkloadWorkloadTag]', 'workload_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_base module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_base.PresetWorkloadBase(volume_configurations, placement_configurations, workload_type, periodic_replication_configurations=None, description=None, workload_tags=None, parameters=None, qos_configurations=None, snapshot_configurations=None, revision=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(volume_configurations, placement_configurations, workload_type, periodic_replication_configurations=None, description=None, workload_tags=None, parameters=None, qos_configurations=None, snapshot_configurations=None, revision=None)
- Keyword Arguments
volume_configurations (list[PresetWorkloadVolumeConfiguration], required) – The volumes that will be provisioned by the preset.
periodic_replication_configurations (list[PresetWorkloadPeriodicReplicationConfiguration]) – The periodic replication configurations that can be applied to storage resources (such as volumes) within the preset.
description (str) – A brief description of the workload the preset will configure. Supports up to 1KB of unicode characters.
placement_configurations (list[PresetWorkloadPlacementConfiguration], required) – The placement configurations that can be applied to storage resources (such as volumes) within the preset. All storage resources associated with the same placement will be colocated on the same array.
workload_tags (list[PresetWorkloadWorkloadTag]) – The tags that will be associated with workloads provisioned by the preset.
parameters (list[PresetWorkloadParameter]) – The parameters to prompt the user when they deploy workloads from the preset.
qos_configurations (list[PresetWorkloadQosConfiguration]) – The QoS configurations that can be applied to storage resources (such as volumes) within the preset.
snapshot_configurations (list[PresetWorkloadSnapshotConfiguration]) – The snapshot configurations that can be applied to storage resources (such as volumes) within the preset.
workload_type (str, required) – The type of workload the preset will configure. Valid values include VDI, File, MySQL etc.
revision (int) – A counter that is automatically incremented by the server when the preset is updated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'description': 'description', 'parameters': 'parameters', 'periodic_replication_configurations': 'periodic_replication_configurations', 'placement_configurations': 'placement_configurations', 'qos_configurations': 'qos_configurations', 'revision': 'revision', 'snapshot_configurations': 'snapshot_configurations', 'volume_configurations': 'volume_configurations', 'workload_tags': 'workload_tags', 'workload_type': 'workload_type'}
- keys()
- required_args = {'placement_configurations', 'volume_configurations', 'workload_type'}
- swagger_types = {'description': 'str', 'parameters': 'list[PresetWorkloadParameter]', 'periodic_replication_configurations': 'list[PresetWorkloadPeriodicReplicationConfiguration]', 'placement_configurations': 'list[PresetWorkloadPlacementConfiguration]', 'qos_configurations': 'list[PresetWorkloadQosConfiguration]', 'revision': 'int', 'snapshot_configurations': 'list[PresetWorkloadSnapshotConfiguration]', 'volume_configurations': 'list[PresetWorkloadVolumeConfiguration]', 'workload_tags': 'list[PresetWorkloadWorkloadTag]', 'workload_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_constraints module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_constraints.PresetWorkloadConstraints(boolean=None, string=None, integer=None, resource_reference=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(boolean=None, string=None, integer=None, resource_reference=None)
- Keyword Arguments
boolean (PresetWorkloadConstraintsBoolean) –
string (PresetWorkloadConstraintsString) –
integer (PresetWorkloadConstraintsInteger) –
resource_reference (PresetWorkloadConstraintsResourceReference) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'boolean': 'boolean', 'integer': 'integer', 'resource_reference': 'resource_reference', 'string': 'string'}
- keys()
- required_args = {}
- swagger_types = {'boolean': 'PresetWorkloadConstraintsBoolean', 'integer': 'PresetWorkloadConstraintsInteger', 'resource_reference': 'PresetWorkloadConstraintsResourceReference', 'string': 'PresetWorkloadConstraintsString'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_boolean module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_boolean.PresetWorkloadConstraintsBoolean(default=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(default=None)
- Keyword Arguments
default (bool) – The default value to use if no value is provided.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'default': 'default'}
- keys()
- required_args = {}
- swagger_types = {'default': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_integer module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_integer.PresetWorkloadConstraintsInteger(allowed_values=None, default=None, maximum=None, minimum=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(allowed_values=None, default=None, maximum=None, minimum=None)
- Keyword Arguments
allowed_values (list[int]) – The valid values that can be supplied to the parameter. A parameter that collects the number of volumes to provision might, for example, limit the allowed values to a few fixed options. Supports up to five values.
default (int) – The default value to use if no value is provided. Must be present in allowed_values, if set. Must comply with minimum, if set. Must comply with maximum, if set.
maximum (int) – The maximum acceptable value, inclusive.
minimum (int) – The minimum acceptable value, inclusive.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed_values': 'allowed_values', 'default': 'default', 'maximum': 'maximum', 'minimum': 'minimum'}
- keys()
- required_args = {}
- swagger_types = {'allowed_values': 'list[int]', 'default': 'int', 'maximum': 'int', 'minimum': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_resource_reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_resource_reference.PresetWorkloadConstraintsResourceReference(allowed_values, default=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(allowed_values, default=None)
- Keyword Arguments
allowed_values (list[PresetWorkloadConstraintsResourceReferenceAllowedValues], required) – The valid values that can be supplied to the parameter. Exactly one value must be specified.
default (ReferenceWithType) – The default value to use if no value is provided. Must match the resource_type set in allowed_values. One of id or name must be set, but they cannot be set together.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed_values': 'allowed_values', 'default': 'default'}
- keys()
- required_args = {'allowed_values'}
- swagger_types = {'allowed_values': 'list[PresetWorkloadConstraintsResourceReferenceAllowedValues]', 'default': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_resource_reference_allowed_values module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_resource_reference_allowed_values.PresetWorkloadConstraintsResourceReferenceAllowedValues(resource_type)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(resource_type)
- Keyword Arguments
resource_type (str, required) – The type of resource the parameter references. Valid values include storage-classes and remote-arrays.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'resource_type': 'resource_type'}
- keys()
- required_args = {'resource_type'}
- swagger_types = {'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_string module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_constraints_string.PresetWorkloadConstraintsString(allowed_values=None, default=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(allowed_values=None, default=None)
- Keyword Arguments
allowed_values (list[str]) – The valid values that can be supplied to the parameter. A parameter that collects the name of the environment to which a workload will deploy might, for example, limit the allowed values to production, testing and development. Supports up to five values, with up to 64 unicode characters per value.
default (str) – The default value to use if no value is provided. Must be present in allowed_values, if allowed_values is set. Supports up to 64 unicode characters.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed_values': 'allowed_values', 'default': 'default'}
- keys()
- required_args = {}
- swagger_types = {'allowed_values': 'list[str]', 'default': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_get_response.PresetWorkloadGetResponse(continuation_token=None, more_items_remaining=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query parameter to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination, then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Displays a value of true if subsequent items can be retrieved.
items (list[PresetWorkload]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[PresetWorkload]', 'more_items_remaining': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_metadata module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_metadata.PresetWorkloadMetadata(subtype=None, description=None, display_name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(subtype=None, description=None, display_name=None)
- Keyword Arguments
subtype (str) – The subtype of the parameter, which the GUI will use to contextualize the prompt for the parameter value. For example, when set to size, the GUI will display an input field with a dropdown menu that contains common size units such as MB, GB, TB, etc. Valid values include size, iops, bandwidth, time and duration. Subtype can only be used with integer parameters.
description (str) – A brief description of the parameter and how it is used within the preset. Supports up to 1KB of unicode characters.
display_name (str) – The human-friendly name of the parameter, which will be shown in the GUI instead of the standard name if configured. Supports up to 64 unicode characters.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'description': 'description', 'display_name': 'display_name', 'subtype': 'subtype'}
- keys()
- required_args = {}
- swagger_types = {'description': 'str', 'display_name': 'str', 'subtype': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_parameter module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_parameter.PresetWorkloadParameter(name, type, metadata=None, constraints=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name, type, metadata=None, constraints=None)
- Keyword Arguments
metadata (PresetWorkloadMetadata) –
name (str, required) – The name of the parameter, by which other fields in the preset can reference it. Name must be unique across all parameters in the preset.
type (str, required) – The type of the parameter. Valid values include string, integer, boolean and resource_reference. String parameters can be used to collect metadata about workloads deployed from the preset, such as the environment to which they are deployed (e.g., production, development, etc.) or the billing account to which they belong for charge back and show back purposes. Integer and boolean parameters can be used to configure specific fields in the preset, such as the number or size of volumes to provision. Resource reference parameters can be used to collect references to other objects, such as storage classes or remote arrays.
constraints (PresetWorkloadConstraints) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'constraints': 'constraints', 'metadata': 'metadata', 'name': 'name', 'type': 'type'}
- keys()
- required_args = {'name', 'type'}
- swagger_types = {'constraints': 'PresetWorkloadConstraints', 'metadata': 'PresetWorkloadMetadata', 'name': 'str', 'type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_patch.PresetWorkloadPatch(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – The new name for the resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_periodic_replication_configuration module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_periodic_replication_configuration.PresetWorkloadPeriodicReplicationConfiguration(remote_targets, name, rules)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(remote_targets, name, rules)
- Keyword Arguments
remote_targets (list[ReferenceWithType], required) – The remote targets to which snapshots may be replicated.
name (str, required) – The name of the periodic replication configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.
rules (list[PresetWorkloadSnapshotRule], required) – Rules describe the frequency and retention of snapshots taken by the configuration.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'remote_targets': 'remote_targets', 'rules': 'rules'}
- keys()
- required_args = {'name', 'remote_targets', 'rules'}
- swagger_types = {'name': 'str', 'remote_targets': 'list[ReferenceWithType]', 'rules': 'list[PresetWorkloadSnapshotRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_placement_configuration module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_placement_configuration.PresetWorkloadPlacementConfiguration(storage_class, name, qos_configurations=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(storage_class, name, qos_configurations=None)
- Keyword Arguments
storage_class (ReferenceWithType, required) – The storage class to which the placement and its associated storage resources may be deployed. Supports parameterization.
name (str, required) – The name of the placement configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.
qos_configurations (list[str]) – The names of the QoS configurations to apply to the storage resources (such as volumes) in the placement. The limits defined in the QoS configurations will be shared across all storage resources in the placement.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'qos_configurations': 'qos_configurations', 'storage_class': 'storage_class'}
- keys()
- required_args = {'name', 'storage_class'}
- swagger_types = {'name': 'str', 'qos_configurations': 'list[str]', 'storage_class': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_post.PresetWorkloadPost(volume_configurations, placement_configurations, workload_type, periodic_replication_configurations=None, description=None, workload_tags=None, parameters=None, qos_configurations=None, snapshot_configurations=None, revision=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(volume_configurations, placement_configurations, workload_type, periodic_replication_configurations=None, description=None, workload_tags=None, parameters=None, qos_configurations=None, snapshot_configurations=None, revision=None)
- Keyword Arguments
volume_configurations (list[PresetWorkloadVolumeConfiguration], required) – The volumes that will be provisioned by the preset.
periodic_replication_configurations (list[PresetWorkloadPeriodicReplicationConfiguration]) – The periodic replication configurations that can be applied to storage resources (such as volumes) within the preset.
description (str) – A brief description of the workload the preset will configure. Supports up to 1KB of unicode characters.
placement_configurations (list[PresetWorkloadPlacementConfiguration], required) – The placement configurations that can be applied to storage resources (such as volumes) within the preset. All storage resources associated with the same placement will be colocated on the same array.
workload_tags (list[PresetWorkloadWorkloadTag]) – The tags that will be associated with workloads provisioned by the preset.
parameters (list[PresetWorkloadParameter]) – The parameters to prompt the user when they deploy workloads from the preset.
qos_configurations (list[PresetWorkloadQosConfiguration]) – The QoS configurations that can be applied to storage resources (such as volumes) within the preset.
snapshot_configurations (list[PresetWorkloadSnapshotConfiguration]) – The snapshot configurations that can be applied to storage resources (such as volumes) within the preset.
workload_type (str, required) – The type of workload the preset will configure. Valid values include VDI, File, MySQL etc.
revision (int) – A counter that is automatically incremented by the server when the preset is updated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'description': 'description', 'parameters': 'parameters', 'periodic_replication_configurations': 'periodic_replication_configurations', 'placement_configurations': 'placement_configurations', 'qos_configurations': 'qos_configurations', 'revision': 'revision', 'snapshot_configurations': 'snapshot_configurations', 'volume_configurations': 'volume_configurations', 'workload_tags': 'workload_tags', 'workload_type': 'workload_type'}
- keys()
- required_args = {'placement_configurations', 'volume_configurations', 'workload_type'}
- swagger_types = {'description': 'str', 'parameters': 'list[PresetWorkloadParameter]', 'periodic_replication_configurations': 'list[PresetWorkloadPeriodicReplicationConfiguration]', 'placement_configurations': 'list[PresetWorkloadPlacementConfiguration]', 'qos_configurations': 'list[PresetWorkloadQosConfiguration]', 'revision': 'int', 'snapshot_configurations': 'list[PresetWorkloadSnapshotConfiguration]', 'volume_configurations': 'list[PresetWorkloadVolumeConfiguration]', 'workload_tags': 'list[PresetWorkloadWorkloadTag]', 'workload_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_qos_configuration module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_qos_configuration.PresetWorkloadQosConfiguration(name, bandwidth_limit=None, iops_limit=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name, bandwidth_limit=None, iops_limit=None)
- Keyword Arguments
name (str, required) – The name of the QoS configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.
bandwidth_limit (str) – The QoS IOPs limit shared across all volumes in the placement. Between 100 and 100000000, inclusive. Supports parameterization.
iops_limit (str) – The maximum QoS bandwidth limit shared across all volumes in the placement. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Between 1MB/s and 512 GB/s, inclusive. Supports parameterization.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bandwidth_limit': 'bandwidth_limit', 'iops_limit': 'iops_limit', 'name': 'name'}
- keys()
- required_args = {'name'}
- swagger_types = {'bandwidth_limit': 'str', 'iops_limit': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_response.PresetWorkloadResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[PresetWorkload]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[PresetWorkload]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_snapshot_configuration module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_snapshot_configuration.PresetWorkloadSnapshotConfiguration(name, rules)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name, rules)
- Keyword Arguments
name (str, required) – The name of the snapshot configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.
rules (list[PresetWorkloadSnapshotRule], required) – Rules describe the frequency and retention of snapshots taken by the configuration.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'rules': 'rules'}
- keys()
- required_args = {'name', 'rules'}
- swagger_types = {'name': 'str', 'rules': 'list[PresetWorkloadSnapshotRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_snapshot_rule module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_snapshot_rule.PresetWorkloadSnapshotRule(keep_for, every, at=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(keep_for, every, at=None)
- Keyword Arguments
at (str) – Specifies the number of milliseconds since midnight at which to take a snapshot. The at value cannot be set if the every value is not measured in days. The at value can only be set on the first rule.
keep_for (str, required) – Specifies the period that snapshots are retained before they are eradicated, in milliseconds. The keep_for value must be between 10 minutes and 24855 days for the first rule, and a multiple of a second. The keep_for value must be between 10 minutes and 2147483647 days for the second rule, and must be greater than or equal to the keep_for value of the first rule.
every (str, required) – Specifies the interval between snapshots, in milliseconds. The every value for all rules must be multiples of one another. The every value must be between five minutes and 400 days for the first rule. The every value must be between five minutes and one day for the second rule.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'at': 'at', 'every': 'every', 'keep_for': 'keep_for'}
- keys()
- required_args = {'every', 'keep_for'}
- swagger_types = {'at': 'str', 'every': 'str', 'keep_for': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_volume_configuration module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_volume_configuration.PresetWorkloadVolumeConfiguration(count, name, placement_configurations, provisioned_size, periodic_replication_configurations=None, snapshot_configurations=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(count, name, placement_configurations, provisioned_size, periodic_replication_configurations=None, snapshot_configurations=None)
- Keyword Arguments
periodic_replication_configurations (list[str]) – The names of the periodic replication configurations to apply to the volumes.
count (str, required) – The number of volumes to provision. Supports parameterization.
name (str, required) – The name of the volume configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.
placement_configurations (list[str], required) – The names of the placement configurations with which to associate the volumes.
provisioned_size (str, required) – The virtual size of each volume. Measured in bytes and must be a multiple of 512. The maximum size is 4503599627370496 (4PB). Supports parameterization.
snapshot_configurations (list[str]) – The names of the snapshot configurations to apply to the volumes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'count': 'count', 'name': 'name', 'periodic_replication_configurations': 'periodic_replication_configurations', 'placement_configurations': 'placement_configurations', 'provisioned_size': 'provisioned_size', 'snapshot_configurations': 'snapshot_configurations'}
- keys()
- required_args = {'count', 'name', 'placement_configurations', 'provisioned_size'}
- swagger_types = {'count': 'str', 'name': 'str', 'periodic_replication_configurations': 'list[str]', 'placement_configurations': 'list[str]', 'provisioned_size': 'str', 'snapshot_configurations': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.preset_workload_workload_tag module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.preset_workload_workload_tag.PresetWorkloadWorkloadTag(value, key, copyable=None, namespace=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(value, key, copyable=None, namespace=None)
- Keyword Arguments
copyable (str) – Specifies whether to include the tag when copying the parent resource. If set to true, the tag is included in resource copying. If set to false, the tag is not included. If not specified, defaults to true.
namespace (str) – Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace default. The pure* namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.
value (str, required) – Value of the tag. Supports up to 256 Unicode characters. Supports parameterization.
key (str, required) – Key of the tag. Supports up to 64 Unicode characters.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'copyable': 'copyable', 'key': 'key', 'namespace': 'namespace', 'value': 'value'}
- keys()
- required_args = {'key', 'value'}
- swagger_types = {'copyable': 'str', 'key': 'str', 'namespace': 'str', 'value': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.priority_adjustment module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.priority_adjustment.PriorityAdjustment(priority_adjustment_value=None, priority_adjustment_operator=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(priority_adjustment_value=None, priority_adjustment_operator=None)
- Keyword Arguments
priority_adjustment_value (int) – Adjust priority by the specified amount, using the priority_adjustment_operator. Valid values are 0 and +10 for + and - operators, -10, 0, and +10 for the = operator.
priority_adjustment_operator (str) – Valid values are +, -, and =. The values + and - may be applied to volumes and volume groups to reflect the relative importance of their workloads. Volumes and volume groups can be assigned a priority adjustment of -10, 0, or +10. In addition, volumes can be assigned values of =-10, =0, or =+10. Volumes with settings of -10, 0, +10 can be modified by the priority adjustment setting of a volume group that contains the volume. However, if a volume has a priority adjustment set with the = operator (for example, =+10), it retains that value and is unaffected by any volume group priority adjustment settings.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'priority_adjustment_operator': 'priority_adjustment_operator', 'priority_adjustment_value': 'priority_adjustment_value'}
- keys()
- required_args = {}
- swagger_types = {'priority_adjustment_operator': 'str', 'priority_adjustment_value': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group.ProtectionGroup(name=None, id=None, context=None, workload=None, target_retention=None, pod=None, host_group_count=None, host_count=None, eradication_config=None, source=None, volume_count=None, space=None, time_remaining=None, target_count=None, destroyed=None, source_retention=None, replication_schedule=None, snapshot_schedule=None, is_local=None, retention_lock=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, workload=None, target_retention=None, pod=None, host_group_count=None, host_count=None, eradication_config=None, source=None, volume_count=None, space=None, time_remaining=None, target_count=None, destroyed=None, source_retention=None, replication_schedule=None, snapshot_schedule=None, is_local=None, retention_lock=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
workload (WorkloadConfigurationFixedReferenceWorkload) –
target_retention (RetentionPolicy) – The retention policy for the target(s) of the protection group.
pod (FixedReference) – The pod in which the protection group resides.
host_group_count (int) – Number of host groups in this protection group.
host_count (int) – Number of hosts in this protection group.
eradication_config (ProtectionGroupEradicationConfig) –
source (FixedReference) – The array or pod on which the protection group was created.
volume_count (int) – The number of volumes in the protection group.
space (Space) – Displays provisioned size and physical storage consumption data for each protection group.
time_remaining (int) – The amount of time left until the destroyed protection group is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed protection group can be recovered by setting destroyed=false.
target_count (int) – The number of targets to where this protection group replicates.
destroyed (bool) – Has this protection group been destroyed? To destroy a protection group, patch to true. To recover a destroyed protection group, patch to false. If not specified, defaults to false.
source_retention (RetentionPolicy) – The retention policy for the source array of the protection group.
replication_schedule (ReplicationSchedule) – The schedule settings for asynchronous replication.
snapshot_schedule (SnapshotSchedule) – The schedule settings for protection group snapshots.
is_local (bool) – If set to true, the protection group belongs to the local array. If set to false, the protection group belongs to the remote array.
retention_lock (str) – The valid values are ratcheted and unlocked. The default value for a newly created protection group is unlocked. Set retention_lock to ratcheted to enable SafeMode restrictions on the protection group. Contact Pure Technical Services to change retention_lock to unlocked.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'host_count': 'host_count', 'host_group_count': 'host_group_count', 'id': 'id', 'is_local': 'is_local', 'name': 'name', 'pod': 'pod', 'replication_schedule': 'replication_schedule', 'retention_lock': 'retention_lock', 'snapshot_schedule': 'snapshot_schedule', 'source': 'source', 'source_retention': 'source_retention', 'space': 'space', 'target_count': 'target_count', 'target_retention': 'target_retention', 'time_remaining': 'time_remaining', 'volume_count': 'volume_count', 'workload': 'workload'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'destroyed': 'bool', 'eradication_config': 'ProtectionGroupEradicationConfig', 'host_count': 'int', 'host_group_count': 'int', 'id': 'str', 'is_local': 'bool', 'name': 'str', 'pod': 'FixedReference', 'replication_schedule': 'ReplicationSchedule', 'retention_lock': 'str', 'snapshot_schedule': 'SnapshotSchedule', 'source': 'FixedReference', 'source_retention': 'RetentionPolicy', 'space': 'Space', 'target_count': 'int', 'target_retention': 'RetentionPolicy', 'time_remaining': 'int', 'volume_count': 'int', 'workload': 'WorkloadConfigurationFixedReferenceWorkload'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_eradication_config module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_eradication_config.ProtectionGroupEradicationConfig(manual_eradication=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(manual_eradication=None)
- Keyword Arguments
manual_eradication (str) – Manual eradication status of objects like protection group and protection group snapshots. If manual_eradication is disabled, you cannot eradicate objects. Values include disabled and enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'manual_eradication': 'manual_eradication'}
- keys()
- required_args = {}
- swagger_types = {'manual_eradication': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_get_response.ProtectionGroupGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ProtectionGroup]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ProtectionGroup]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ProtectionGroup]', 'more_items_remaining': 'bool', 'total': 'list[ProtectionGroup]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_performance.ProtectionGroupPerformance(name=None, id=None, bytes_per_sec=None, context=None, time=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, bytes_per_sec=None, context=None, time=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
bytes_per_sec (int) – The total number of bytes of replication data transmitted and received per second.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time (int) – The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_sec': 'bytes_per_sec', 'context': 'context', 'id': 'id', 'name': 'name', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_sec': 'int', 'context': 'FixedReference', 'id': 'str', 'name': 'str', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_performance_array module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_performance_array.ProtectionGroupPerformanceArray(name=None, id=None, bytes_per_sec=None, context=None, source=None, time=None, target=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, bytes_per_sec=None, context=None, source=None, time=None, target=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
bytes_per_sec (int) – The total number of bytes of replication data transmitted and received per second.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
source (str) – The source array from where the data is replicated.
time (int) – The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch.
target (str) – The target to where the data is replicated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_sec': 'bytes_per_sec', 'context': 'context', 'id': 'id', 'name': 'name', 'source': 'source', 'target': 'target', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_sec': 'int', 'context': 'FixedReference', 'id': 'str', 'name': 'str', 'source': 'str', 'target': 'str', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_performance_array_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_performance_array_response.ProtectionGroupPerformanceArrayResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ProtectionGroupPerformanceArray]) – Lists performance data, broken down by array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ProtectionGroupPerformanceArray]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_performance_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_performance_response.ProtectionGroupPerformanceResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ProtectionGroupPerformance]) – A list of protection group performance objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ProtectionGroupPerformance]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_post.ProtectionGroupPost(tags=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(tags=None)
- Keyword Arguments
tags (list[Tag]) – The list of tags to be upserted with the object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'tags': 'tags'}
- keys()
- required_args = {}
- swagger_types = {'tags': 'list[Tag]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_response.ProtectionGroupResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ProtectionGroup]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ProtectionGroup]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot.ProtectionGroupSnapshot(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None, eradication_config=None, source=None, suffix=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None, eradication_config=None, source=None, suffix=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the protection group snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.
pod (FixedReference) – The pod in which the protection group of the protection group snapshot resides.
created (int) – The snapshot creation time of the original snapshot source. Measured in milliseconds since the UNIX epoch.
eradication_config (ProtectionGroupEradicationConfig) –
source (FixedReference) – The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the source is the replica protection group.
suffix (str) – The name suffix appended to the protection group name to make up the full protection group snapshot name in the form PGROUP.SUFFIX. If suffix is not specified, the protection group name is in the form PGROUP.NNN, where NNN is a unique monotonically increasing number. If multiple protection group snapshots are created at a time, the suffix name is appended to those snapshots.
space (Space) – Displays provisioned size and physical storage consumption data for each protection group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'id': 'id', 'name': 'name', 'pod': 'pod', 'source': 'source', 'space': 'space', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'eradication_config': 'ProtectionGroupEradicationConfig', 'id': 'str', 'name': 'str', 'pod': 'FixedReference', 'source': 'FixedReference', 'space': 'Space', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_get_response.ProtectionGroupSnapshotGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ProtectionGroupSnapshot]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ProtectionGroupSnapshot]) – The aggregate value of all items after filtering. If applicable, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ProtectionGroupSnapshot]', 'more_items_remaining': 'bool', 'total': 'list[ProtectionGroupSnapshot]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_patch.ProtectionGroupSnapshotPatch(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None, eradication_config=None, source=None, suffix=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None, eradication_config=None, source=None, suffix=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the protection group snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.
pod (FixedReference) – The pod in which the protection group of the protection group snapshot resides.
created (int) – The snapshot creation time of the original snapshot source. Measured in milliseconds since the UNIX epoch.
eradication_config (ProtectionGroupEradicationConfig) –
source (FixedReference) – The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the source is the replica protection group.
suffix (str) –
space (Space) – Displays provisioned size and physical storage consumption data for each protection group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'id': 'id', 'name': 'name', 'pod': 'pod', 'source': 'source', 'space': 'space', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'eradication_config': 'ProtectionGroupEradicationConfig', 'id': 'str', 'name': 'str', 'pod': 'FixedReference', 'source': 'FixedReference', 'space': 'Space', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_post.ProtectionGroupSnapshotPost(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None, eradication_config=None, source=None, suffix=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None, eradication_config=None, source=None, suffix=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.
destroyed (bool) –
pod (FixedReference) – The pod in which the protection group of the protection group snapshot resides.
created (int) – The snapshot creation time of the original snapshot source. Measured in milliseconds since the UNIX epoch.
eradication_config (ProtectionGroupEradicationConfig) –
source (FixedReference) – The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the source is the replica protection group.
suffix (str) – The name suffix appended to the protection group name to make up the full protection group snapshot name in the form PGROUP.SUFFIX. If suffix is not specified, the protection group name is in the form PGROUP.NNN, where NNN is a unique monotonically increasing number. If multiple protection group snapshots are created at a time, the suffix name is appended to those snapshots.
space (Space) – Displays provisioned size and physical storage consumption data for each protection group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'id': 'id', 'name': 'name', 'pod': 'pod', 'source': 'source', 'space': 'space', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'eradication_config': 'ProtectionGroupEradicationConfig', 'id': 'str', 'name': 'str', 'pod': 'FixedReference', 'source': 'FixedReference', 'space': 'Space', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_replica module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_replica.ProtectionGroupSnapshotReplica(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None, eradication_config=None, source=None, suffix=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, pod=None, created=None, eradication_config=None, source=None, suffix=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the protection group snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.
pod (FixedReference) – The pod in which the protection group of the protection group snapshot resides.
created (int) – The snapshot creation time of the original snapshot source. Measured in milliseconds since the UNIX epoch.
eradication_config (ProtectionGroupEradicationConfig) –
source (FixedReference) – The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the source is the replica protection group.
suffix (str) – The name suffix appended to the protection group name to make up the full protection group snapshot name in the form PGROUP.SUFFIX. If suffix is not specified, the protection group name is in the form PGROUP.NNN, where NNN is a unique monotonically increasing number. If multiple protection group snapshots are created at a time, the suffix name is appended to those snapshots.
space (Space) – Displays provisioned size and physical storage consumption data for each protection group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'id': 'id', 'name': 'name', 'pod': 'pod', 'source': 'source', 'space': 'space', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'eradication_config': 'ProtectionGroupEradicationConfig', 'id': 'str', 'name': 'str', 'pod': 'FixedReference', 'source': 'FixedReference', 'space': 'Space', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_replica_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_replica_response.ProtectionGroupSnapshotReplicaResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ProtectionGroupSnapshotReplica]) – Displays a list of all items after the operation. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ProtectionGroupSnapshotReplica]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_response.ProtectionGroupSnapshotResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ProtectionGroupSnapshot]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ProtectionGroupSnapshot]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_transfer module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_transfer.ProtectionGroupSnapshotTransfer(name=None, id=None, physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None, context=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None, context=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
physical_bytes_written (int) – The amount of physical/logical data written to the target due to replication. Measured in bytes.
data_transferred (int) – The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.
destroyed (bool) – Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.
progress (float) – The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.
started (int) – The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.
completed (int) – The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'completed': 'completed', 'context': 'context', 'data_transferred': 'data_transferred', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'physical_bytes_written': 'physical_bytes_written', 'progress': 'progress', 'started': 'started'}
- keys()
- required_args = {}
- swagger_types = {'completed': 'int', 'context': 'FixedReference', 'data_transferred': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'physical_bytes_written': 'int', 'progress': 'float', 'started': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_transfer_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_transfer_get_response.ProtectionGroupSnapshotTransferGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ProtectionGroupSnapshotTransfer]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ProtectionGroupSnapshotTransfer]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ProtectionGroupSnapshotTransfer]', 'more_items_remaining': 'bool', 'total': 'list[ProtectionGroupSnapshotTransfer]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_transfer_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_snapshot_transfer_response.ProtectionGroupSnapshotTransferResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ProtectionGroupSnapshotTransfer]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ProtectionGroupSnapshotTransfer]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_target module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_target.ProtectionGroupTarget(protection_group=None, allowed=None, target=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(protection_group=None, allowed=None, target=None)
- Keyword Arguments
protection_group (ReferenceNoId) –
allowed (bool) – If set to true, the target array has allowed the source array to replicate protection group data to the target array. If set to false, the target array has not allowed the source array to replicate protection group data to the target.
target (ReferenceNoId) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed': 'allowed', 'protection_group': 'protection_group', 'target': 'target'}
- keys()
- required_args = {}
- swagger_types = {'allowed': 'bool', 'protection_group': 'ReferenceNoId', 'target': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_target_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_target_get_response.ProtectionGroupTargetGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[TargetProtectionGroup]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[TargetProtectionGroup]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_group_target_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_group_target_response.ProtectionGroupTargetResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[TargetProtectionGroup]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[TargetProtectionGroup]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_groups_volumes module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_groups_volumes.ProtectionGroupsVolumes(context=None, member=None, group=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, member=None, group=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
member (ProtectionGroupsVolumesMember) –
group (Reference) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'group': 'group', 'member': 'member'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'group': 'Reference', 'member': 'ProtectionGroupsVolumesMember'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_groups_volumes_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_groups_volumes_get_response.ProtectionGroupsVolumesGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ProtectionGroupsVolumes]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ProtectionGroupsVolumes]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_groups_volumes_member module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_groups_volumes_member.ProtectionGroupsVolumesMember(name=None, id=None, destroyed=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, destroyed=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
destroyed (bool) – Returns a value of true if the volume has been destroyed and is pending eradication. Through the volumes endpoint, the user can see time_remaining of the destroyed volume, recover, or eradicate the destroyed volume.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'id': 'id', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protection_groups_volumes_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protection_groups_volumes_response.ProtectionGroupsVolumesResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ProtectionGroupsVolumes]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ProtectionGroupsVolumes]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.protocol_endpoint module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.protocol_endpoint.ProtocolEndpoint(container_version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(container_version=None)
- Keyword Arguments
container_version (str) – Defines vCenter and EXSi host compatibility of the protocol endpoint and its associated container. Valid values include: 1, 2, 3. When container_version is set to 1, it’s compatible with vSphere version 7.0.1 or higher. When container_version is set to 2, it’s compatible with vSphere version 8.0.0 or higher. When container_version is set to 3, it’s compatible with vSphere version 8.0.1 or higher. The default container_version is 1.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'container_version': 'container_version'}
- keys()
- required_args = {}
- swagger_types = {'container_version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.qos module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.qos.Qos(bandwidth_limit=None, iops_limit=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(bandwidth_limit=None, iops_limit=None)
- Keyword Arguments
bandwidth_limit (int) – The maximum QoS bandwidth limit for the volume. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Maximum limit is 512 GB/s.
iops_limit (int) – The QoS IOPs limit for the volume.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bandwidth_limit': 'bandwidth_limit', 'iops_limit': 'iops_limit'}
- keys()
- required_args = {}
- swagger_types = {'bandwidth_limit': 'int', 'iops_limit': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.realm module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.realm.Realm(name=None, id=None, quota_limit=None, time_remaining=None, destroyed=None, qos=None, created=None, eradication_config=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, quota_limit=None, time_remaining=None, destroyed=None, qos=None, created=None, eradication_config=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
quota_limit (int) – The logical quota limit of the realm, measured in bytes.
time_remaining (int) – Time in milliseconds before the realm is eradicated. null if not destroyed.
destroyed (bool) – Returns a value of true if the realm has been destroyed and is pending eradication. The realm cannot be modified while it is in the destroyed state. The time_remaining value displays the amount of time left until the destroyed realm is permanently eradicated. Once eradication has begun, the realm can no longer be recovered. Before the time_remaining period has elapsed, the destroyed realm can be recovered through the PATCH method
qos (ContainerQos) – Displays QoS limit information.
created (int) – Creation timestamp of the realm.
eradication_config (ContainerEradicationConfig) –
space (SpaceNoDeprecatedPhysicalOrEffective) – Displays provisioned size and physical storage consumption information for the realm.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'id': 'id', 'name': 'name', 'qos': 'qos', 'quota_limit': 'quota_limit', 'space': 'space', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'created': 'int', 'destroyed': 'bool', 'eradication_config': 'ContainerEradicationConfig', 'id': 'str', 'name': 'str', 'qos': 'ContainerQos', 'quota_limit': 'int', 'space': 'SpaceNoDeprecatedPhysicalOrEffective', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.realm_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.realm_get_response.RealmGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Realm]) –
total (list[Realm]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Realm]', 'more_items_remaining': 'bool', 'total': 'list[Realm]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.realm_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.realm_patch.RealmPatch(name=None, quota_limit=None, destroyed=None, qos=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, quota_limit=None, destroyed=None, qos=None)
- Keyword Arguments
name (str) – The new name for the resource.
quota_limit (int) – The logical quota limit of the realm, measured in bytes.
destroyed (bool) – If set to true, the realm will be destroyed and pending eradication. The time_remaining value displays the amount of time left until the destroyed realm is permanently eradicated. A realm can only be destroyed if it is empty or destroy_contents is set to true. Before the time_remaining period has elapsed, the destroyed realm can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the realm is permanently eradicated and can no longer be recovered.
qos (ContainerQos) – Sets QoS limits.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'name': 'name', 'qos': 'qos', 'quota_limit': 'quota_limit'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'name': 'str', 'qos': 'ContainerQos', 'quota_limit': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.realm_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.realm_post.RealmPost(quota_limit=None, qos=None, tags=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(quota_limit=None, qos=None, tags=None)
- Keyword Arguments
quota_limit (int) – The logical quota limit of the realm, measured in bytes. Must be a multiple of 512.
qos (ContainerQos) – Sets QoS limits.
tags (list[NonCopyableTag]) – The list of tags to be upserted with the object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'qos': 'qos', 'quota_limit': 'quota_limit', 'tags': 'tags'}
- keys()
- required_args = {}
- swagger_types = {'qos': 'ContainerQos', 'quota_limit': 'int', 'tags': 'list[NonCopyableTag]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.realm_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.realm_response.RealmResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Realm]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.realm_space_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.realm_space_get_response.RealmSpaceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
total (list[ResourceRealmSpace]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful.
items (list[ResourceRealmSpace]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ResourceRealmSpace]', 'more_items_remaining': 'bool', 'total': 'list[ResourceRealmSpace]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.reference.Reference(name=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.reference_no_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.reference_no_id.ReferenceNoId(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.reference_no_id_with_type module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.reference_no_id_with_type.ReferenceNoIdWithType(name=None, resource_type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, resource_type=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
resource_type (str) – Type of the object (full name of the endpoint). Valid values include hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'resource_type': 'resource_type'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.reference_with_fixed_type module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.reference_with_fixed_type.ReferenceWithFixedType(name=None, resource_type=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, resource_type=None, id=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
resource_type (str) – Type of the object (full name of the endpoint). Valid values are hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'resource_type': 'resource_type'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.reference_with_type module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.reference_with_type.ReferenceWithType(name=None, id=None, resource_type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, resource_type=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
resource_type (str) – Type of the object (full name of the endpoint). Valid values are hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'resource_type': 'resource_type'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_array module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_array.RemoteArray(name=None, id=None, fleet=None, os=None, model=None, is_local=None, version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, fleet=None, os=None, model=None, is_local=None, version=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
fleet (RemoteArrayFleet) –
os (str) – Specifies the operating system. Valid values are Purity, Purity//FA, and Purity//FB.
model (str) – Specifies the array model.
is_local (bool) – If set to true, this array is the current array.
version (str) – Specifies the operating system version.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'fleet': 'fleet', 'id': 'id', 'is_local': 'is_local', 'model': 'model', 'name': 'name', 'os': 'os', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'fleet': 'RemoteArrayFleet', 'id': 'str', 'is_local': 'bool', 'model': 'str', 'name': 'str', 'os': 'str', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_array_fleet module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_array_fleet.RemoteArrayFleet(name=None, id=None, is_local=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, is_local=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
is_local (bool) – If set to true, the current array is a member of the fleet.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'is_local': 'is_local', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'is_local': 'bool', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_arrays_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_arrays_response.RemoteArraysResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[RemoteArray]) – Returns a list of all items after filtering. The values are displayed for each name where meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[RemoteArray]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_pod module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_pod.RemotePod(name=None, id=None, context=None, arrays=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, arrays=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
arrays (list[Resource]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'arrays': 'arrays', 'context': 'context', 'id': 'id', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'arrays': 'list[Resource]', 'context': 'FixedReference', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_pods_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_pods_response.RemotePodsResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[RemotePod]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[RemotePod]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group.RemoteProtectionGroup(name=None, id=None, context=None, target_retention=None, time_remaining=None, destroyed=None, source=None, is_local=None, remote=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, target_retention=None, time_remaining=None, destroyed=None, source=None, is_local=None, remote=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
target_retention (RetentionPolicy) – The retention policy for the remote protection group.
time_remaining (int) – Milliseconds remaining until eradication, if remote protection group has been destroyed.
destroyed (bool) – Returns a value of true if the remote protection group has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed remote protection group is permanently eradicated. Before the time_remaining period has elapsed, the destroyed remote protection group can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the remote protection group is permanently eradicated and can no longer be recovered.
source (FixedReference) – The array where the remote protection group is replicated from.
is_local (bool) – If set to true, the location reference is to the local array. If set to false, the location reference is to a remote location, such as a remote array or offload target.
remote (FixedReference) – The offload target that the remote protection group is on.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destroyed': 'destroyed', 'id': 'id', 'is_local': 'is_local', 'name': 'name', 'remote': 'remote', 'source': 'source', 'target_retention': 'target_retention', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'destroyed': 'bool', 'id': 'str', 'is_local': 'bool', 'name': 'str', 'remote': 'FixedReference', 'source': 'FixedReference', 'target_retention': 'RetentionPolicy', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group_get_response.RemoteProtectionGroupGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[RemoteProtectionGroup]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[RemoteProtectionGroup]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group_response.RemoteProtectionGroupResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[RemoteProtectionGroup]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[RemoteProtectionGroup]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot.RemoteProtectionGroupSnapshot(name=None, id=None, context=None, time_remaining=None, destroyed=None, created=None, source=None, is_local=None, remote=None, suffix=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, created=None, source=None, is_local=None, remote=None, suffix=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The time remaining until eradication, measured in milliseconds, if the snapshot has been destroyed.
destroyed (bool) – Destroyed and pending eradication? If not specified, defaults to false.
created (int) – The creation time of the snapshot on the original source of the snapshot. Measured in milliseconds since the UNIX epoch.
source (FixedReference) – The original protection group from which this snapshot was taken.
is_local (bool) – The status of whether or not the remote protection group snapshot is replicated from the current array.
remote (FixedReference) – The offload target where the remote protection group snapshot is located.
suffix (str) – The suffix that is appended to the source_name value to generate the full remote protection group snapshot name in the form PGROUP.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form PGROUP.NNN, where PGROUP is the protection group name, and NNN is a monotonically increasing number.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'is_local': 'is_local', 'name': 'name', 'remote': 'remote', 'source': 'source', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'is_local': 'bool', 'name': 'str', 'remote': 'FixedReference', 'source': 'FixedReference', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_get_response.RemoteProtectionGroupSnapshotGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[RemoteProtectionGroupSnapshot]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[RemoteProtectionGroupSnapshot]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_post.RemoteProtectionGroupSnapshotPost(name=None, id=None, context=None, time_remaining=None, destroyed=None, created=None, source=None, is_local=None, remote=None, suffix=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, created=None, source=None, is_local=None, remote=None, suffix=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The time remaining until eradication, measured in milliseconds, if the snapshot has been destroyed.
destroyed (bool) –
created (int) – The creation time of the snapshot on the original source of the snapshot. Measured in milliseconds since the UNIX epoch.
source (FixedReference) – The original protection group from which this snapshot was taken.
is_local (bool) – The status of whether or not the remote protection group snapshot is replicated from the current array.
remote (FixedReference) – The offload target where the remote protection group snapshot is located.
suffix (str) – Specifies a name suffix for the snapshots created. The snapshot is created on the FlashArray specified by the on parameter. The on parameter cannot refer to an offload target. Snapshots with suffixes specified have names in the form PGROUP.SUFFIX instead of the default PGROUP.NNN form. The names of all snapshots created by a single command that specifies this option have the same suffix.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'is_local': 'is_local', 'name': 'name', 'remote': 'remote', 'source': 'source', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'is_local': 'bool', 'name': 'str', 'remote': 'FixedReference', 'source': 'FixedReference', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_response.RemoteProtectionGroupSnapshotResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[RemoteProtectionGroupSnapshot]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[RemoteProtectionGroupSnapshot]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_transfer module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_transfer.RemoteProtectionGroupSnapshotTransfer(name=None, id=None, physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None, context=None, source=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None, context=None, source=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
physical_bytes_written (int) – The amount of physical/logical data written to the target due to replication. Measured in bytes.
data_transferred (int) – The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.
destroyed (bool) – Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.
progress (float) – The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.
started (int) – The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.
completed (int) – The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
source (Reference) – The original protection group from which this snapshot was taken.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'completed': 'completed', 'context': 'context', 'data_transferred': 'data_transferred', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'physical_bytes_written': 'physical_bytes_written', 'progress': 'progress', 'source': 'source', 'started': 'started'}
- keys()
- required_args = {}
- swagger_types = {'completed': 'int', 'context': 'FixedReference', 'data_transferred': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'physical_bytes_written': 'int', 'progress': 'float', 'source': 'Reference', 'started': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_transfer_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_transfer_get_response.RemoteProtectionGroupSnapshotTransferGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[RemoteProtectionGroupSnapshotTransfer]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[RemoteProtectionGroupSnapshotTransfer]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[RemoteProtectionGroupSnapshotTransfer]', 'more_items_remaining': 'bool', 'total': 'list[RemoteProtectionGroupSnapshotTransfer]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_transfer_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_protection_group_snapshot_transfer_response.RemoteProtectionGroupSnapshotTransferResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[RemoteProtectionGroupSnapshotTransfer]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[RemoteProtectionGroupSnapshotTransfer]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot.RemoteVolumeSnapshot(name=None, id=None, time_remaining=None, destroyed=None, pod=None, provisioned=None, created=None, source=None, suffix=None, context=None, remote=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, time_remaining=None, destroyed=None, pod=None, provisioned=None, created=None, source=None, suffix=None, context=None, remote=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
time_remaining (int) – The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered.
pod (FixedReference) – A reference to the pod.
provisioned (int) – The provisioned space of the snapshot. Measured in bytes. The minimum size is 1048576 (1MB), the maximum size is 4503599627370496 (4PB)
created (int) – The snapshot creation time. Measured in milliseconds since the UNIX epoch.
source (FixedReference) – The volume from which this snapshot was taken. For a replicated snapshot being viewed on the target side, the source is the replica volume.
suffix (str) – The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
remote (FixedReference) – Remote target where this volume snapshot is located.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'pod': 'pod', 'provisioned': 'provisioned', 'remote': 'remote', 'source': 'source', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'pod': 'FixedReference', 'provisioned': 'int', 'remote': 'FixedReference', 'source': 'FixedReference', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_get_response.RemoteVolumeSnapshotGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[RemoteVolumeSnapshot]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[RemoteVolumeSnapshot]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_post.RemoteVolumeSnapshotPost(suffix=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(suffix=None)
- Keyword Arguments
suffix (str) – The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'suffix': 'suffix'}
- keys()
- required_args = {}
- swagger_types = {'suffix': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_response.RemoteVolumeSnapshotResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[RemoteVolumeSnapshot]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[RemoteVolumeSnapshot]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_transfer module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_transfer.RemoteVolumeSnapshotTransfer(name=None, id=None, physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None, context=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None, context=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
physical_bytes_written (int) – The amount of physical/logical data written to the target due to replication. Measured in bytes.
data_transferred (int) – The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.
destroyed (bool) – Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.
progress (float) – The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.
started (int) – The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.
completed (int) – The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'completed': 'completed', 'context': 'context', 'data_transferred': 'data_transferred', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'physical_bytes_written': 'physical_bytes_written', 'progress': 'progress', 'started': 'started'}
- keys()
- required_args = {}
- swagger_types = {'completed': 'int', 'context': 'FixedReference', 'data_transferred': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'physical_bytes_written': 'int', 'progress': 'float', 'started': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_transfer_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_transfer_get_response.RemoteVolumeSnapshotTransferGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[RemoteVolumeSnapshotTransfer]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[RemoteVolumeSnapshotTransfer]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[RemoteVolumeSnapshotTransfer]', 'more_items_remaining': 'bool', 'total': 'list[RemoteVolumeSnapshotTransfer]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_transfer_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.remote_volume_snapshot_transfer_response.RemoteVolumeSnapshotTransferResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[RemoteVolumeSnapshotTransfer]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[RemoteVolumeSnapshotTransfer]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.replica_link_lag module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.replica_link_lag.ReplicaLinkLag(avg=None, max=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(avg=None, max=None)
- Keyword Arguments
avg (int) – The average time difference between the current time and recovery_point for a period of time.
max (int) – The maximum time difference between the current time and recovery_point for a period of time.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'avg': 'avg', 'max': 'max'}
- keys()
- required_args = {}
- swagger_types = {'avg': 'int', 'max': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.replica_link_performance_replication module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.replica_link_performance_replication.ReplicaLinkPerformanceReplication(bytes_per_sec_total=None, bytes_per_sec_from_remote=None, remotes=None, bytes_per_sec_to_remote=None, remote_pod=None, time=None, local_pod=None, direction=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(bytes_per_sec_total=None, bytes_per_sec_from_remote=None, remotes=None, bytes_per_sec_to_remote=None, remote_pod=None, time=None, local_pod=None, direction=None)
- Keyword Arguments
bytes_per_sec_total (int) – Total bytes transmitted and received per second.
bytes_per_sec_from_remote (int) – The number of bytes received per second from a remote array.
remotes (list[FixedReference]) – Reference to a remote array.
bytes_per_sec_to_remote (int) – The number of bytes transmitted per second to a remote array.
remote_pod (FixedReference) – Reference to a remote pod.
time (int) – Sample time in milliseconds since the UNIX epoch.
local_pod (FixedReference) – Reference to a local pod.
direction (str) – The direction of replication. Valid values are inbound and outbound.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_sec_from_remote': 'bytes_per_sec_from_remote', 'bytes_per_sec_to_remote': 'bytes_per_sec_to_remote', 'bytes_per_sec_total': 'bytes_per_sec_total', 'direction': 'direction', 'local_pod': 'local_pod', 'remote_pod': 'remote_pod', 'remotes': 'remotes', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_sec_from_remote': 'int', 'bytes_per_sec_to_remote': 'int', 'bytes_per_sec_total': 'int', 'direction': 'str', 'local_pod': 'FixedReference', 'remote_pod': 'FixedReference', 'remotes': 'list[FixedReference]', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.replication_performance_with_total module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.replication_performance_with_total.ReplicationPerformanceWithTotal(total_bytes_per_sec=None, to_remote_bytes_per_sec=None, from_remote_bytes_per_sec=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(total_bytes_per_sec=None, to_remote_bytes_per_sec=None, from_remote_bytes_per_sec=None)
- Keyword Arguments
total_bytes_per_sec (int) – Total bytes transmitted and received per second. The number will be zero if the arrays are unable to communicate.
to_remote_bytes_per_sec (int) – The number of bytes transmitted per second to a remote array. The number will be zero if the arrays are unable to communicate.
from_remote_bytes_per_sec (int) – The number of bytes received per second from a remote array. The number will be zero if the arrays are unable to communicate.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'from_remote_bytes_per_sec': 'from_remote_bytes_per_sec', 'to_remote_bytes_per_sec': 'to_remote_bytes_per_sec', 'total_bytes_per_sec': 'total_bytes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'from_remote_bytes_per_sec': 'int', 'to_remote_bytes_per_sec': 'int', 'total_bytes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.replication_schedule module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.replication_schedule.ReplicationSchedule(at=None, enabled=None, frequency=None, blackout=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(at=None, enabled=None, frequency=None, blackout=None)
- Keyword Arguments
at (int) – The time of day the snapshot is scheduled to be taken and retained on the local array or immediately replicated to the target(s). Measured in seconds since midnight. The at value is only used if the frequency parameter is in days (e.g., 259200000, which is equal to 3 days).
enabled (bool) – If set to true, the policy is enabled.
frequency (int) – The frequency of the scheduled action. Measured in milliseconds.
blackout (TimeWindow) – The range of time when to suspend replication. To clear the blackout period, set to an empty string (“”).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'at': 'at', 'blackout': 'blackout', 'enabled': 'enabled', 'frequency': 'frequency'}
- keys()
- required_args = {}
- swagger_types = {'at': 'int', 'blackout': 'TimeWindow', 'enabled': 'bool', 'frequency': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource.Resource(name=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_access module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_access.ResourceAccess(resource=None, scope=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(resource=None, scope=None, id=None)
- Keyword Arguments
resource (ReferenceWithType) – Resource to which the scope has access.
scope (ReferenceWithType) – Scope which has access to the resource.
id (str) – ID of a resource access object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'resource': 'resource', 'scope': 'scope'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'resource': 'ReferenceWithType', 'scope': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_access_status module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_access_status.ResourceAccessStatus(resource=None, scope=None, created_by=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(resource=None, scope=None, created_by=None)
- Keyword Arguments
resource (ReferenceWithType) – Resource to which the scope has access.
scope (ReferenceWithType) – Scope which has access to the resource.
created_by (list[ResourceAccessStatusCreatedBy]) – Reference the IDs of resource accesses that created this status.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created_by': 'created_by', 'resource': 'resource', 'scope': 'scope'}
- keys()
- required_args = {}
- swagger_types = {'created_by': 'list[ResourceAccessStatusCreatedBy]', 'resource': 'ReferenceWithType', 'scope': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_access_status_created_by module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_access_status_created_by.ResourceAccessStatusCreatedBy(implicit=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(implicit=None, id=None)
- Keyword Arguments
implicit (bool) – Set to true when this resource access status was not explicitly created, but instead, its existence is implied by another resource access. Usually, this happens when a scope has access to a group of resources (e.g., a host group). Then this scope has access to each member of the group, individual hosts. Set to false when a resource access status reflects explicitly created resource access. Note that if there is both implicit and explicit access of an object to a scope, there will be only one entry in the response for that object and scope pair. The created_by field will contain both implicit and explicit resource access references.
id (str) – ID of a Resource Access.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'implicit': 'implicit'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'implicit': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_accesses_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_accesses_get_response.ResourceAccessesGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ResourceAccess]) – A list of resource access objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ResourceAccess]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_accesses_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_accesses_response.ResourceAccessesResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ResourceAccess]) – A list of resource access objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ResourceAccess]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_accesses_status_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_accesses_status_get_response.ResourceAccessesStatusGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[ResourceAccessStatus]) – A list of resource access status objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ResourceAccessStatus]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_accesses_status_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_accesses_status_response.ResourceAccessesStatusResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[ResourceAccessStatus]) – A list of resource access status objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[ResourceAccessStatus]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_directory_space module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_directory_space.ResourceDirectorySpace(name=None, id=None, time=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, time=None, space=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
time (int) – The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.
space (Space) – Displays size and space consumption information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'space': 'space', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'space': 'Space', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_directory_space_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_directory_space_get_response.ResourceDirectorySpaceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
total (list[ResourceDirectorySpace]) – The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field.
items (list[ResourceDirectorySpace]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ResourceDirectorySpace]', 'more_items_remaining': 'bool', 'total': 'list[ResourceDirectorySpace]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_fixed_non_unique_name module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_fixed_non_unique_name.ResourceFixedNonUniqueName(name=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None)
- Keyword Arguments
name (str) – Name of the resource. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_no_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_no_id.ResourceNoId(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_performance.ResourcePerformance(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'context': 'context', 'id': 'id', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'context': 'FixedReference', 'id': 'str', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_performance_by_array module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_performance_by_array.ResourcePerformanceByArray(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None, array=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None, context=None, array=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
array (Resource) – The array on which the performance metrics were recorded.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'array': 'array', 'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'context': 'context', 'id': 'id', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'array': 'Resource', 'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'context': 'FixedReference', 'id': 'str', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_performance_by_array_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_performance_by_array_get_response.ResourcePerformanceByArrayGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ResourcePerformanceByArray]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful.
items (list[ResourcePerformanceByArray]) – Performance data, broken down by array. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ResourcePerformanceByArray]', 'more_items_remaining': 'bool', 'total': 'list[ResourcePerformanceByArray]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_performance_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_performance_get_response.ResourcePerformanceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ResourcePerformance]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful.
items (list[ResourcePerformance]) – Performance data. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ResourcePerformance]', 'more_items_remaining': 'bool', 'total': 'list[ResourcePerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_performance_no_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_performance_no_id.ResourcePerformanceNoId(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, context=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, context=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A user-specified name. The name must be locally unique and can be changed.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'context': 'context', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'context': 'FixedReference', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_performance_no_id_by_array module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_performance_no_id_by_array.ResourcePerformanceNoIdByArray(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, context=None, array=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, context=None, array=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A user-specified name. The name must be locally unique and can be changed.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
array (Resource) – The array on which the performance metrics were recorded.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'array': 'array', 'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'context': 'context', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'array': 'Resource', 'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'context': 'FixedReference', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_performance_no_id_by_array_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_performance_no_id_by_array_get_response.ResourcePerformanceNoIdByArrayGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ResourcePerformanceNoIdByArray]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful.
items (list[ResourcePerformanceNoIdByArray]) – Performance data, broken down by array. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ResourcePerformanceNoIdByArray]', 'more_items_remaining': 'bool', 'total': 'list[ResourcePerformanceNoIdByArray]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_performance_no_id_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_performance_no_id_get_response.ResourcePerformanceNoIdGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ResourcePerformanceNoId]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful.
items (list[ResourcePerformanceNoId]) – Performance data. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ResourcePerformanceNoId]', 'more_items_remaining': 'bool', 'total': 'list[ResourcePerformanceNoId]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_pod_space module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_pod_space.ResourcePodSpace(name=None, id=None, context=None, time=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time=None, space=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time (int) – The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.
space (PodSpace) – Displays size and space consumption information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'id': 'id', 'name': 'name', 'space': 'space', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'id': 'str', 'name': 'str', 'space': 'PodSpace', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_pod_space_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_pod_space_get_response.ResourcePodSpaceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ResourcePodSpace]) – The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.
items (list[ResourcePodSpace]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ResourcePodSpace]', 'more_items_remaining': 'bool', 'total': 'list[ResourcePodSpace]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_realm_space module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_realm_space.ResourceRealmSpace(name=None, id=None, time=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, time=None, space=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
time (int) – The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.
space (SpaceNoDeprecatedPhysicalOrEffective) – Displays size and space consumption information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'space': 'space', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'space': 'SpaceNoDeprecatedPhysicalOrEffective', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_space module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_space.ResourceSpace(name=None, id=None, context=None, time=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time=None, space=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time (int) – The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.
space (Space) – Displays size and space consumption information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'id': 'id', 'name': 'name', 'space': 'space', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'id': 'str', 'name': 'str', 'space': 'Space', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_space_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_space_get_response.ResourceSpaceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ResourceSpace]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field.
items (list[ResourceSpace]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ResourceSpace]', 'more_items_remaining': 'bool', 'total': 'list[ResourceSpace]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_space_no_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_space_no_id.ResourceSpaceNoId(name=None, context=None, time=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, context=None, time=None, space=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time (int) –
space (Space) – Displays size and space consumption information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'name': 'name', 'space': 'space', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'name': 'str', 'space': 'Space', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.resource_space_no_id_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.resource_space_no_id_get_response.ResourceSpaceNoIdGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ResourceSpaceNoId]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[ResourceSpaceNoId]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.retention_policy module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.retention_policy.RetentionPolicy(all_for_sec=None, days=None, per_day=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(all_for_sec=None, days=None, per_day=None)
- Keyword Arguments
all_for_sec (int) – The length of time to keep the specified snapshots. Measured in seconds. Prior to 6.8.2 the range of 60 to 34560000 is accepted. In 6.8.2 and onwards the range of 60 to 2147483647 is accepted.
days (int) – The number of days to keep the snapshots after the all_for_sec period has passed. Prior to 6.6.4 the range of 0 to 4000 is accepted. In 6.6.4 and onwards the range of 0 to 2147483647 is accepted.
per_day (int) – The number of snapshots to keep per day after the all_for_sec period has passed. Prior to 6.8.2 the range of 0 to 1440 is accepted. In 6.8.2 and onwards the range of 0 to 2147483647 is accepted.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'all_for_sec': 'all_for_sec', 'days': 'days', 'per_day': 'per_day'}
- keys()
- required_args = {}
- swagger_types = {'all_for_sec': 'int', 'days': 'int', 'per_day': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.saml2_sso module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.saml2_sso.Saml2Sso(name=None, id=None, idp=None, sp=None, enabled=None, array_url=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, idp=None, sp=None, enabled=None, array_url=None)
- Keyword Arguments
name (str) – Name of the resource. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
idp (Saml2SsoIdp) –
sp (Saml2SsoSp) –
enabled (bool) – If set to true, the SAML2 SSO configuration is enabled.
array_url (str) – The URL of the array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'array_url': 'array_url', 'enabled': 'enabled', 'id': 'id', 'idp': 'idp', 'name': 'name', 'sp': 'sp'}
- keys()
- required_args = {}
- swagger_types = {'array_url': 'str', 'enabled': 'bool', 'id': 'str', 'idp': 'Saml2SsoIdp', 'name': 'str', 'sp': 'Saml2SsoSp'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.saml2_sso_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.saml2_sso_get_response.Saml2SsoGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Saml2Sso]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Saml2Sso]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.saml2_sso_idp module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.saml2_sso_idp.Saml2SsoIdp(verification_certificate=None, sign_request_enabled=None, metadata_url=None, encrypt_assertion_enabled=None, entity_id=None, url=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(verification_certificate=None, sign_request_enabled=None, metadata_url=None, encrypt_assertion_enabled=None, entity_id=None, url=None)
- Keyword Arguments
verification_certificate (str) – The X509 certificate that the service provider uses to verify the SAML response signature from the identity provider.
sign_request_enabled (bool) – If set to true, SAML requests will be signed by the service provider.
metadata_url (str) – The URL of the identity provider metadata.
encrypt_assertion_enabled (bool) – If set to true, SAML assertions will be encrypted by the identity provider.
entity_id (str) – A globally unique name for the identity provider.
url (str) – The URL of the identity provider.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'encrypt_assertion_enabled': 'encrypt_assertion_enabled', 'entity_id': 'entity_id', 'metadata_url': 'metadata_url', 'sign_request_enabled': 'sign_request_enabled', 'url': 'url', 'verification_certificate': 'verification_certificate'}
- keys()
- required_args = {}
- swagger_types = {'encrypt_assertion_enabled': 'bool', 'entity_id': 'str', 'metadata_url': 'str', 'sign_request_enabled': 'bool', 'url': 'str', 'verification_certificate': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.saml2_sso_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.saml2_sso_patch.Saml2SsoPatch(idp=None, sp=None, array_url=None, enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(idp=None, sp=None, array_url=None, enabled=None)
- Keyword Arguments
idp (Saml2SsoIdp) –
sp (Saml2SsoSpCredential) – Properties specific to the service provider.
array_url (str) – The URL of the array.
enabled (bool) – If set to true, the SAML2 SSO configuration is enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'array_url': 'array_url', 'enabled': 'enabled', 'idp': 'idp', 'sp': 'sp'}
- keys()
- required_args = {}
- swagger_types = {'array_url': 'str', 'enabled': 'bool', 'idp': 'Saml2SsoIdp', 'sp': 'Saml2SsoSpCredential'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.saml2_sso_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.saml2_sso_post.Saml2SsoPost(idp=None, sp=None, array_url=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(idp=None, sp=None, array_url=None)
- Keyword Arguments
idp (Saml2SsoIdp) –
sp (Saml2SsoSpCredential) – Properties specific to the service provider.
array_url (str) – The URL of the array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'array_url': 'array_url', 'idp': 'idp', 'sp': 'sp'}
- keys()
- required_args = {}
- swagger_types = {'array_url': 'str', 'idp': 'Saml2SsoIdp', 'sp': 'Saml2SsoSpCredential'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.saml2_sso_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.saml2_sso_response.Saml2SsoResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Saml2Sso]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.saml2_sso_sp module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.saml2_sso_sp.Saml2SsoSp(decryption_credential=None, signing_credential=None, metadata_url=None, assertion_consumer_url=None, entity_id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(decryption_credential=None, signing_credential=None, metadata_url=None, assertion_consumer_url=None, entity_id=None)
- Keyword Arguments
decryption_credential (ReferenceNoId) – The credential used by the service provider to decrypt encrypted SAML assertions from the identity provider. The credential is managed by the certificates endpoint and purecert CLI commands.
signing_credential (ReferenceNoId) – The credential used by the service provider to sign SAML requests. The credential is managed by the certificates endpoint and purecert CLI commands.
metadata_url (str) – The URL of the service provider metadata.
assertion_consumer_url (str) – The URL where the identity provider will send its SAML response after authenticating a user.
entity_id (str) – A globally unique name for the service provider.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'assertion_consumer_url': 'assertion_consumer_url', 'decryption_credential': 'decryption_credential', 'entity_id': 'entity_id', 'metadata_url': 'metadata_url', 'signing_credential': 'signing_credential'}
- keys()
- required_args = {}
- swagger_types = {'assertion_consumer_url': 'str', 'decryption_credential': 'ReferenceNoId', 'entity_id': 'str', 'metadata_url': 'str', 'signing_credential': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.saml2_sso_sp_credential module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.saml2_sso_sp_credential.Saml2SsoSpCredential(decryption_credential=None, signing_credential=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(decryption_credential=None, signing_credential=None)
- Keyword Arguments
decryption_credential (ReferenceNoId) – The credential used by the service provider to decrypt encrypted SAML assertions from the identity provider. The credential is managed by the certificates endpoint and purecert CLI commands.
signing_credential (ReferenceNoId) – The credential used by the service provider to sign SAML requests. The credential is managed by the certificates endpoint and purecert CLI commands.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'decryption_credential': 'decryption_credential', 'signing_credential': 'signing_credential'}
- keys()
- required_args = {}
- swagger_types = {'decryption_credential': 'ReferenceNoId', 'signing_credential': 'ReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.session module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.session.Session(name=None, id=None, start_time=None, method=None, event_count=None, end_time=None, user_interface=None, location=None, event=None, user=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, start_time=None, method=None, event_count=None, end_time=None, user_interface=None, location=None, event=None, user=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
start_time (int) – Date and time the user logged in to the Purity//FA interface.
method (str) – Method by which the user attempted to log in. Valid values include API token, JWT, password, and public key.
event_count (int) – Number of session events.
end_time (int) – Date and time the user logged out of the Purity//FA interface. Not set if the session is still active.
user_interface (str) – The user interface through which the user session event was performed. Valid values include CLI, GUI, and REST.
location (str) – IP address of the user client connecting to the array or console if connected through local console.
event (str) – Description of session events such as login and user session. Valid values include failed authentication, user session, login, logout, API token obtained, and request without session.
user (str) – Username of the Purity//FA user who triggered the user session event.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'end_time': 'end_time', 'event': 'event', 'event_count': 'event_count', 'id': 'id', 'location': 'location', 'method': 'method', 'name': 'name', 'start_time': 'start_time', 'user': 'user', 'user_interface': 'user_interface'}
- keys()
- required_args = {}
- swagger_types = {'end_time': 'int', 'event': 'str', 'event_count': 'int', 'id': 'str', 'location': 'str', 'method': 'str', 'name': 'str', 'start_time': 'int', 'user': 'str', 'user_interface': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.session_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.session_get_response.SessionGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Session]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Session]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.smis module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.smis.Smis(wbem_https_enabled=None, slp_enabled=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(wbem_https_enabled=None, slp_enabled=None)
- Keyword Arguments
wbem_https_enabled (bool) – If set to true, the SMI-S provider and its port, TCP 5989 is enabled.
slp_enabled (bool) – If set to true, the Service Location Protocol (SLP) and its ports, TCP 427 and UDP 427, are enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'slp_enabled': 'slp_enabled', 'wbem_https_enabled': 'wbem_https_enabled'}
- keys()
- required_args = {}
- swagger_types = {'slp_enabled': 'bool', 'wbem_https_enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.smis_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.smis_get_response.SmisGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Smis]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Smis]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.smis_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.smis_response.SmisResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Smis]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.smtp_server module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.smtp_server.SmtpServer(name=None, sender_username=None, subject_prefix=None, password=None, relay_host=None, user_name=None, encryption_mode=None, body_prefix=None, sender_domain=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, sender_username=None, subject_prefix=None, password=None, relay_host=None, user_name=None, encryption_mode=None, body_prefix=None, sender_domain=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
sender_username (str) – The local-part of the email address used when sending alert email messages.
subject_prefix (str) – Optional string added to the beginning of the subject when sending alert email messages. HTML tags are not allowed.
password (str) – Password for the relay host, if needed.
relay_host (str) – Relay server used as a forwarding point for email sent from the array. Can be set as a hostname, IPv4 address, or IPv6 address, with optional port numbers. The expected format for IPv4 is ddd.ddd.ddd.ddd:PORT. The expected format for IPv6 is xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx or, if a port number is specified, [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]:PORT.
user_name (str) – User name for the relay host, if needed.
encryption_mode (str) – Enforces an encryption mode when sending alert email messages. Valid values are starttls. Use “” to clear.
body_prefix (str) – Optional string added to the beginning of the email body when sending alert email messages. HTML tags are not allowed.
sender_domain (str) – Domain name appended to alert email messages.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'body_prefix': 'body_prefix', 'encryption_mode': 'encryption_mode', 'name': 'name', 'password': 'password', 'relay_host': 'relay_host', 'sender_domain': 'sender_domain', 'sender_username': 'sender_username', 'subject_prefix': 'subject_prefix', 'user_name': 'user_name'}
- keys()
- required_args = {}
- swagger_types = {'body_prefix': 'str', 'encryption_mode': 'str', 'name': 'str', 'password': 'str', 'relay_host': 'str', 'sender_domain': 'str', 'sender_username': 'str', 'subject_prefix': 'str', 'user_name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.smtp_server_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.smtp_server_get_response.SmtpServerGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SmtpServer]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SmtpServer]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.smtp_server_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.smtp_server_response.SmtpServerResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SmtpServer]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SmtpServer]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snapshot module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snapshot.Snapshot(time_remaining=None, destroyed=None, pod=None, provisioned=None, created=None, source=None, suffix=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(time_remaining=None, destroyed=None, pod=None, provisioned=None, created=None, source=None, suffix=None)
- Keyword Arguments
time_remaining (int) – The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered.
pod (FixedReference) – A reference to the pod.
provisioned (int) – The provisioned space of the snapshot. Measured in bytes. The minimum size is 1048576 (1MB), the maximum size is 4503599627370496 (4PB)
created (int) – The snapshot creation time. Measured in milliseconds since the UNIX epoch.
source (FixedReference) – The volume from which this snapshot was taken. For a replicated snapshot being viewed on the target side, the source is the replica volume.
suffix (str) – The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'destroyed': 'destroyed', 'pod': 'pod', 'provisioned': 'provisioned', 'source': 'source', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'created': 'int', 'destroyed': 'bool', 'pod': 'FixedReference', 'provisioned': 'int', 'source': 'FixedReference', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snapshot_schedule module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snapshot_schedule.SnapshotSchedule(at=None, enabled=None, frequency=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(at=None, enabled=None, frequency=None)
- Keyword Arguments
at (int) – The time of day the snapshot is scheduled to be taken and retained on the local array or immediately replicated to the target(s). Measured in seconds since midnight. The at value is only used if the frequency parameter is in days (e.g., 259200000, which is equal to 3 days).
enabled (bool) – If set to true, the policy is enabled.
frequency (int) – The frequency of the scheduled action. Measured in milliseconds.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'at': 'at', 'enabled': 'enabled', 'frequency': 'frequency'}
- keys()
- required_args = {}
- swagger_types = {'at': 'int', 'enabled': 'bool', 'frequency': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snapshot_space module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snapshot_space.SnapshotSpace(data_reduction=None, shared=None, virtual=None, used_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None, snapshots=None, total_physical=None, footprint=None, system=None, unique=None, total_provisioned=None, snapshots_effective=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(data_reduction=None, shared=None, virtual=None, used_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None, snapshots=None, total_physical=None, footprint=None, system=None, unique=None, total_provisioned=None, snapshots_effective=None)
- Keyword Arguments
data_reduction (float) – The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.
shared (int) – The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.
virtual (int) – The amount of logically written data that a volume or a snapshot references. Measured in bytes.
used_provisioned (int) – The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container.
total_reduction (float) – The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.
total_used (int) – The total space contributed by customer data, measured in bytes.
thin_provisioning (float) – The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.
snapshots (int) – The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.
total_physical (int) – This field has been deprecated. Use the total_used field, as it contains the same information.
footprint (int) – The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.
system (int) – The physical space occupied by internal array metadata. Measured in bytes.
unique (int) – The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.
total_provisioned (int) – The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.
snapshots_effective (int) – This field has been deprecated. The effective space contributed by data unique to one or more snapshots, measured in bytes. Use the snapshots field in the future, as it contains the same information for Evergreen//One arrays.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'data_reduction': 'data_reduction', 'footprint': 'footprint', 'shared': 'shared', 'snapshots': 'snapshots', 'snapshots_effective': 'snapshots_effective', 'system': 'system', 'thin_provisioning': 'thin_provisioning', 'total_physical': 'total_physical', 'total_provisioned': 'total_provisioned', 'total_reduction': 'total_reduction', 'total_used': 'total_used', 'unique': 'unique', 'used_provisioned': 'used_provisioned', 'virtual': 'virtual'}
- keys()
- required_args = {}
- swagger_types = {'data_reduction': 'float', 'footprint': 'int', 'shared': 'int', 'snapshots': 'int', 'snapshots_effective': 'int', 'system': 'int', 'thin_provisioning': 'float', 'total_physical': 'int', 'total_provisioned': 'int', 'total_reduction': 'float', 'total_used': 'int', 'unique': 'int', 'used_provisioned': 'int', 'virtual': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_agent module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_agent.SnmpAgent(name=None, engine_id=None, v2c=None, v3=None, version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, engine_id=None, v2c=None, v3=None, version=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
engine_id (str) – The administration domain unique name of an SNMP agent.
v2c (SnmpV2c) –
v3 (SnmpV3) –
version (str) – Version of the SNMP protocol to be used by Purity//FA in communications with the specified manager. Valid values are v2c and v3.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'engine_id': 'engine_id', 'name': 'name', 'v2c': 'v2c', 'v3': 'v3', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'engine_id': 'str', 'name': 'str', 'v2c': 'SnmpV2c', 'v3': 'SnmpV3', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_agent_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_agent_get_response.SnmpAgentGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SnmpAgent]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SnmpAgent]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_agent_mib module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_agent_mib.SnmpAgentMib(mib=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(mib=None)
- Keyword Arguments
mib (str) – MIB text.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'mib': 'mib'}
- keys()
- required_args = {}
- swagger_types = {'mib': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_agent_mib_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_agent_mib_get_response.SnmpAgentMibGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SnmpAgentMib]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SnmpAgentMib]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_agent_mib_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_agent_mib_response.SnmpAgentMibResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SnmpAgentMib]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SnmpAgentMib]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_agent_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_agent_patch.SnmpAgentPatch(name=None, engine_id=None, v2c=None, v3=None, version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, engine_id=None, v2c=None, v3=None, version=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
engine_id (str) – The administration domain unique name of an SNMP agent.
v2c (SnmpV2c) –
v3 (SnmpV3Patch) –
version (str) – Version of the SNMP protocol to be used by Purity//FA in communications with the specified manager. Valid values are v2c and v3.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'engine_id': 'engine_id', 'name': 'name', 'v2c': 'v2c', 'v3': 'v3', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'engine_id': 'str', 'name': 'str', 'v2c': 'SnmpV2c', 'v3': 'SnmpV3Patch', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_agent_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_agent_response.SnmpAgentResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SnmpAgent]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_manager module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_manager.SnmpManager(name=None, notification=None, v2c=None, host=None, v3=None, version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, notification=None, v2c=None, host=None, v3=None, version=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
notification (str) – The type of notification the agent will send. Valid values are inform and trap.
v2c (SnmpV2c) –
host (str) – DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity//FA is to send trap messages when it generates alerts.
v3 (SnmpV3) –
version (str) – Version of the SNMP protocol to be used by Purity//FA to communicate with the specified manager. Valid values are v2c and v3.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'host': 'host', 'name': 'name', 'notification': 'notification', 'v2c': 'v2c', 'v3': 'v3', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'host': 'str', 'name': 'str', 'notification': 'str', 'v2c': 'SnmpV2c', 'v3': 'SnmpV3', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_manager_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_manager_get_response.SnmpManagerGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SnmpManager]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SnmpManager]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_manager_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_manager_patch.SnmpManagerPatch(name=None, notification=None, v2c=None, host=None, v3=None, version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, notification=None, v2c=None, host=None, v3=None, version=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
notification (str) – The type of notification the agent will send. Valid values are inform and trap.
v2c (SnmpV2c) –
host (str) – DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity//FA is to send trap messages when it generates alerts.
v3 (SnmpV3Patch) –
version (str) – Version of the SNMP protocol to be used by Purity//FA to communicate with the specified manager. Valid values are v2c and v3.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'host': 'host', 'name': 'name', 'notification': 'notification', 'v2c': 'v2c', 'v3': 'v3', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'host': 'str', 'name': 'str', 'notification': 'str', 'v2c': 'SnmpV2c', 'v3': 'SnmpV3Patch', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_manager_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_manager_post.SnmpManagerPost(notification=None, v2c=None, host=None, v3=None, version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(notification=None, v2c=None, host=None, v3=None, version=None)
- Keyword Arguments
notification (str) – The type of notification the agent will send. Valid values are inform and trap.
v2c (SnmpV2c) –
host (str) – DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity//FA is to send trap messages when it generates alerts.
v3 (SnmpV3Post) –
version (str) – Version of the SNMP protocol to be used by Purity//FA to communicate with the specified manager. Valid values are v2c and v3.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'host': 'host', 'notification': 'notification', 'v2c': 'v2c', 'v3': 'v3', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'host': 'str', 'notification': 'str', 'v2c': 'SnmpV2c', 'v3': 'SnmpV3Post', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_manager_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_manager_response.SnmpManagerResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SnmpManager]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SnmpManager]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_v2c module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_v2c.SnmpV2c(community=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(community=None)
- Keyword Arguments
community (str) – Manager community ID under which Purity//FA is to communicate with the specified managers.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'community': 'community'}
- keys()
- required_args = {}
- swagger_types = {'community': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_v3 module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_v3.SnmpV3(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
- Keyword Arguments
auth_protocol (str) – Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.
privacy_protocol (str) – Encryption protocol for SNMP messages. Valid values are AES and DES.
auth_passphrase (str) – Passphrase used by Purity//FA to authenticate the array with the specified managers.
privacy_passphrase (str) – Passphrase used to encrypt SNMP messages.
user (str) – User ID recognized by the specified SNMP managers which Purity//FA is to use in communications with them.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'auth_passphrase': 'auth_passphrase', 'auth_protocol': 'auth_protocol', 'privacy_passphrase': 'privacy_passphrase', 'privacy_protocol': 'privacy_protocol', 'user': 'user'}
- keys()
- required_args = {}
- swagger_types = {'auth_passphrase': 'str', 'auth_protocol': 'str', 'privacy_passphrase': 'str', 'privacy_protocol': 'str', 'user': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_v3_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_v3_patch.SnmpV3Patch(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
- Keyword Arguments
auth_protocol (str) – Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.
privacy_protocol (str) – Encryption protocol for SNMP messages. Valid values are AES and DES.
auth_passphrase (str) – Passphrase used by Purity//FA to authenticate the array with the specified managers.
privacy_passphrase (str) – Passphrase used to encrypt SNMP messages.
user (str) – User ID recognized by the specified SNMP managers which Purity//FA is to use in communications with them.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'auth_passphrase': 'auth_passphrase', 'auth_protocol': 'auth_protocol', 'privacy_passphrase': 'privacy_passphrase', 'privacy_protocol': 'privacy_protocol', 'user': 'user'}
- keys()
- required_args = {}
- swagger_types = {'auth_passphrase': 'str', 'auth_protocol': 'str', 'privacy_passphrase': 'str', 'privacy_protocol': 'str', 'user': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.snmp_v3_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.snmp_v3_post.SnmpV3Post(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
- Keyword Arguments
auth_protocol (str) – Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.
privacy_protocol (str) – Encryption protocol for SNMP messages. Valid values are AES and DES.
auth_passphrase (str) – Passphrase used by Purity//FA to authenticate the array with the specified managers.
privacy_passphrase (str) – Passphrase used to encrypt SNMP messages.
user (str) – User ID recognized by the specified SNMP managers which Purity//FA is to use in communications with them.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'auth_passphrase': 'auth_passphrase', 'auth_protocol': 'auth_protocol', 'privacy_passphrase': 'privacy_passphrase', 'privacy_protocol': 'privacy_protocol', 'user': 'user'}
- keys()
- required_args = {}
- swagger_types = {'auth_passphrase': 'str', 'auth_protocol': 'str', 'privacy_passphrase': 'str', 'privacy_protocol': 'str', 'user': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software.Software(name=None, id=None, payload_id=None, upgrade_plan=None, upgrade_hops=None, progress=None, details=None, version=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, payload_id=None, upgrade_plan=None, upgrade_hops=None, progress=None, details=None, version=None, status=None)
- Keyword Arguments
name (str) – Name of the resource. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
payload_id (str) – A checksum hash referring to the update bundle.
upgrade_plan (list[SoftwareUpgradePlan]) – A list of steps that are planned to run during the upgrade in an optimal scenario (i.e., all upgrade checks pass, no step is retried, and the upgrade is not aborted). Steps are listed in the order that they should occur.
upgrade_hops (list[str]) – The plan by which the upgrade will be conducted. The first element is the current version, the last element is the destination version, and the elements in between are intermediate versions.
progress (float) – The progress of the software upgrade. Displayed in decimal format.
details (str) – The detailed reason for the status.
version (str) – The version of the software package.
status (str) – The status of the software package. Valid values are available, downloaded, downloading, download_failed, checking, installing, new, paused, aborting, abort, canceled, partially_installed, and installed. A status of available indicates that the package is available for download. This only applies if automatic-download is not enabled. A status of downloaded indicates that the package is downloaded and ready for installation. A status of downloading indicates that the package is currently downloading. A status of download_failed indicates that the download of the package failed. A status of checking indicates that the package is currently running in check-only mode. A status of installing indicates that the package is currently installing. A status of new indicates that Pure1 cloud is still building the package. A status of paused indicates that the upgrade is paused and waiting for user input to proceed. A status of aborting indicates that the upgrade is being aborted, due to an unrecoverable error or an abort command issued by the user. A status of canceled indicates that the upgrade has been canceled. A status of partially_installed indicates that the upgrade has been partially installed due to an abort. The array has been upgraded to an intermediate version and the software is no longer available for installation. A status of installed indicates that the upgrade has finished.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'id': 'id', 'name': 'name', 'payload_id': 'payload_id', 'progress': 'progress', 'status': 'status', 'upgrade_hops': 'upgrade_hops', 'upgrade_plan': 'upgrade_plan', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'details': 'str', 'id': 'str', 'name': 'str', 'payload_id': 'str', 'progress': 'float', 'status': 'str', 'upgrade_hops': 'list[str]', 'upgrade_plan': 'list[SoftwareUpgradePlan]', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_bundle module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_bundle.SoftwareBundle(id=None, download_progress=None, created=None, details=None, source=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(id=None, download_progress=None, created=None, details=None, source=None, status=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
download_progress (float) – The progress of the download. Displayed in decimal format.
created (float) – Creation time in milliseconds since the UNIX epoch.
details (str) – The detailed reason for the status.
source (str) – The location of the upgrade bundle.
status (str) – The status of the software bundle. Valid values are downloading, failed, ready, and verifying. A status of downloading indicates that the array is downloading the upgrade bundle. A status of failed indicates that the array has failed to download the upgrade bundle. A status of ready indicates that the upgrade bundle is ready to be installed. A status of verifying indicates that the array is verifying the upgrade bundle.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'details': 'details', 'download_progress': 'download_progress', 'id': 'id', 'source': 'source', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'created': 'float', 'details': 'str', 'download_progress': 'float', 'id': 'str', 'source': 'str', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_bundle_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_bundle_get_response.SoftwareBundleGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SoftwareBundle]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SoftwareBundle]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_bundle_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_bundle_post.SoftwareBundlePost(source=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(source=None)
- Keyword Arguments
source (str) – The source of the software bundle. Accepts HTTP, HTTPS or FTP, and paths.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'source': 'source'}
- keys()
- required_args = {}
- swagger_types = {'source': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_bundle_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_bundle_response.SoftwareBundleResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SoftwareBundle]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SoftwareBundle]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_check module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_check.SoftwareCheck(name=None, id=None, start_time=None, end_time=None, checks=None, details=None, software_name=None, software_version=None, software_upgrade_hops=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, start_time=None, end_time=None, checks=None, details=None, software_name=None, software_version=None, software_upgrade_hops=None, status=None)
- Keyword Arguments
name (str) – Name of the resource. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
start_time (int) – Start time in milliseconds since the UNIX epoch.
end_time (int) – End time in milliseconds since the UNIX epoch.
checks (list[SoftwareChecksChecks]) – A list of checks in this check task.
details (str) – The detailed reason for the status.
software_name (str) – The name of the software the upgrade checks will test.
software_version (str) – The version of the software that the upgrade checks will test.
software_upgrade_hops (list[str]) – The list of software versions the upgrade goes through. The upgrade checks also test this particular path.
status (str) – The status of the check task. Valid values are queued, running, passed, and failed. A status of queued indicates that the task is queued to run and is waiting for other check tasks to complete. A status of running indicates that the task is currently running. A status of passed indicates that all upgrade checks in the task are complete. A status of failed indicates that at least one upgrade check in the task has failed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'checks': 'checks', 'details': 'details', 'end_time': 'end_time', 'id': 'id', 'name': 'name', 'software_name': 'software_name', 'software_upgrade_hops': 'software_upgrade_hops', 'software_version': 'software_version', 'start_time': 'start_time', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'checks': 'list[SoftwareChecksChecks]', 'details': 'str', 'end_time': 'int', 'id': 'str', 'name': 'str', 'software_name': 'str', 'software_upgrade_hops': 'list[str]', 'software_version': 'str', 'start_time': 'int', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_checks_checks module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_checks_checks.SoftwareChecksChecks(name=None, details=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, details=None, status=None)
- Keyword Arguments
name (str) – Name of the upgrade check.
details (str) – Detailed result of the check used to diagnose check failures.
status (str) – Status of the check. Valid values are running, failed, and passed. A status of running indicates that the check has not finished. A status of failed indicates that the check has failed. A status of passed indicates that the check has passed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'name': 'name', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'details': 'str', 'name': 'str', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_checks_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_checks_get_response.SoftwareChecksGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SoftwareCheck]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SoftwareCheck]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_checks_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_checks_response.SoftwareChecksResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SoftwareCheck]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SoftwareCheck]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_get_response.SoftwareGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Software]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Software]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_installation module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_installation.SoftwareInstallation(name=None, id=None, start_time=None, end_time=None, mode=None, current_step_id=None, override_checks=None, software=None, details=None, upgrade_parameters=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, start_time=None, end_time=None, mode=None, current_step_id=None, override_checks=None, software=None, details=None, upgrade_parameters=None, status=None)
- Keyword Arguments
name (str) – Name of the resource. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
start_time (int) – Start time in milliseconds since the UNIX epoch.
end_time (int) – End time in milliseconds since the UNIX epoch.
mode (str) – Mode that the upgrade is in. Valid values are check-only, interactive, semi-interactive, and one-click. The check_only mode is deprecated. Use /software-checks. In this mode, the upgrade only runs pre-upgrade checks and returns. In interactive mode, the upgrade pauses at several points, at which users must enter certain commands to proceed. In semi-interactive mode, the upgrade pauses if there are any upgrade check failures, and functions like one-click mode otherwise. In one-click mode, the upgrade proceeds automatically without pausing.
current_step_id (str) – The id of the current step or null if the upgrade is not active.
override_checks (list[OverrideCheck]) – A list of upgrade checks whose failure is overridden during the upgrade. If any optional args are provided, they are validated later when the corresponding check script runs.
software (Reference) – Referenced software to which the upgrade belongs.
details (str) – The detailed reason for the status.
upgrade_parameters (list[UpgradeParameters]) – A list of parameters to be sent to the upgrade process. These parameters can be used to change the behavior of the upgrade process in specific ways such as enabling or disabling features in the target version or changing the attributes of the appliance at upgrade time. When there is a need or option to set an upgrade parameter, Pure Storage will provide documentation for the specific parameter. If you have been provided documentation related to a specific upgrade parameter, follow the instructions in the documentation. Otherwise, do not set any upgrade parameters.
status (str) – Status of the upgrade. Valid values are installing, paused, aborting, aborted, and finished. A status of installing indicates that the upgrade is running. A status of paused indicates that the upgrade is paused and waiting for user input. A status of aborting indicates that the upgrade is being aborted. A status of aborted indicates that the upgrade has stopped due to an abort. A status of finished indicates that the upgrade has finished successfully.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'current_step_id': 'current_step_id', 'details': 'details', 'end_time': 'end_time', 'id': 'id', 'mode': 'mode', 'name': 'name', 'override_checks': 'override_checks', 'software': 'software', 'start_time': 'start_time', 'status': 'status', 'upgrade_parameters': 'upgrade_parameters'}
- keys()
- required_args = {}
- swagger_types = {'current_step_id': 'str', 'details': 'str', 'end_time': 'int', 'id': 'str', 'mode': 'str', 'name': 'str', 'override_checks': 'list[OverrideCheck]', 'software': 'Reference', 'start_time': 'int', 'status': 'str', 'upgrade_parameters': 'list[UpgradeParameters]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_installation_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_installation_patch.SoftwareInstallationPatch(add_override_checks=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(add_override_checks=None)
- Keyword Arguments
add_override_checks (list[OverrideCheck]) – Adds the specified checks to the current list of override checks.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'add_override_checks': 'add_override_checks'}
- keys()
- required_args = {}
- swagger_types = {'add_override_checks': 'list[OverrideCheck]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_installation_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_installation_post.SoftwareInstallationPost(mode=None, override_checks=None, upgrade_parameters=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(mode=None, override_checks=None, upgrade_parameters=None)
- Keyword Arguments
mode (str) – Mode that the upgrade is in. Valid values are check-only, interactive, semi-interactive, and one-click. The check_only mode is deprecated. Use /software-checks. In this mode, the upgrade only runs pre-upgrade checks and returns. In interactive mode, the upgrade pauses at several points, at which users must enter certain commands to proceed. In semi-interactive mode, the upgrade pauses if there are any upgrade check failures and functions like one-click mode otherwise. In one-click mode, the upgrade proceeds automatically without pausing.
override_checks (list[OverrideCheck]) – A list of upgrade checks whose failures are overridden during the upgrade. If any optional args are provided, they are validated later when the corresponding check script runs.
upgrade_parameters (list[UpgradeParameters]) – A list of parameters to be sent to the upgrade process. These parameters can be used to change the behavior of the upgrade process in specific ways such as enabling or disabling features in the target version or changing the attributes of the appliance at upgrade time. When there is a need or option to set an upgrade parameter, Pure Storage will provide documentation for the specific parameter. If you have been provided documentation related to a specific upgrade parameter, follow the instructions in the documentation. Otherwise, do not set any upgrade parameters.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'mode': 'mode', 'override_checks': 'override_checks', 'upgrade_parameters': 'upgrade_parameters'}
- keys()
- required_args = {}
- swagger_types = {'mode': 'str', 'override_checks': 'list[OverrideCheck]', 'upgrade_parameters': 'list[UpgradeParameters]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_installation_step module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_installation_step.SoftwareInstallationStep(name=None, id=None, start_time=None, end_time=None, checks=None, hop_version=None, installation=None, description=None, details=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, start_time=None, end_time=None, checks=None, hop_version=None, installation=None, description=None, details=None, status=None)
- Keyword Arguments
name (str) – Name of the resource. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
start_time (int) – Start time in milliseconds since the UNIX epoch.
end_time (int) – End time in milliseconds since the UNIX epoch.
checks (list[SoftwareInstallationStepsChecks]) – A list of checks in this upgrade step.
hop_version (str) – The version to which the current hop is upgrading.
installation (Reference) – Referenced software-installation to which the step belongs.
description (str) – Detailed description of the step.
details (str) – Detailed result of the step used to diagnose step failures.
status (str) – Status of the step. Valid values are running and finished. A status of running indicates that the step has not finished. A status of finished indicates that the check has finished.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'checks': 'checks', 'description': 'description', 'details': 'details', 'end_time': 'end_time', 'hop_version': 'hop_version', 'id': 'id', 'installation': 'installation', 'name': 'name', 'start_time': 'start_time', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'checks': 'list[SoftwareInstallationStepsChecks]', 'description': 'str', 'details': 'str', 'end_time': 'int', 'hop_version': 'str', 'id': 'str', 'installation': 'Reference', 'name': 'str', 'start_time': 'int', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_installation_steps_checks module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_installation_steps_checks.SoftwareInstallationStepsChecks(name=None, overridable=None, details=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, overridable=None, details=None, status=None)
- Keyword Arguments
name (str) – Name of the upgrade check.
overridable (bool) – Whether the check failure can be overridden.
details (str) – Detailed result of the check used to diagnose check failures.
status (str) – Status of the check. Valid values are running, failed, passed, and overridden. A status of running indicates that the check has not finished. A status of failed indicates that the check has failed. A status of passed indicates that the check has passed. A status of overridden indicates that the check has failed, but the failure has been overridden.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'name': 'name', 'overridable': 'overridable', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'details': 'str', 'name': 'str', 'overridable': 'bool', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_installation_steps_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_installation_steps_get_response.SoftwareInstallationStepsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SoftwareInstallationStep]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SoftwareInstallationStep]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_installation_steps_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_installation_steps_response.SoftwareInstallationStepsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SoftwareInstallationStep]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SoftwareInstallationStep]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_installations_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_installations_get_response.SoftwareInstallationsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SoftwareInstallation]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SoftwareInstallation]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_installations_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_installations_response.SoftwareInstallationsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SoftwareInstallation]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SoftwareInstallation]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_patch.SoftwarePatch(name=None, id=None, description=None, progress=None, details=None, alert_code=None, ha_reduction_required=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, description=None, progress=None, details=None, alert_code=None, ha_reduction_required=None, status=None)
- Keyword Arguments
name (str) – Name of the resource. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
description (str) – The detailed description of the patch.
progress (float) – The progress of the software patch installation, displayed in decimal format.
details (str) – The detailed reason for the status.
alert_code (int) – Alert code for the Software Patch. This code is used to uniquely identify the Software Patch.
ha_reduction_required (bool) – If set to true, indicates reduction in high availability is required for Software Patch installation. If set to false, indicates such a reduction is not required.
status (str) – The status of the software patch installation. Valid values are available, downloaded, downloading, download_failed, installing, installed, failed, and not_applicable. A status of available indicates that the patch is available for download. A status of downloaded indicates that the patch has been downloaded and will be installed. A status of downloading indicates that the patch is currently downloading. A status of download_failed indicates that the download of the patch failed. A status of installing indicates that the patch is currently being installed. A status of installed indicates that the patch has been installed. A status of failed indicates that the patch failed to be installed. A status of not_applicable indicates the patch does not need to be installed on the array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'alert_code': 'alert_code', 'description': 'description', 'details': 'details', 'ha_reduction_required': 'ha_reduction_required', 'id': 'id', 'name': 'name', 'progress': 'progress', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'alert_code': 'int', 'description': 'str', 'details': 'str', 'ha_reduction_required': 'bool', 'id': 'str', 'name': 'str', 'progress': 'float', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_patches_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_patches_get_response.SoftwarePatchesGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SoftwarePatch]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SoftwarePatch]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_patches_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_patches_response.SoftwarePatchesResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SoftwarePatch]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SoftwarePatch]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_post.SoftwarePost(name=None, version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, version=None)
- Keyword Arguments
name (str) – The name of the software.
version (str) – The version of the software.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_response.SoftwareResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Software]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_upgrade_plan module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_upgrade_plan.SoftwareUpgradePlan(step_name=None, hop_version=None, description=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(step_name=None, hop_version=None, description=None)
- Keyword Arguments
step_name (str) – Name of the upgrade step.
hop_version (str) – The version to which the step is upgrading.
description (str) – Description of the upgrade step.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'description': 'description', 'hop_version': 'hop_version', 'step_name': 'step_name'}
- keys()
- required_args = {}
- swagger_types = {'description': 'str', 'hop_version': 'str', 'step_name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_version module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_version.SoftwareVersion(upgrade_hops=None, name=None, details=None, version=None, release_family=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(upgrade_hops=None, name=None, details=None, version=None, release_family=None)
- Keyword Arguments
upgrade_hops (list[str]) – The list of software versions the upgrade will go through.
name (str) – The name of the software.
details (str) – The description of the version.
version (str) – The version of the software.
release_family (str) – The major and minor release number of the version.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'name': 'name', 'release_family': 'release_family', 'upgrade_hops': 'upgrade_hops', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'details': 'str', 'name': 'str', 'release_family': 'str', 'upgrade_hops': 'list[str]', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_versions_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_versions_get_response.SoftwareVersionsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SoftwareVersion]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SoftwareVersion]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.software_versions_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.software_versions_response.SoftwareVersionsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SoftwareVersion]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SoftwareVersion]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.space module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.space.Space(data_reduction=None, shared=None, virtual=None, used_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None, snapshots=None, total_physical=None, footprint=None, system=None, unique=None, total_provisioned=None, replication=None, shared_effective=None, snapshots_effective=None, unique_effective=None, total_effective=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(data_reduction=None, shared=None, virtual=None, used_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None, snapshots=None, total_physical=None, footprint=None, system=None, unique=None, total_provisioned=None, replication=None, shared_effective=None, snapshots_effective=None, unique_effective=None, total_effective=None)
- Keyword Arguments
data_reduction (float) – The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.
shared (int) – The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.
virtual (int) – The amount of logically written data that a volume or a snapshot references. Measured in bytes.
used_provisioned (int) – The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container.
total_reduction (float) – The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.
total_used (int) – The total space contributed by customer data, measured in bytes.
thin_provisioning (float) – The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.
snapshots (int) – The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.
total_physical (int) – This field has been deprecated. Use the total_used field, as it contains the same information.
footprint (int) – The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.
system (int) – The physical space occupied by internal array metadata. Measured in bytes.
unique (int) – The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.
total_provisioned (int) – The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.
replication (int) – The sum of replication space consumed by all pods on this array.
shared_effective (int) – This field has been deprecated. It will return null. Use the shared field in the future, as it contains the same information for Evergreen//One arrays.
snapshots_effective (int) – This field has deprecated. It will return null. Use the snapshots field in the future, as it contains the same information for Evergreen//One arrays.
unique_effective (int) – This field has been deprecated. It will return null. Use the unique field in the future, as it contains the same information for Evergreen//One arrays.
total_effective (int) – This field has been deprecated. It will return null. PUse the total_physical field instead, as it contains the same information for Evergreen//One arrays.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'data_reduction': 'data_reduction', 'footprint': 'footprint', 'replication': 'replication', 'shared': 'shared', 'shared_effective': 'shared_effective', 'snapshots': 'snapshots', 'snapshots_effective': 'snapshots_effective', 'system': 'system', 'thin_provisioning': 'thin_provisioning', 'total_effective': 'total_effective', 'total_physical': 'total_physical', 'total_provisioned': 'total_provisioned', 'total_reduction': 'total_reduction', 'total_used': 'total_used', 'unique': 'unique', 'unique_effective': 'unique_effective', 'used_provisioned': 'used_provisioned', 'virtual': 'virtual'}
- keys()
- required_args = {}
- swagger_types = {'data_reduction': 'float', 'footprint': 'int', 'replication': 'int', 'shared': 'int', 'shared_effective': 'int', 'snapshots': 'int', 'snapshots_effective': 'int', 'system': 'int', 'thin_provisioning': 'float', 'total_effective': 'int', 'total_physical': 'int', 'total_provisioned': 'int', 'total_reduction': 'float', 'total_used': 'int', 'unique': 'int', 'unique_effective': 'int', 'used_provisioned': 'int', 'virtual': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.space_no_deprecated_physical_or_effective module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.space_no_deprecated_physical_or_effective.SpaceNoDeprecatedPhysicalOrEffective(snapshots=None, data_reduction=None, shared=None, virtual=None, footprint=None, system=None, used_provisioned=None, unique=None, total_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(snapshots=None, data_reduction=None, shared=None, virtual=None, footprint=None, system=None, used_provisioned=None, unique=None, total_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None)
- Keyword Arguments
snapshots (int) – The physical space occupied by data unique to one or more snapshots, measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.
data_reduction (float) – The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.
shared (int) – The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication, measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.
virtual (int) – The amount of logically written data that a volume or a snapshot references, measured in bytes.
footprint (int) – The maximum amount of physical space the container would take up on any array, ignoring any data shared outside the container. Measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space, measured in bytes. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.
system (int) – The physical space occupied by internal array metadata, measured in bytes.
used_provisioned (int) – The amount of logical space a container has consumed. The amount of logical space is compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. For a destroyed container, used provisioned can include destroyed objects and represents how much logical space it would take to recover the container.
unique (int) – The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.
total_provisioned (int) – The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.
total_reduction (float) – The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.
total_used (int) – The total space contributed by customer data, measured in bytes.
thin_provisioning (float) – The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'data_reduction': 'data_reduction', 'footprint': 'footprint', 'shared': 'shared', 'snapshots': 'snapshots', 'system': 'system', 'thin_provisioning': 'thin_provisioning', 'total_provisioned': 'total_provisioned', 'total_reduction': 'total_reduction', 'total_used': 'total_used', 'unique': 'unique', 'used_provisioned': 'used_provisioned', 'virtual': 'virtual'}
- keys()
- required_args = {}
- swagger_types = {'data_reduction': 'float', 'footprint': 'int', 'shared': 'int', 'snapshots': 'int', 'system': 'int', 'thin_provisioning': 'float', 'total_provisioned': 'int', 'total_reduction': 'float', 'total_used': 'int', 'unique': 'int', 'used_provisioned': 'int', 'virtual': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.start_end_time module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.start_end_time.StartEndTime(start_time=None, end_time=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(start_time=None, end_time=None)
- Keyword Arguments
start_time (int) – Start time in milliseconds since the UNIX epoch.
end_time (int) – End time in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'end_time': 'end_time', 'start_time': 'start_time'}
- keys()
- required_args = {}
- swagger_types = {'end_time': 'int', 'start_time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subnet module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subnet.Subnet(name=None, vlan=None, prefix=None, enabled=None, gateway=None, mtu=None, interfaces=None, services=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, vlan=None, prefix=None, enabled=None, gateway=None, mtu=None, interfaces=None, services=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
vlan (int) – VLAN ID number.
prefix (str) – The IPv4 or IPv6 address to be associated with the specified subnet.
enabled (bool) – Returns a value of true if subnet is enabled. Returns a value of false if subnet is disabled. If not specified, defaults to true.
gateway (str) – The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.
mtu (int) – Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to 1500.
interfaces (list[FixedReferenceNoId]) – List of network interfaces associated with this subnet.
services (list[str]) – The services provided by this subnet, as inherited from all of its interfaces.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'gateway': 'gateway', 'interfaces': 'interfaces', 'mtu': 'mtu', 'name': 'name', 'prefix': 'prefix', 'services': 'services', 'vlan': 'vlan'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'gateway': 'str', 'interfaces': 'list[FixedReferenceNoId]', 'mtu': 'int', 'name': 'str', 'prefix': 'str', 'services': 'list[str]', 'vlan': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subnet_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subnet_get_response.SubnetGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Subnet]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Subnet]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subnet_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subnet_patch.SubnetPatch(name=None, vlan=None, prefix=None, enabled=None, gateway=None, mtu=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, vlan=None, prefix=None, enabled=None, gateway=None, mtu=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
vlan (int) – VLAN ID number.
prefix (str) – The IPv4 or IPv6 address to be associated with the specified subnet.
enabled (bool) – Returns a value of true if subnet is enabled. Returns a value of false if subnet is disabled. If not specified, defaults to true.
gateway (str) – The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.
mtu (int) – Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to 1500.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'gateway': 'gateway', 'mtu': 'mtu', 'name': 'name', 'prefix': 'prefix', 'vlan': 'vlan'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'gateway': 'str', 'mtu': 'int', 'name': 'str', 'prefix': 'str', 'vlan': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subnet_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subnet_post.SubnetPost(vlan=None, prefix=None, enabled=None, gateway=None, mtu=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(vlan=None, prefix=None, enabled=None, gateway=None, mtu=None)
- Keyword Arguments
vlan (int) – VLAN ID number.
prefix (str) – The IPv4 or IPv6 address to be associated with the specified subnet.
enabled (bool) – Returns a value of true if subnet is enabled. Returns a value of false if subnet is disabled. If not specified, defaults to true.
gateway (str) – The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.
mtu (int) – Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to 1500.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'gateway': 'gateway', 'mtu': 'mtu', 'prefix': 'prefix', 'vlan': 'vlan'}
- keys()
- required_args = {}
- swagger_types = {'enabled': 'bool', 'gateway': 'str', 'mtu': 'int', 'prefix': 'str', 'vlan': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subnet_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subnet_response.SubnetResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Subnet]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subscription module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subscription.Subscription(service=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(service=None, id=None)
- Keyword Arguments
service (str) – The service type of the subscription.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'service': 'service'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'service': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subscription_asset module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subscription_asset.SubscriptionAsset(name=None, id=None, subscription=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, subscription=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
subscription (SubscriptionAssetSubscription) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'subscription': 'subscription'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'subscription': 'SubscriptionAssetSubscription'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subscription_asset_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subscription_asset_get_response.SubscriptionAssetGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SubscriptionAsset]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SubscriptionAsset]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subscription_asset_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subscription_asset_response.SubscriptionAssetResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SubscriptionAsset]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SubscriptionAsset]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subscription_asset_subscription module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subscription_asset_subscription.SubscriptionAssetSubscription(id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(id=None)
- Keyword Arguments
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subscription_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subscription_get_response.SubscriptionGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Subscription]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Subscription]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.subscription_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.subscription_response.SubscriptionResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Subscription]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Subscription]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support.Support(proxy=None, phonehome_enabled=None, remote_assist_duration=None, remote_assist_active=None, remote_assist_paths=None, remote_assist_status=None, remote_assist_opened=None, remote_assist_expires=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(proxy=None, phonehome_enabled=None, remote_assist_duration=None, remote_assist_active=None, remote_assist_paths=None, remote_assist_status=None, remote_assist_opened=None, remote_assist_expires=None)
- Keyword Arguments
proxy (str) – The value of the current proxy, which is used to connect to cloud services such as phonehome and remote assist. Specify the server name, including the scheme and proxy port number.
phonehome_enabled (bool) – If set to true, enables phonehome. If set to false, disables phonehome.
remote_assist_duration (int) – Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. It determines the length of time the session will remain active after it’s initiated.
remote_assist_active (bool) – If set to true, enables the remote assist session. If set to false, disables the remote assist session.
remote_assist_paths (list[SupportRemoteAssistPaths]) –
remote_assist_status (str) – The status of the remote assist session. Values include connected, connecting, disconnected, and session-active.
remote_assist_opened (int) – The timestamp when the session opened, measured in milliseconds since the UNIX epoch.
remote_assist_expires (int) – The timestamp when the session expires, measured in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'phonehome_enabled': 'phonehome_enabled', 'proxy': 'proxy', 'remote_assist_active': 'remote_assist_active', 'remote_assist_duration': 'remote_assist_duration', 'remote_assist_expires': 'remote_assist_expires', 'remote_assist_opened': 'remote_assist_opened', 'remote_assist_paths': 'remote_assist_paths', 'remote_assist_status': 'remote_assist_status'}
- keys()
- required_args = {}
- swagger_types = {'phonehome_enabled': 'bool', 'proxy': 'str', 'remote_assist_active': 'bool', 'remote_assist_duration': 'int', 'remote_assist_expires': 'int', 'remote_assist_opened': 'int', 'remote_assist_paths': 'list[SupportRemoteAssistPaths]', 'remote_assist_status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_diagnostics_details module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_diagnostics_details.SupportDiagnosticsDetails(severity=None, test_name=None, result_details=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(severity=None, test_name=None, result_details=None)
- Keyword Arguments
severity (str) – Severity level of the test. Valid values are info, warning, and critical.
test_name (str) – Name of the test that was performed.
result_details (str) – Additional details related to the test. This field also provides remediation information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'result_details': 'result_details', 'severity': 'severity', 'test_name': 'test_name'}
- keys()
- required_args = {}
- swagger_types = {'result_details': 'str', 'severity': 'str', 'test_name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_diagnostics_details_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_diagnostics_details_get_response.SupportDiagnosticsDetailsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SupportDiagnosticsDetails]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SupportDiagnosticsDetails]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_diagnostics_details_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_diagnostics_details_response.SupportDiagnosticsDetailsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SupportDiagnosticsDetails]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SupportDiagnosticsDetails]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_diagnostics_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_diagnostics_get_response.SupportDiagnosticsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SupportDiagnosticsSettings]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SupportDiagnosticsSettings]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_diagnostics_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_diagnostics_response.SupportDiagnosticsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SupportDiagnosticsSettings]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SupportDiagnosticsSettings]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_diagnostics_settings module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_diagnostics_settings.SupportDiagnosticsSettings(last_updated=None, version=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(last_updated=None, version=None)
- Keyword Arguments
last_updated (int) – Date the diagnostics tool was last updated.
version (str) – Version of the diagnostics tool.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'last_updated': 'last_updated', 'version': 'version'}
- keys()
- required_args = {}
- swagger_types = {'last_updated': 'int', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_get_response.SupportGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Support]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Support]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_patch.SupportPatch(proxy=None, phonehome_enabled=None, remote_assist_duration=None, remote_assist_active=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(proxy=None, phonehome_enabled=None, remote_assist_duration=None, remote_assist_active=None)
- Keyword Arguments
proxy (str) – The value of the current proxy, which is used for connecting to cloud services such as phonehome, remote assist, etc. Specify the server name, including the scheme and proxy port number.
phonehome_enabled (bool) – The status of phonehome. If set to true, enable phonehome. If set to false, disable phonehome.
remote_assist_duration (int) – Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. This parameter determines the length of time the session will remain active after it is initiated.
remote_assist_active (bool) – The status of a remote assist session. If set to true, enable the remote assist session. If set to false, disable the remote assist session.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'phonehome_enabled': 'phonehome_enabled', 'proxy': 'proxy', 'remote_assist_active': 'remote_assist_active', 'remote_assist_duration': 'remote_assist_duration'}
- keys()
- required_args = {}
- swagger_types = {'phonehome_enabled': 'bool', 'proxy': 'str', 'remote_assist_active': 'bool', 'remote_assist_duration': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_remote_assist_paths module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_remote_assist_paths.SupportRemoteAssistPaths(component_name=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(component_name=None, status=None)
- Keyword Arguments
component_name (str) – The name of the local controller that is running the remote assist session.
status (str) – The status of the remote assist session on the local controller. Values include connected, connecting, disconnected, and session-active.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'component_name': 'component_name', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'component_name': 'str', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.support_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.support_response.SupportResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Support]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.syslog_server module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.syslog_server.SyslogServer(name=None, context=None, target_type=None, services=None, uri=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, context=None, target_type=None, services=None, uri=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and cannot be changed.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
target_type (str) – The type of log target. Valid values include file, and syslog.
services (list[str]) – Valid values are data-audit and management. If not specified, defaults to management.
uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'name': 'name', 'services': 'services', 'target_type': 'target_type', 'uri': 'uri'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'name': 'str', 'services': 'list[str]', 'target_type': 'str', 'uri': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.syslog_server_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.syslog_server_get_response.SyslogServerGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SyslogServer]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[SyslogServer]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.syslog_server_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.syslog_server_response.SyslogServerResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SyslogServer]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SyslogServer]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.syslog_server_settings module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.syslog_server_settings.SyslogServerSettings(context=None, ca_certificate=None, tls_audit_enabled=None, logging_severity=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, ca_certificate=None, tls_audit_enabled=None, logging_severity=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
ca_certificate (str) – The certificate of the certificate authority (CA) that signed the directory servers’ certificate(s), which is used to validate the authenticity of the configured servers.
tls_audit_enabled (bool) – Returns a value of true if messages that are necessary in order to audit TLS negotiations performed by the array are forwarded to the configured syslog servers.
logging_severity (str) – Returns the configured logging severity threshold for which events will be forwarded to the configured syslog servers. Default configuration is info level severity. Valid values are debug, info, and notice.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ca_certificate': 'ca_certificate', 'context': 'context', 'logging_severity': 'logging_severity', 'tls_audit_enabled': 'tls_audit_enabled'}
- keys()
- required_args = {}
- swagger_types = {'ca_certificate': 'str', 'context': 'FixedReference', 'logging_severity': 'str', 'tls_audit_enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.syslog_server_settings_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.syslog_server_settings_get_response.SyslogServerSettingsGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[SyslogServerSettings]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[SyslogServerSettings]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.syslog_server_settings_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.syslog_server_settings_response.SyslogServerSettingsResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[SyslogServerSettings]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[SyslogServerSettings]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.tag module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.tag.Tag(context=None, copyable=None, resource=None, namespace=None, value=None, key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, copyable=None, resource=None, namespace=None, value=None, key=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
copyable (bool) – Specifies whether or not to include the tag when copying the parent resource. If set to true, the tag is included in resource copying. If set to false, the tag is not included. If not specified, defaults to true.
resource (FixedReference) –
namespace (str) – Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace default. The pure* namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.
value (str) – Value of the tag. Supports up to 256 Unicode characters.
key (str) – Key of the tag. Supports up to 64 Unicode characters.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'copyable': 'copyable', 'key': 'key', 'namespace': 'namespace', 'resource': 'resource', 'value': 'value'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'copyable': 'bool', 'key': 'str', 'namespace': 'str', 'resource': 'FixedReference', 'value': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.tag_batch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.tag_batch.TagBatch(copyable=None, resource=None, namespace=None, value=None, key=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(copyable=None, resource=None, namespace=None, value=None, key=None)
- Keyword Arguments
copyable (bool) – Specifies whether or not to include the tag when copying the parent resource. If set to true, the tag is included in resource copying. If set to false, the tag is not included. If not specified, defaults to true.
resource (Reference) – A reference to the parent object.
namespace (str) – Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace default. The pure* namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.
value (str) – Value of the tag. Supports up to 256 Unicode characters.
key (str) – Key of the tag. Supports up to 64 Unicode characters.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'copyable': 'copyable', 'key': 'key', 'namespace': 'namespace', 'resource': 'resource', 'value': 'value'}
- keys()
- required_args = {}
- swagger_types = {'copyable': 'bool', 'key': 'str', 'namespace': 'str', 'resource': 'Reference', 'value': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.tag_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.tag_get_response.TagGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Tag]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Tag]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.tag_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.tag_response.TagResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Tag]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.target_protection_group module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.target_protection_group.TargetProtectionGroup(context=None, allowed=None, member=None, group=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, allowed=None, member=None, group=None, status=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
allowed (bool) – If set to true, the target array or pod allows the source array to replicate protection group data to the target. If set to false, the target array or pod does not allow the source array to replicate protection group data to the target.
member (ReferenceWithType) –
group (Reference) –
status (str) – The replication status of the target. Valid values are replicating, suspended, and disallowed. If allowed is true and protection group data is replicating to the target, status will display replicating. If allowed is true, but replication is suspended due to the target being demoted, linked, stretched, etc., status will display suspended. Replication will be automatically resumed if the target becomes promoted or local only again. If allowed is false, status will display disallowed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed': 'allowed', 'context': 'context', 'group': 'group', 'member': 'member', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'allowed': 'bool', 'context': 'FixedReference', 'group': 'Reference', 'member': 'ReferenceWithType', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.target_protection_group_post_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.target_protection_group_post_patch.TargetProtectionGroupPostPatch(protection_group=None, allowed=None, target=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(protection_group=None, allowed=None, target=None)
- Keyword Arguments
protection_group (FixedReference) –
allowed (bool) – If set to true, the target array has allowed the source array to replicate protection group data to the target array. If set to false, the target array has not allowed the source array to replicate protection group data to the target.
target (FixedReferenceNoId) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed': 'allowed', 'protection_group': 'protection_group', 'target': 'target'}
- keys()
- required_args = {}
- swagger_types = {'allowed': 'bool', 'protection_group': 'FixedReference', 'target': 'FixedReferenceNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result.TestResult(success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None)
- Keyword Arguments
success (bool) – Whether the object being tested passed the test or not. Returns a value of true if the specified test has succeeded. Returns a value of false if the specified test has failed.
component_name (str) – Name of the component running the test.
destination (str) – The URI of the target server being tested.
description (str) – What the test is doing.
component_address (str) – Address of the component running the test.
enabled (bool) – Whether the object being tested is enabled or not. Returns a value of true if the the service is enabled. Returns a value of false if the service is disabled.
result_details (str) – Additional information about the test result.
test_type (str) – Displays the type of test being performed. The returned values are determined by the resource being tested and its configuration. Values include array-admin-group-searching, binding, connecting, phonehome, phonehome-ping, remote-assist, rootdse-searching, read-only-group-searching, storage-admin-group-searching, and validate-ntp-configuration.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'component_address': 'component_address', 'component_name': 'component_name', 'description': 'description', 'destination': 'destination', 'enabled': 'enabled', 'result_details': 'result_details', 'success': 'success', 'test_type': 'test_type'}
- keys()
- required_args = {}
- swagger_types = {'component_address': 'str', 'component_name': 'str', 'description': 'str', 'destination': 'str', 'enabled': 'bool', 'result_details': 'str', 'success': 'bool', 'test_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result_get_response.TestResultGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[TestResult]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[TestResult]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result_response.TestResultResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[TestResult]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[TestResult]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result_with_resource module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result_with_resource.TestResultWithResource(success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None, context=None, resource=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None, context=None, resource=None)
- Keyword Arguments
success (bool) – Whether the object being tested passed the test or not. Returns a value of true if the specified test has succeeded. Returns a value of false if the specified test has failed.
component_name (str) – Name of the component running the test.
destination (str) – The URI of the target server being tested.
description (str) – What the test is doing.
component_address (str) – Address of the component running the test.
enabled (bool) – Whether the object being tested is enabled or not. Returns a value of true if the the service is enabled. Returns a value of false if the service is disabled.
result_details (str) – Additional information about the test result.
test_type (str) – Displays the type of test being performed. The returned values are determined by the resource being tested and its configuration. Values include array-admin-group-searching, binding, connecting, phonehome, phonehome-ping, remote-assist, rootdse-searching, read-only-group-searching, storage-admin-group-searching, and validate-ntp-configuration.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
resource (FixedReferenceNoId) – A reference to the object being tested.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'component_address': 'component_address', 'component_name': 'component_name', 'context': 'context', 'description': 'description', 'destination': 'destination', 'enabled': 'enabled', 'resource': 'resource', 'result_details': 'result_details', 'success': 'success', 'test_type': 'test_type'}
- keys()
- required_args = {}
- swagger_types = {'component_address': 'str', 'component_name': 'str', 'context': 'FixedReference', 'description': 'str', 'destination': 'str', 'enabled': 'bool', 'resource': 'FixedReferenceNoId', 'result_details': 'str', 'success': 'bool', 'test_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result_with_resource_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result_with_resource_get_response.TestResultWithResourceGetResponse(total_item_count=None, errors=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(total_item_count=None, errors=None, items=None)
- Keyword Arguments
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[TestResultWithResource]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'errors': 'errors', 'items': 'items', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[TestResultWithResource]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result_with_resource_patch_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result_with_resource_patch_response.TestResultWithResourcePatchResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[TestResultWithResource]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[TestResultWithResource]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result_with_resource_post_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result_with_resource_post_response.TestResultWithResourcePostResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[TestResultWithResource]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[TestResultWithResource]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result_with_resource_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result_with_resource_response.TestResultWithResourceResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[TestResultWithResource]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[TestResultWithResource]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result_with_resource_with_id module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result_with_resource_with_id.TestResultWithResourceWithId(success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None, context=None, resource=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None, context=None, resource=None)
- Keyword Arguments
success (bool) – Whether the object being tested passed the test or not. Returns a value of true if the specified test has succeeded. Returns a value of false if the specified test has failed.
component_name (str) – Name of the component running the test.
destination (str) – The URI of the target server being tested.
description (str) – What the test is doing.
component_address (str) – Address of the component running the test.
enabled (bool) – Whether the object being tested is enabled or not. Returns a value of true if the the service is enabled. Returns a value of false if the service is disabled.
result_details (str) – Additional information about the test result.
test_type (str) – Displays the type of test being performed. The returned values are determined by the resource being tested and its configuration. Values include array-admin-group-searching, binding, connecting, phonehome, phonehome-ping, remote-assist, rootdse-searching, read-only-group-searching, storage-admin-group-searching, and validate-ntp-configuration.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
resource (FixedReference) – A reference to the object being tested.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'component_address': 'component_address', 'component_name': 'component_name', 'context': 'context', 'description': 'description', 'destination': 'destination', 'enabled': 'enabled', 'resource': 'resource', 'result_details': 'result_details', 'success': 'success', 'test_type': 'test_type'}
- keys()
- required_args = {}
- swagger_types = {'component_address': 'str', 'component_name': 'str', 'context': 'FixedReference', 'description': 'str', 'destination': 'str', 'enabled': 'bool', 'resource': 'FixedReference', 'result_details': 'str', 'success': 'bool', 'test_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.test_result_with_resource_with_id_post_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.test_result_with_resource_with_id_post_response.TestResultWithResourceWithIdPostResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[TestResultWithResourceWithId]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[TestResultWithResourceWithId]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.throttle module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.throttle.Throttle(window=None, default_limit=None, window_limit=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(window=None, default_limit=None, window_limit=None)
- Keyword Arguments
window (TimeWindow) – The time during which the window_limit threshold is in effect.
default_limit (int) – Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs.
window_limit (int) – Maximum bandwidth threshold for outbound traffic during the specified window_limit time range in bytes. Once exceeded, bandwidth throttling occurs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'default_limit': 'default_limit', 'window': 'window', 'window_limit': 'window_limit'}
- keys()
- required_args = {}
- swagger_types = {'default_limit': 'int', 'window': 'TimeWindow', 'window_limit': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.throttle_deprecated module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.throttle_deprecated.ThrottleDeprecated(window=None, default_limit=None, window_limit=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(window=None, default_limit=None, window_limit=None)
- Keyword Arguments
window (TimeWindow) – Deprecated. The time during which the window_limit threshold is in effect.
default_limit (int) – Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs.
window_limit (int) – Deprecated. Maximum bandwidth threshold for outbound traffic during the specified window_limit time range in bytes. Once exceeded, bandwidth throttling occurs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'default_limit': 'default_limit', 'window': 'window', 'window_limit': 'window_limit'}
- keys()
- required_args = {}
- swagger_types = {'default_limit': 'int', 'window': 'TimeWindow', 'window_limit': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.time_window module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.time_window.TimeWindow(start=None, end=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(start=None, end=None)
- Keyword Arguments
start (int) – The window start time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., 18000000, which is equal to 5:00 AM).
end (int) – The window end time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., 28800000, which is equal to 8:00 AM).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'end': 'end', 'start': 'start'}
- keys()
- required_args = {}
- swagger_types = {'end': 'int', 'start': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.total_item_count_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.total_item_count_response.TotalItemCountResponse(total_item_count=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(total_item_count=None)
- Keyword Arguments
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.transfer module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.transfer.Transfer(physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None)
- Keyword Arguments
physical_bytes_written (int) – The amount of physical/logical data written to the target due to replication. Measured in bytes.
data_transferred (int) – The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.
destroyed (bool) – Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.
progress (float) – The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.
started (int) – The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.
completed (int) – The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'completed': 'completed', 'data_transferred': 'data_transferred', 'destroyed': 'destroyed', 'physical_bytes_written': 'physical_bytes_written', 'progress': 'progress', 'started': 'started'}
- keys()
- required_args = {}
- swagger_types = {'completed': 'int', 'data_transferred': 'int', 'destroyed': 'bool', 'physical_bytes_written': 'int', 'progress': 'float', 'started': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.upgrade_parameters module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.upgrade_parameters.UpgradeParameters(name=None, value=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, value=None)
- Keyword Arguments
name (str) – The name of the upgrade parameter to be sent to the upgrade process.
value (str) – The value of the upgrade parameter to be sent to the upgrade process.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'value': 'value'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str', 'value': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.username module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.username.Username(username=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(username=None)
- Keyword Arguments
username (str) – The username of the user.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'username': 'username'}
- keys()
- required_args = {}
- swagger_types = {'username': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.username_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.username_response.UsernameResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Username]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost.Vchost(name=None, id=None, vcuuid=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, vcuuid=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
vcuuid (str) – The vCenter Server uuid of the vchost.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'vcuuid': 'vcuuid'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'vcuuid': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_certificate module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_certificate.VchostCertificate(endpoints=None, certificate=None, vchost=None, id=None, is_local=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(endpoints=None, certificate=None, vchost=None, id=None, is_local=None)
- Keyword Arguments
endpoints (list[str]) – The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the configured certificate will be presented.
certificate (ReferenceNoIdWithType) – A reference to the certificate that will be presented to clients accessing the referenced vchost using any of the network addresses defined by endpoints.
vchost (ReferenceWithType) – The vchost by which the certificate is to be presented over the configured endpoints.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
is_local (bool) – Returns true if the vchost certificate is local to the array, and false otherwise.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificate': 'certificate', 'endpoints': 'endpoints', 'id': 'id', 'is_local': 'is_local', 'vchost': 'vchost'}
- keys()
- required_args = {}
- swagger_types = {'certificate': 'ReferenceNoIdWithType', 'endpoints': 'list[str]', 'id': 'str', 'is_local': 'bool', 'vchost': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_certificate_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_certificate_get_response.VchostCertificateGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[VchostCertificate]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[VchostCertificate]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_certificate_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_certificate_patch.VchostCertificatePatch(endpoints=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(endpoints=None)
- Keyword Arguments
endpoints (list[str]) – The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the configured certificate will be presented.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'endpoints': 'endpoints'}
- keys()
- required_args = {}
- swagger_types = {'endpoints': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_certificate_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_certificate_post.VchostCertificatePost(endpoints=None, certificate=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(endpoints=None, certificate=None)
- Keyword Arguments
endpoints (list[str]) – The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the configured certificate will be presented.
certificate (ReferenceNoIdWithType) – The certificate to be presented by the vchost over the configured endpoints.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificate': 'certificate', 'endpoints': 'endpoints'}
- keys()
- required_args = {}
- swagger_types = {'certificate': 'ReferenceNoIdWithType', 'endpoints': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_certificate_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_certificate_response.VchostCertificateResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[VchostCertificate]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[VchostCertificate]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_connection module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_connection.VchostConnection(protocol_endpoint=None, vchost=None, all_vchosts=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(protocol_endpoint=None, vchost=None, all_vchosts=None)
- Keyword Arguments
protocol_endpoint (FixedReference) – A reference to the protocol endpoint, representing a storage container that vCenter can use.
vchost (FixedReference) – For vchost-connections, a vchost represents a vCenter. By connecting to a protocol endpoint, the corresponding vCenter gets the access to the storage container represented by this protocol endpoint. The vchost name should be null if all_vchosts is set to true, which means the storage container is accessible to all vchosts.
all_vchosts (bool) – If set to true, the storage container represented by the protocol endpoint is accessible to all vchosts. If set to false, the storage container represented by the protocol endpoint is only accesible to the vchosts that have explicit vchost-connections to this protocol endpoint. The default is false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'all_vchosts': 'all_vchosts', 'protocol_endpoint': 'protocol_endpoint', 'vchost': 'vchost'}
- keys()
- required_args = {}
- swagger_types = {'all_vchosts': 'bool', 'protocol_endpoint': 'FixedReference', 'vchost': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_connection_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_connection_get_response.VchostConnectionGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[VchostConnection]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[VchostConnection]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_connection_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_connection_response.VchostConnectionResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[VchostConnection]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[VchostConnection]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_endpoint module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_endpoint.VchostEndpoint(endpoint=None, certificates=None, vchost=None, id=None, is_local=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(endpoint=None, certificates=None, vchost=None, id=None, is_local=None)
- Keyword Arguments
endpoint (str) – The IPv4 or IPv6 address of the endpoint.
certificates (list[ReferenceNoIdWithType]) – The certificate to be presented by the vchost over the configured endpoints.
vchost (ReferenceWithType) – The vchost for which this endpoint is to be configured.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
is_local (bool) – Returns true if the vchost endpoint is local to the array, and false otherwise.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificates': 'certificates', 'endpoint': 'endpoint', 'id': 'id', 'is_local': 'is_local', 'vchost': 'vchost'}
- keys()
- required_args = {}
- swagger_types = {'certificates': 'list[ReferenceNoIdWithType]', 'endpoint': 'str', 'id': 'str', 'is_local': 'bool', 'vchost': 'ReferenceWithType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_endpoint_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_endpoint_get_response.VchostEndpointGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[VchostEndpoint]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[VchostEndpoint]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_endpoint_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_endpoint_patch.VchostEndpointPatch(certificates=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(certificates=None)
- Keyword Arguments
certificates (list[ReferenceNoIdWithType]) – The certificate to be presented by the vchost over the configured endpoints.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificates': 'certificates'}
- keys()
- required_args = {}
- swagger_types = {'certificates': 'list[ReferenceNoIdWithType]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_endpoint_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_endpoint_post.VchostEndpointPost(endpoint=None, certificates=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(endpoint=None, certificates=None)
- Keyword Arguments
endpoint (str) – The IPv4 or IPv6 address of the endpoint.
certificates (list[ReferenceNoIdWithType]) – The certificate to be presented by the vchost over the configured endpoints.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificates': 'certificates', 'endpoint': 'endpoint'}
- keys()
- required_args = {}
- swagger_types = {'certificates': 'list[ReferenceNoIdWithType]', 'endpoint': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_endpoint_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_endpoint_response.VchostEndpointResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[VchostEndpoint]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[VchostEndpoint]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_get_response.VchostGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Vchost]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Vchost]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_patch.VchostPatch(name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None)
- Keyword Arguments
name (str) – The new name of the vchost.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_post.VchostPost(vcuuid=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(vcuuid=None)
- Keyword Arguments
vcuuid (str) – The vCenter Server uuid of the vchost.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'vcuuid': 'vcuuid'}
- keys()
- required_args = {}
- swagger_types = {'vcuuid': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.vchost_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.vchost_response.VchostResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Vchost]) – Returns a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Vchost]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.virtual_machine module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.virtual_machine.VirtualMachine(time_remaining=None, destroyed=None, vm_id=None, vm_type=None, created=None, name=None, recover_context=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(time_remaining=None, destroyed=None, vm_id=None, vm_type=None, created=None, name=None, recover_context=None, id=None)
- Keyword Arguments
time_remaining (int) – The amount of time left until the destroyed volume is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the virtual machine has been destroyed and is pending eradication.
vm_id (str) – The ID of the virtual machine, as assigned by the external system.
vm_type (str) – The type of virtual machine. The only valid value is vvol.
created (int) – The virtual machine creation time, measured in milliseconds since the UNIX epoch.
name (str) – The name of the virtual machine, as assigned by the external system
recover_context (FixedReference) – A reference to any additional entities needed to recover this virtual machine.
id (str) – The ID of the virtual machine to create or modify, as assigned by the external system. id is deprecated. Use vm_id instead.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'recover_context': 'recover_context', 'time_remaining': 'time_remaining', 'vm_id': 'vm_id', 'vm_type': 'vm_type'}
- keys()
- required_args = {}
- swagger_types = {'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'recover_context': 'FixedReference', 'time_remaining': 'int', 'vm_id': 'str', 'vm_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.virtual_machine_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.virtual_machine_get_response.VirtualMachineGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[VirtualMachine]) – Displays a list of all items after filtering. The values are displayed for each name if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[VirtualMachine]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.virtual_machine_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.virtual_machine_post.VirtualMachinePost(vm_id=None, vm_type=None, id=None, source=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(vm_id=None, vm_type=None, id=None, source=None)
- Keyword Arguments
vm_id (str) – The ID of the virtual machine to create or modify, as assigned by the external system.
vm_type (str) – The type of virtual machine. The only valid value is vvol.
id (str) – The ID of the virtual machine to create or modify, as assigned by the external system. id is deprecated. Use vm_id instead.
source (Reference) – The recovery context for the virtual machine or virtual machine snapshot being modified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'source': 'source', 'vm_id': 'vm_id', 'vm_type': 'vm_type'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'source': 'Reference', 'vm_id': 'str', 'vm_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.virtual_machine_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.virtual_machine_response.VirtualMachineResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[VirtualMachine]) – Displays a list of all items after filtering. The values are displayed for each name if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[VirtualMachine]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.virtual_machine_volume_snapshot module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.virtual_machine_volume_snapshot.VirtualMachineVolumeSnapshot(time_remaining=None, destroyed=None, vm_id=None, vm_type=None, created=None, name=None, recover_context=None, vvol_type=None, id=None, vvol_name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(time_remaining=None, destroyed=None, vm_id=None, vm_type=None, created=None, name=None, recover_context=None, vvol_type=None, id=None, vvol_name=None)
- Keyword Arguments
time_remaining (int) – Specifies the amount of time left until the destroyed volume snapshot is permanently eradicated, measured in milliseconds. Once the time_remaining period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered.
destroyed (bool) – Returns a value of true if the virtual machine volume snapshot has been destroyed and is pending eradication.
vm_id (str) – The ID of the virtual machine, as assigned by the external system.
vm_type (str) – The type of virtual machine. The only valid value is vvol.
created (int) – The virtual machine volume snapshot creation time measured in milliseconds since the UNIX epoch.
name (str) – The name of the virtual machine volume snapshot.
recover_context (FixedReference) – A reference to any additional entities needed to recover this virtual machine.
vvol_type (str) – The type of virtual machine volume. Values include config and data.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
vvol_name (str) – The name of the virtual machine volume.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'recover_context': 'recover_context', 'time_remaining': 'time_remaining', 'vm_id': 'vm_id', 'vm_type': 'vm_type', 'vvol_name': 'vvol_name', 'vvol_type': 'vvol_type'}
- keys()
- required_args = {}
- swagger_types = {'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'recover_context': 'FixedReference', 'time_remaining': 'int', 'vm_id': 'str', 'vm_type': 'str', 'vvol_name': 'str', 'vvol_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.virtual_machine_volume_snapshot_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.virtual_machine_volume_snapshot_response.VirtualMachineVolumeSnapshotResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[VirtualMachineVolumeSnapshot]) – Displays a list of all items after filtering. The values are displayed for each name if meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[VirtualMachineVolumeSnapshot]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume.Volume(name=None, id=None, time_remaining=None, destroyed=None, host_encryption_key_status=None, provisioned=None, qos=None, serial=None, created=None, connection_count=None, priority_adjustment=None, space=None, context=None, protocol_endpoint=None, promotion_status=None, pod=None, subtype=None, requested_promotion_state=None, workload=None, source=None, volume_group=None, priority=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, time_remaining=None, destroyed=None, host_encryption_key_status=None, provisioned=None, qos=None, serial=None, created=None, connection_count=None, priority_adjustment=None, space=None, context=None, protocol_endpoint=None, promotion_status=None, pod=None, subtype=None, requested_promotion_state=None, workload=None, source=None, volume_group=None, priority=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
time_remaining (int) – The amount of time left until the destroyed volume is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the volume has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume is permanently eradicated and can no longer be recovered.
host_encryption_key_status (str) – The host encryption key status for this volume. Values include none, detected, and fetched.
provisioned (int) – The virtual size of the volume as a multiple of 512, measured in bytes. The maximum size is 4503599627370496 (4PB).
qos (Qos) – Displays QoS limit information.
serial (str) – A globally unique serial number generated by the FlashArray when the volume is created.
created (int) – The volume creation time, measured in milliseconds since the UNIX epoch.
connection_count (int) – The total number of hosts and host groups connected to the volume.
priority_adjustment (PriorityAdjustment) – Priority adjustment operator and value.
space (VolumeSpaceCommon) – Displays size and space consumption information.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
protocol_endpoint (ProtocolEndpoint) – Properties that are specific to volumes of subtype=protocol_endpoint.
promotion_status (str) – Current promotion status of a volume. Values include promoted and demoted. A status of promoted indicates that the volume has been promoted and can accept write requests from hosts. This is the default status for a volume when it is created. A status of demoted indicates that the volume has been demoted and no longer accepts write requests.
pod (Reference) – A reference to the pod.
subtype (str) – The type of volume. Values include protocol_endpoint and regular.
requested_promotion_state (str) – Values include promoted and demoted. Patch requested_promotion_state to demoted to demote the volume so that the volume stops accepting write requests. Patch requested_promotion_state to promoted to promote the volume so that the volume starts accepting write requests.
workload (WorkloadConfigurationReference) – A reference to the workload that is managing this volume. The name may show as an empty string briefly after controller failover.
source (FixedReference) – A reference to the originating volume as a result of a volume copy.
volume_group (Reference) – A reference to the volume group.
priority (int) – The current priority value. Priority is calculated by combining all applicable relative priority_adjustment values or taking the exact value if the volume has an absolute priority_adjustment (specified by an = priority_adjustment_operator).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'connection_count': 'connection_count', 'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'host_encryption_key_status': 'host_encryption_key_status', 'id': 'id', 'name': 'name', 'pod': 'pod', 'priority': 'priority', 'priority_adjustment': 'priority_adjustment', 'promotion_status': 'promotion_status', 'protocol_endpoint': 'protocol_endpoint', 'provisioned': 'provisioned', 'qos': 'qos', 'requested_promotion_state': 'requested_promotion_state', 'serial': 'serial', 'source': 'source', 'space': 'space', 'subtype': 'subtype', 'time_remaining': 'time_remaining', 'volume_group': 'volume_group', 'workload': 'workload'}
- keys()
- required_args = {}
- swagger_types = {'connection_count': 'int', 'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'host_encryption_key_status': 'str', 'id': 'str', 'name': 'str', 'pod': 'Reference', 'priority': 'int', 'priority_adjustment': 'PriorityAdjustment', 'promotion_status': 'str', 'protocol_endpoint': 'ProtocolEndpoint', 'provisioned': 'int', 'qos': 'Qos', 'requested_promotion_state': 'str', 'serial': 'str', 'source': 'FixedReference', 'space': 'VolumeSpaceCommon', 'subtype': 'str', 'time_remaining': 'int', 'volume_group': 'Reference', 'workload': 'WorkloadConfigurationReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_batch_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_batch_post.VolumeBatchPost(destroyed=None, protocol_endpoint=None, provisioned=None, qos=None, subtype=None, source=None, priority_adjustment=None, tags=None, add_to_protection_groups=None, name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None, protocol_endpoint=None, provisioned=None, qos=None, subtype=None, source=None, priority_adjustment=None, tags=None, add_to_protection_groups=None, name=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
protocol_endpoint (ProtocolEndpoint) – Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to subtype=protocol_endpoint.
provisioned (int) – Sets the virtual size of the volume, measured in bytes.
qos (Qos) – Sets QoS limits.
subtype (str) – The type of volume. Valid values are protocol_endpoint and regular.
source (Reference) – The source volume of a volume copy.
priority_adjustment (PriorityAdjustment) – Adjusts volume priority.
tags (list[Tag]) – The list of tags to be upserted with the object.
add_to_protection_groups (list[Reference]) – Specifies a list of protection groups that will compose the initial protection for the volume.
name (str) – Specifies the name of the volume.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'add_to_protection_groups': 'add_to_protection_groups', 'destroyed': 'destroyed', 'name': 'name', 'priority_adjustment': 'priority_adjustment', 'protocol_endpoint': 'protocol_endpoint', 'provisioned': 'provisioned', 'qos': 'qos', 'source': 'source', 'subtype': 'subtype', 'tags': 'tags'}
- keys()
- required_args = {}
- swagger_types = {'add_to_protection_groups': 'list[Reference]', 'destroyed': 'bool', 'name': 'str', 'priority_adjustment': 'PriorityAdjustment', 'protocol_endpoint': 'ProtocolEndpoint', 'provisioned': 'int', 'qos': 'Qos', 'source': 'Reference', 'subtype': 'str', 'tags': 'list[Tag]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_common module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_common.VolumeCommon(name=None, id=None, time_remaining=None, destroyed=None, host_encryption_key_status=None, provisioned=None, qos=None, serial=None, created=None, connection_count=None, priority_adjustment=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, time_remaining=None, destroyed=None, host_encryption_key_status=None, provisioned=None, qos=None, serial=None, created=None, connection_count=None, priority_adjustment=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
time_remaining (int) – The amount of time left until the destroyed volume is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the volume has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume is permanently eradicated and can no longer be recovered.
host_encryption_key_status (str) – The host encryption key status for this volume. Values include none, detected, and fetched.
provisioned (int) – The virtual size of the volume as a multiple of 512, measured in bytes. The maximum size is 4503599627370496 (4PB).
qos (Qos) – Displays QoS limit information.
serial (str) – A globally unique serial number generated by the FlashArray when the volume is created.
created (int) – The volume creation time, measured in milliseconds since the UNIX epoch.
connection_count (int) – The total number of hosts and host groups connected to the volume.
priority_adjustment (PriorityAdjustment) – Priority adjustment operator and value.
space (VolumeSpaceCommon) – Displays size and space consumption information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'connection_count': 'connection_count', 'created': 'created', 'destroyed': 'destroyed', 'host_encryption_key_status': 'host_encryption_key_status', 'id': 'id', 'name': 'name', 'priority_adjustment': 'priority_adjustment', 'provisioned': 'provisioned', 'qos': 'qos', 'serial': 'serial', 'space': 'space', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'connection_count': 'int', 'created': 'int', 'destroyed': 'bool', 'host_encryption_key_status': 'str', 'id': 'str', 'name': 'str', 'priority_adjustment': 'PriorityAdjustment', 'provisioned': 'int', 'qos': 'Qos', 'serial': 'str', 'space': 'VolumeSpaceCommon', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_diff module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_diff.VolumeDiff(context=None, offset=None, length=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, offset=None, length=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
offset (int) – Absolute offset of the chunk that is different, in bytes.
length (int) – Length of the chunk that is different, in bytes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'length': 'length', 'offset': 'offset'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'length': 'int', 'offset': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_get_response.VolumeGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[Volume]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list is empty.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[Volume]) – The aggregate value of all items after filtering. If applicable, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Volume]', 'more_items_remaining': 'bool', 'total': 'list[Volume]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_group module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_group.VolumeGroup(name=None, id=None, context=None, workload=None, time_remaining=None, destroyed=None, pod=None, qos=None, volume_count=None, priority_adjustment=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, workload=None, time_remaining=None, destroyed=None, pod=None, qos=None, volume_count=None, priority_adjustment=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
workload (WorkloadConfigurationFixedReferenceWorkload) –
time_remaining (int) – The amount of time left until the destroyed volume group is permanently eradicated, measured in milliseconds.
destroyed (bool) – Returns a value of true if the volume group has been destroyed and is pending eradication. Before the time_remaining period has elapsed, the destroyed volume group can be recovered by setting destroyed=false. After the time_remaining period has elapsed, the volume group is permanently eradicated and cannot be recovered.
pod (Reference) – A reference to the pod.
qos (Qos) –
volume_count (int) – The number of volumes in the volume group.
priority_adjustment (PriorityAdjustment) –
space (Space) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'pod': 'pod', 'priority_adjustment': 'priority_adjustment', 'qos': 'qos', 'space': 'space', 'time_remaining': 'time_remaining', 'volume_count': 'volume_count', 'workload': 'workload'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'pod': 'Reference', 'priority_adjustment': 'PriorityAdjustment', 'qos': 'Qos', 'space': 'Space', 'time_remaining': 'int', 'volume_count': 'int', 'workload': 'WorkloadConfigurationFixedReferenceWorkload'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_group_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_group_get_response.VolumeGroupGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[VolumeGroup]) –
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[VolumeGroup]) – The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[VolumeGroup]', 'more_items_remaining': 'bool', 'total': 'list[VolumeGroup]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_group_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_group_patch.VolumeGroupPatch(name=None, id=None, destroyed=None, qos=None, priority_adjustment=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, destroyed=None, qos=None, priority_adjustment=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
destroyed (bool) – Returns a value of true if the volume group has been destroyed and is pending eradication. Before the time_remaining period has elapsed, the destroyed volume group can be recovered by setting destroyed=false. After the time_remaining period has elapsed, the volume group is permanently eradicated and cannot be recovered.
qos (Qos) –
priority_adjustment (PriorityAdjustment) –
space (Space) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'priority_adjustment': 'priority_adjustment', 'qos': 'qos', 'space': 'space'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'id': 'str', 'name': 'str', 'priority_adjustment': 'PriorityAdjustment', 'qos': 'Qos', 'space': 'Space'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_group_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_group_performance.VolumeGroupPerformance(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'id': 'id', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'id': 'str', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_group_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_group_post.VolumeGroupPost(name=None, id=None, time_remaining=None, destroyed=None, qos=None, volume_count=None, priority_adjustment=None, space=None, tags=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, time_remaining=None, destroyed=None, qos=None, volume_count=None, priority_adjustment=None, space=None, tags=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
time_remaining (int) – The amount of time left until the destroyed volume group is permanently eradicated, measured in milliseconds.
destroyed (bool) – If set to true, destroys a volume group. If set to false, recovers a destroyed volume group. If not specified, defaults to false.
qos (Qos) –
volume_count (int) – The number of volumes in the volume group.
priority_adjustment (PriorityAdjustment) –
space (Space) –
tags (list[Tag]) – The list of tags to be upserted with the object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'priority_adjustment': 'priority_adjustment', 'qos': 'qos', 'space': 'space', 'tags': 'tags', 'time_remaining': 'time_remaining', 'volume_count': 'volume_count'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'id': 'str', 'name': 'str', 'priority_adjustment': 'PriorityAdjustment', 'qos': 'Qos', 'space': 'Space', 'tags': 'list[Tag]', 'time_remaining': 'int', 'volume_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_group_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_group_response.VolumeGroupResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[VolumeGroup]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[VolumeGroup]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_patch.VolumePatch(destroyed=None, name=None, protocol_endpoint=None, pod=None, provisioned=None, qos=None, requested_promotion_state=None, workload=None, volume_group=None, priority_adjustment=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None, name=None, protocol_endpoint=None, pod=None, provisioned=None, qos=None, requested_promotion_state=None, workload=None, volume_group=None, priority_adjustment=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
name (str) – The new name for the resource.
protocol_endpoint (ProtocolEndpoint) – Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to subtype=protocol_endpoint.
pod (Reference) – Moves the volume into the specified pod.
provisioned (int) – Updates the virtual size of the volume, measured in bytes.
qos (Qos) – Sets QoS limits.
requested_promotion_state (str) – Valid values are promoted and demoted. Patch requested_promotion_state to demoted to demote the volume so that the volume stops accepting write requests. Patch requested_promotion_state to promoted to promote the volume so that the volume starts accepting write requests.
workload (ReferenceWithFixedType) – Set the id or name of the workload to an empty string to remove the volume from the workload.
volume_group (Reference) – Adds the volume to the specified volume group.
priority_adjustment (PriorityAdjustment) – Adjusts volume priority.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'name': 'name', 'pod': 'pod', 'priority_adjustment': 'priority_adjustment', 'protocol_endpoint': 'protocol_endpoint', 'provisioned': 'provisioned', 'qos': 'qos', 'requested_promotion_state': 'requested_promotion_state', 'volume_group': 'volume_group', 'workload': 'workload'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'name': 'str', 'pod': 'Reference', 'priority_adjustment': 'PriorityAdjustment', 'protocol_endpoint': 'ProtocolEndpoint', 'provisioned': 'int', 'qos': 'Qos', 'requested_promotion_state': 'str', 'volume_group': 'Reference', 'workload': 'ReferenceWithFixedType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_performance module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_performance.VolumePerformance(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(san_usec_per_read_op=None, bytes_per_mirrored_write=None, mirrored_writes_per_sec=None, qos_rate_limit_usec_per_mirrored_write_op=None, bytes_per_op=None, service_usec_per_read_op_cache_reduction=None, bytes_per_read=None, usec_per_read_op=None, qos_rate_limit_usec_per_read_op=None, queue_usec_per_write_op=None, service_usec_per_mirrored_write_op=None, reads_per_sec=None, bytes_per_write=None, qos_rate_limit_usec_per_write_op=None, usec_per_mirrored_write_op=None, writes_per_sec=None, san_usec_per_write_op=None, usec_per_write_op=None, san_usec_per_mirrored_write_op=None, read_bytes_per_sec=None, mirrored_write_bytes_per_sec=None, write_bytes_per_sec=None, service_usec_per_write_op=None, queue_usec_per_mirrored_write_op=None, service_usec_per_read_op=None, queue_usec_per_read_op=None, time=None, name=None, id=None)
- Keyword Arguments
san_usec_per_read_op (int) – The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.
bytes_per_mirrored_write (int) – The average I/O size per mirrored write, measured in bytes.
mirrored_writes_per_sec (int) – The number of mirrored writes per second.
qos_rate_limit_usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds.
bytes_per_op (int) – The average I/O size for both read and write (all) operations.
service_usec_per_read_op_cache_reduction (float) – The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25% lower than it would have been without any data cache hits.
bytes_per_read (int) – The average I/O size per read, measured in bytes.
usec_per_read_op (int) – The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
qos_rate_limit_usec_per_read_op (int) – The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.
queue_usec_per_write_op (int) – The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_mirrored_write_op (int) – The average time required for the array to service a mirrored write request, measured in microseconds.
reads_per_sec (int) – The number of read requests processed per second.
bytes_per_write (int) – The average I/O size per write, measured in bytes.
qos_rate_limit_usec_per_write_op (int) – The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.
usec_per_mirrored_write_op (int) – The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
writes_per_sec (int) – The number of write requests processed per second.
san_usec_per_write_op (int) – The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.
usec_per_write_op (int) – The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.
san_usec_per_mirrored_write_op (int) – The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.
read_bytes_per_sec (int) – The number of bytes read per second.
mirrored_write_bytes_per_sec (int) – The number of mirrored bytes written per second.
write_bytes_per_sec (int) – The number of bytes written per second.
service_usec_per_write_op (int) – The average time required for the array to service a write request, measured in microseconds.
queue_usec_per_mirrored_write_op (int) – The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.
service_usec_per_read_op (int) – The average time required for the array to service a read request, measured in microseconds.
queue_usec_per_read_op (int) – The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.
time (int) – The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_per_mirrored_write': 'bytes_per_mirrored_write', 'bytes_per_op': 'bytes_per_op', 'bytes_per_read': 'bytes_per_read', 'bytes_per_write': 'bytes_per_write', 'id': 'id', 'mirrored_write_bytes_per_sec': 'mirrored_write_bytes_per_sec', 'mirrored_writes_per_sec': 'mirrored_writes_per_sec', 'name': 'name', 'qos_rate_limit_usec_per_mirrored_write_op': 'qos_rate_limit_usec_per_mirrored_write_op', 'qos_rate_limit_usec_per_read_op': 'qos_rate_limit_usec_per_read_op', 'qos_rate_limit_usec_per_write_op': 'qos_rate_limit_usec_per_write_op', 'queue_usec_per_mirrored_write_op': 'queue_usec_per_mirrored_write_op', 'queue_usec_per_read_op': 'queue_usec_per_read_op', 'queue_usec_per_write_op': 'queue_usec_per_write_op', 'read_bytes_per_sec': 'read_bytes_per_sec', 'reads_per_sec': 'reads_per_sec', 'san_usec_per_mirrored_write_op': 'san_usec_per_mirrored_write_op', 'san_usec_per_read_op': 'san_usec_per_read_op', 'san_usec_per_write_op': 'san_usec_per_write_op', 'service_usec_per_mirrored_write_op': 'service_usec_per_mirrored_write_op', 'service_usec_per_read_op': 'service_usec_per_read_op', 'service_usec_per_read_op_cache_reduction': 'service_usec_per_read_op_cache_reduction', 'service_usec_per_write_op': 'service_usec_per_write_op', 'time': 'time', 'usec_per_mirrored_write_op': 'usec_per_mirrored_write_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_write_op': 'usec_per_write_op', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- keys()
- required_args = {}
- swagger_types = {'bytes_per_mirrored_write': 'int', 'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', 'id': 'str', 'mirrored_write_bytes_per_sec': 'int', 'mirrored_writes_per_sec': 'int', 'name': 'str', 'qos_rate_limit_usec_per_mirrored_write_op': 'int', 'qos_rate_limit_usec_per_read_op': 'int', 'qos_rate_limit_usec_per_write_op': 'int', 'queue_usec_per_mirrored_write_op': 'int', 'queue_usec_per_read_op': 'int', 'queue_usec_per_write_op': 'int', 'read_bytes_per_sec': 'int', 'reads_per_sec': 'int', 'san_usec_per_mirrored_write_op': 'int', 'san_usec_per_read_op': 'int', 'san_usec_per_write_op': 'int', 'service_usec_per_mirrored_write_op': 'int', 'service_usec_per_read_op': 'int', 'service_usec_per_read_op_cache_reduction': 'float', 'service_usec_per_write_op': 'int', 'time': 'int', 'usec_per_mirrored_write_op': 'int', 'usec_per_read_op': 'int', 'usec_per_write_op': 'int', 'write_bytes_per_sec': 'int', 'writes_per_sec': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_post.VolumePost(destroyed=None, protocol_endpoint=None, provisioned=None, qos=None, subtype=None, source=None, priority_adjustment=None, tags=None, workload=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None, protocol_endpoint=None, provisioned=None, qos=None, subtype=None, source=None, priority_adjustment=None, tags=None, workload=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
protocol_endpoint (ProtocolEndpoint) – Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to subtype=protocol_endpoint.
provisioned (int) – Sets the virtual size of the volume, measured in bytes.
qos (Qos) – Sets QoS limits.
subtype (str) – The type of volume. Valid values are protocol_endpoint and regular.
source (Reference) – The source volume of a volume copy.
priority_adjustment (PriorityAdjustment) – Adjusts volume priority.
tags (list[Tag]) – The list of tags to be upserted with the object.
workload (WorkloadConfigurationReference) – The workload to which the volume is added. Set one of id or name, and configuration to add the volume to the workload and configure it based on the configuration from the preset the workload was originally provisioned from.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'priority_adjustment': 'priority_adjustment', 'protocol_endpoint': 'protocol_endpoint', 'provisioned': 'provisioned', 'qos': 'qos', 'source': 'source', 'subtype': 'subtype', 'tags': 'tags', 'workload': 'workload'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'priority_adjustment': 'PriorityAdjustment', 'protocol_endpoint': 'ProtocolEndpoint', 'provisioned': 'int', 'qos': 'Qos', 'source': 'Reference', 'subtype': 'str', 'tags': 'list[Tag]', 'workload': 'WorkloadConfigurationReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_post_base module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_post_base.VolumePostBase(destroyed=None, protocol_endpoint=None, provisioned=None, qos=None, subtype=None, source=None, priority_adjustment=None, tags=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None, protocol_endpoint=None, provisioned=None, qos=None, subtype=None, source=None, priority_adjustment=None, tags=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
protocol_endpoint (ProtocolEndpoint) – Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to subtype=protocol_endpoint.
provisioned (int) – Sets the virtual size of the volume, measured in bytes.
qos (Qos) – Sets QoS limits.
subtype (str) – The type of volume. Valid values are protocol_endpoint and regular.
source (Reference) – The source volume of a volume copy.
priority_adjustment (PriorityAdjustment) – Adjusts volume priority.
tags (list[Tag]) – The list of tags to be upserted with the object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'priority_adjustment': 'priority_adjustment', 'protocol_endpoint': 'protocol_endpoint', 'provisioned': 'provisioned', 'qos': 'qos', 'source': 'source', 'subtype': 'subtype', 'tags': 'tags'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'priority_adjustment': 'PriorityAdjustment', 'protocol_endpoint': 'ProtocolEndpoint', 'provisioned': 'int', 'qos': 'Qos', 'source': 'Reference', 'subtype': 'str', 'tags': 'list[Tag]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_response.VolumeResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Volume]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list is empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Volume]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_snapshot module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_snapshot.VolumeSnapshot(name=None, id=None, time_remaining=None, destroyed=None, pod=None, provisioned=None, created=None, source=None, suffix=None, context=None, serial=None, volume_group=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, time_remaining=None, destroyed=None, pod=None, provisioned=None, created=None, source=None, suffix=None, context=None, serial=None, volume_group=None, space=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
time_remaining (int) – The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered.
pod (FixedReference) – A reference to the pod.
provisioned (int) – The provisioned space of the snapshot. Measured in bytes. The minimum size is 1048576 (1MB), the maximum size is 4503599627370496 (4PB)
created (int) – The snapshot creation time. Measured in milliseconds since the UNIX epoch.
source (FixedReference) – The volume from which this snapshot was taken. For a replicated snapshot being viewed on the target side, the source is the replica volume.
suffix (str) – The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
serial (str) – A serial number generated by the system when the snapshot is created. The serial number is unique across all arrays.
volume_group (FixedReference) – The volume group to which the volume that is the source of the volume snapshot belongs.
space (SnapshotSpace) – Displays size and space consumption information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'pod': 'pod', 'provisioned': 'provisioned', 'serial': 'serial', 'source': 'source', 'space': 'space', 'suffix': 'suffix', 'time_remaining': 'time_remaining', 'volume_group': 'volume_group'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'pod': 'FixedReference', 'provisioned': 'int', 'serial': 'str', 'source': 'FixedReference', 'space': 'SnapshotSpace', 'suffix': 'str', 'time_remaining': 'int', 'volume_group': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_snapshot_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_snapshot_get_response.VolumeSnapshotGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[VolumeSnapshot]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[VolumeSnapshot]) – The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[VolumeSnapshot]', 'more_items_remaining': 'bool', 'total': 'list[VolumeSnapshot]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_snapshot_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_snapshot_patch.VolumeSnapshotPatch(destroyed=None, name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None, name=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
name (str) – The new name for the resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_snapshot_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_snapshot_post.VolumeSnapshotPost(destroyed=None, suffix=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None, suffix=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
suffix (str) – The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'suffix': 'suffix'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'suffix': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_snapshot_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_snapshot_response.VolumeSnapshotResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[VolumeSnapshot]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[VolumeSnapshot]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_snapshot_transfer module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_snapshot_transfer.VolumeSnapshotTransfer(name=None, id=None, physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None, context=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, physical_bytes_written=None, data_transferred=None, destroyed=None, progress=None, started=None, completed=None, context=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
physical_bytes_written (int) – The amount of physical/logical data written to the target due to replication. Measured in bytes.
data_transferred (int) – The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.
destroyed (bool) – Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.
progress (float) – The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.
started (int) – The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.
completed (int) – The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'completed': 'completed', 'context': 'context', 'data_transferred': 'data_transferred', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'physical_bytes_written': 'physical_bytes_written', 'progress': 'progress', 'started': 'started'}
- keys()
- required_args = {}
- swagger_types = {'completed': 'int', 'context': 'FixedReference', 'data_transferred': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'physical_bytes_written': 'int', 'progress': 'float', 'started': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_snapshot_transfer_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_snapshot_transfer_get_response.VolumeSnapshotTransferGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None, total=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[VolumeSnapshotTransfer]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[VolumeSnapshotTransfer]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[VolumeSnapshotTransfer]', 'more_items_remaining': 'bool', 'total': 'list[VolumeSnapshotTransfer]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_snapshot_transfer_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_snapshot_transfer_response.VolumeSnapshotTransferResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[VolumeSnapshotTransfer]) – Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[VolumeSnapshotTransfer]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_space module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_space.VolumeSpace(name=None, id=None, context=None, time=None, space=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time=None, space=None)
- Keyword Arguments
name (str) – A locally unique, system-generated name. The name cannot be modified.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time (int) – The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.
space (VolumeSpaceCommon) – Displays size and space consumption information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'id': 'id', 'name': 'name', 'space': 'space', 'time': 'time'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'id': 'str', 'name': 'str', 'space': 'VolumeSpaceCommon', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_space_common module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_space_common.VolumeSpaceCommon(data_reduction=None, shared=None, virtual=None, used_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None, snapshots=None, total_physical=None, footprint=None, system=None, unique=None, total_provisioned=None, snapshots_effective=None, unique_effective=None, total_effective=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(data_reduction=None, shared=None, virtual=None, used_provisioned=None, total_reduction=None, total_used=None, thin_provisioning=None, snapshots=None, total_physical=None, footprint=None, system=None, unique=None, total_provisioned=None, snapshots_effective=None, unique_effective=None, total_effective=None)
- Keyword Arguments
data_reduction (float) – The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.
shared (int) – The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.
virtual (int) – The amount of logically written data that a volume or a snapshot references. Measured in bytes.
used_provisioned (int) – The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container.
total_reduction (float) – The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.
total_used (int) – The total space contributed by customer data, measured in bytes.
thin_provisioning (float) – The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.
snapshots (int) – The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.
total_physical (int) – This field has been deprecated. Use the total_used field, as it contains the same information.
footprint (int) – The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.
system (int) – The physical space occupied by internal array metadata. Measured in bytes.
unique (int) – The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.
total_provisioned (int) – The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.
snapshots_effective (int) – This field has been deprecated. The effective space contributed by data unique to one or more snapshots, measured in bytes. Use the snapshots field in the future, as it contains the same information for Evergreen//One arrays.
unique_effective (int) – This field has been deprecated. The effective space contributed by unique customer data. Unique data does not include shared space, snapshots, and internal array metadata, measured in bytes. Use the unique field in the future, as it contains the same information for Evergreen//One arrays.
total_effective (int) – This field has been deprecated. The total effective space contributed by customer data, measured in bytes. Use the total_physical field in the future, as it contains the same information for Evergreen//One arrays.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'data_reduction': 'data_reduction', 'footprint': 'footprint', 'shared': 'shared', 'snapshots': 'snapshots', 'snapshots_effective': 'snapshots_effective', 'system': 'system', 'thin_provisioning': 'thin_provisioning', 'total_effective': 'total_effective', 'total_physical': 'total_physical', 'total_provisioned': 'total_provisioned', 'total_reduction': 'total_reduction', 'total_used': 'total_used', 'unique': 'unique', 'unique_effective': 'unique_effective', 'used_provisioned': 'used_provisioned', 'virtual': 'virtual'}
- keys()
- required_args = {}
- swagger_types = {'data_reduction': 'float', 'footprint': 'int', 'shared': 'int', 'snapshots': 'int', 'snapshots_effective': 'int', 'system': 'int', 'thin_provisioning': 'float', 'total_effective': 'int', 'total_physical': 'int', 'total_provisioned': 'int', 'total_reduction': 'float', 'total_used': 'int', 'unique': 'int', 'unique_effective': 'int', 'used_provisioned': 'int', 'virtual': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volume_space_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volume_space_get_response.VolumeSpaceGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, errors=None, total=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[VolumeSpace]) – The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field.
items (list[VolumeSpace]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total': 'total', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[VolumeSpace]', 'more_items_remaining': 'bool', 'total': 'list[VolumeSpace]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volumes_batch_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volumes_batch_response.VolumesBatchResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Volume]) – Displays a list of all items. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Volume]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volumes_diff_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volumes_diff_get_response.VolumesDiffGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[VolumeDiff]) – A list of different chunks between specified volumes.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[VolumeDiff]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.volumes_diff_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.volumes_diff_response.VolumesDiffResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[VolumeDiff]) – A list of different chunks between specified volumes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[VolumeDiff]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload.Workload(name=None, id=None, context=None, time_remaining=None, destroyed=None, created=None, preset=None, status_details=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, context=None, time_remaining=None, destroyed=None, created=None, preset=None, status_details=None, status=None)
- Keyword Arguments
name (str) – A user-specified name. The name must be locally unique and can be changed.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
time_remaining (int) – The amount of time left until the destroyed workload is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed workload can be recovered by setting destroyed=false.
destroyed (bool) – Returns a value of true if the workload has been destroyed and is pending eradication. The time_remaining displays the amount of time left until the destroyed workload is permanently eradicated. Before the time_remaining period has elapsed, the destroyed workload can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the workload is permanently eradicated and can no longer be recovered.
created (int) – The workload creation time, measured in milliseconds since the UNIX epoch.
preset (WorkloadPreset) – A reference to the preset the workload was deployed from. If the preset has since been destroyed, name will be null.
status_details (list[str]) – Additional information about the workload status. For example, if the workload status is creating, status details might describe what resources are currently being created.
status (str) – The status of the workload. Supported values are creating, ready, destroying, destroyed, eradicating and recovering.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'preset': 'preset', 'status': 'status', 'status_details': 'status_details', 'time_remaining': 'time_remaining'}
- keys()
- required_args = {}
- swagger_types = {'context': 'FixedReference', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'preset': 'WorkloadPreset', 'status': 'str', 'status_details': 'list[str]', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_configuration_fixed_reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_configuration_fixed_reference.WorkloadConfigurationFixedReference(workload=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(workload=None)
- Keyword Arguments
workload (WorkloadConfigurationFixedReferenceWorkload) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'workload': 'workload'}
- keys()
- required_args = {}
- swagger_types = {'workload': 'WorkloadConfigurationFixedReferenceWorkload'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_configuration_fixed_reference_workload module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_configuration_fixed_reference_workload.WorkloadConfigurationFixedReferenceWorkload(name=None, id=None, resource_type=None, configuration=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, resource_type=None, configuration=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
resource_type (str) – Type of the object (full name of the endpoint). Valid values include hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, policies/snapshot, and policies/quota, etc.
configuration (str) – The name of the preset configuration object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'configuration': 'configuration', 'id': 'id', 'name': 'name', 'resource_type': 'resource_type'}
- keys()
- required_args = {}
- swagger_types = {'configuration': 'str', 'id': 'str', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_configuration_reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_configuration_reference.WorkloadConfigurationReference(name=None, resource_type=None, id=None, configuration=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, resource_type=None, id=None, configuration=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
resource_type (str) – Type of the object (full name of the endpoint). Valid values are hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
configuration (str) – The name of the preset configuration object.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'configuration': 'configuration', 'id': 'id', 'name': 'name', 'resource_type': 'resource_type'}
- keys()
- required_args = {}
- swagger_types = {'configuration': 'str', 'id': 'str', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_get_response.WorkloadGetResponse(continuation_token=None, more_items_remaining=None, items=None, errors=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, items=None, errors=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query parameter to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination, then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Displays a value of true if subsequent items can be retrieved.
items (list[Workload]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
errors (list[ErrorcontextresponseErrors]) – The list of errors encountered when attempting to perform an operation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'errors': 'errors', 'items': 'items', 'more_items_remaining': 'more_items_remaining'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorcontextresponseErrors]', 'items': 'list[Workload]', 'more_items_remaining': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_parameter module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_parameter.WorkloadParameter(name=None, value=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, value=None)
- Keyword Arguments
name (str) – The name of the parameter.
value (WorkloadParameterValue) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'value': 'value'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str', 'value': 'WorkloadParameterValue'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_parameter_value module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_parameter_value.WorkloadParameterValue(boolean=None, string=None, integer=None, resource_reference=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(boolean=None, string=None, integer=None, resource_reference=None)
- Keyword Arguments
boolean (bool) – The value for a boolean parameter.
string (str) – The value for a string parameter.
integer (int) – The value for an integer parameter.
resource_reference (WorkloadParameterValueResourceReference) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'boolean': 'boolean', 'integer': 'integer', 'resource_reference': 'resource_reference', 'string': 'string'}
- keys()
- required_args = {}
- swagger_types = {'boolean': 'bool', 'integer': 'int', 'resource_reference': 'WorkloadParameterValueResourceReference', 'string': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_parameter_value_resource_reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_parameter_value_resource_reference.WorkloadParameterValueResourceReference(name=None, resource_type=None, id=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, resource_type=None, id=None)
- Keyword Arguments
name (str) – The name of the resource to reference. One of id or name must be set, but they cannot be set together.
resource_type (str) – The type of the resource to reference. Resource type is optional, and will be automatically determined by the server if not set.
id (str) – The id of the resource to reference. One of id or name must be set, but they cannot be set together.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'resource_type': 'resource_type'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_patch module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_patch.WorkloadPatch(destroyed=None, name=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(destroyed=None, name=None)
- Keyword Arguments
destroyed (bool) – If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.
name (str) – The new name for the resource.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'name': 'name'}
- keys()
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation.WorkloadPlacementRecommendation(context=None, expires=None, more_results_available=None, created=None, preset=None, projection_months=None, additional_constraints=None, name=None, progress=None, id=None, parameters=None, placement_names=None, results=None, results_limit=None, status=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(context=None, expires=None, more_results_available=None, created=None, preset=None, projection_months=None, additional_constraints=None, name=None, progress=None, id=None, parameters=None, placement_names=None, results=None, results_limit=None, status=None)
- Keyword Arguments
context (FixedReference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.
expires (int) – The time when recommendation expires, measured in milliseconds since the UNIX epoch.
more_results_available (bool) –
created (int) – The time the recommendation was made, measured in milliseconds since the UNIX epoch.
preset (FixedReference) –
projection_months (int) – The number of months to compute the projections. If not specified, defaults to 1 month.
additional_constraints (WorkloadPlacementRecommendationAdditionalConstraints) –
name (str) – A globally unique, system-generated name. The name cannot be modified and cannot refer to another resource.
progress (float) – The percentage progress of the recommendation computation. The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00.
id (str) – A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.
parameters (list[WorkloadParameter]) – The parameter values to pass to the preset. Value must be supplied for all parameters that do not have a default defined in the preset.
placement_names (list[str]) –
results (list[WorkloadPlacementRecommendationResult]) – The results of the recommendation.
results_limit (int) – The maximum number of results to return. If not specified, defaults to 10 results.
status (str) – The status of the recommendation. Possible values are processing, completed, and failed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'additional_constraints': 'additional_constraints', 'context': 'context', 'created': 'created', 'expires': 'expires', 'id': 'id', 'more_results_available': 'more_results_available', 'name': 'name', 'parameters': 'parameters', 'placement_names': 'placement_names', 'preset': 'preset', 'progress': 'progress', 'projection_months': 'projection_months', 'results': 'results', 'results_limit': 'results_limit', 'status': 'status'}
- keys()
- required_args = {}
- swagger_types = {'additional_constraints': 'WorkloadPlacementRecommendationAdditionalConstraints', 'context': 'FixedReference', 'created': 'int', 'expires': 'int', 'id': 'str', 'more_results_available': 'bool', 'name': 'str', 'parameters': 'list[WorkloadParameter]', 'placement_names': 'list[str]', 'preset': 'FixedReference', 'progress': 'float', 'projection_months': 'int', 'results': 'list[WorkloadPlacementRecommendationResult]', 'results_limit': 'int', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_additional_constraints module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_additional_constraints.WorkloadPlacementRecommendationAdditionalConstraints(required_resource_references=None, targets=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(required_resource_references=None, targets=None)
- Keyword Arguments
required_resource_references (list[WorkloadPlacementRecommendationResourceReference]) – Defines a group of resources. At least one resource from each item should be present on this target for the target to be considered an acceptable candidate for workload placement
targets (list[ReferenceWithType]) – If specified, only consider these targets when computing placement recommendations. If not specified, the whole fleet is used to compute the recommendation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'required_resource_references': 'required_resource_references', 'targets': 'targets'}
- keys()
- required_args = {}
- swagger_types = {'required_resource_references': 'list[WorkloadPlacementRecommendationResourceReference]', 'targets': 'list[ReferenceWithType]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_get_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_get_response.WorkloadPlacementRecommendationGetResponse(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(continuation_token=None, more_items_remaining=None, total_item_count=None, items=None)
- Keyword Arguments
continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).
more_items_remaining (bool) – Returns a value of true if subsequent items can be retrieved.
total_item_count (int) – The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.
items (list[WorkloadPlacementRecommendation]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'more_items_remaining': 'more_items_remaining', 'total_item_count': 'total_item_count'}
- keys()
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[WorkloadPlacementRecommendation]', 'more_items_remaining': 'bool', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_placement module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_placement.WorkloadPlacementRecommendationPlacement(name=None, targets=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, targets=None)
- Keyword Arguments
name (str) – The name of the placement.
targets (list[WorkloadPlacementRecommendationTarget]) – The targets for the placement.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'targets': 'targets'}
- keys()
- required_args = {}
- swagger_types = {'name': 'str', 'targets': 'list[WorkloadPlacementRecommendationTarget]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_projection module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_projection.WorkloadPlacementRecommendationProjection(start=None, end=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(start=None, end=None)
- Keyword Arguments
start (float) – The projection for the start of the projection period (i.e., immediately after the creation of the workload on this target). The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00.
end (float) – The projection for the end of the projection period. Length of the projection period is defined by ‘projection_months’. The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'end': 'end', 'start': 'start'}
- keys()
- required_args = {}
- swagger_types = {'end': 'float', 'start': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_resource_reference module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_resource_reference.WorkloadPlacementRecommendationResourceReference(allowed_values)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(allowed_values)
- Keyword Arguments
allowed_values (list[ReferenceWithType], required) – A list of allowed values for the resource reference. For hosts and host groups, each item does not define a specific object on some target, but defines a pattern which should be matched by the target. For example, { type: host, name: host1 } will match all targets that have a host with name host1.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed_values': 'allowed_values'}
- keys()
- required_args = {'allowed_values'}
- swagger_types = {'allowed_values': 'list[ReferenceWithType]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_response.WorkloadPlacementRecommendationResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[WorkloadPlacementRecommendation]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[WorkloadPlacementRecommendation]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_result module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_result.WorkloadPlacementRecommendationResult(score=None, placements=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(score=None, placements=None)
- Keyword Arguments
score (str) – The score of the recommendation from Pure1. Possible values include optimal, optimal-with-warnings, and acceptable.
placements (list[WorkloadPlacementRecommendationPlacement]) – The placements of the preset.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'placements': 'placements', 'score': 'score'}
- keys()
- required_args = {}
- swagger_types = {'placements': 'list[WorkloadPlacementRecommendationPlacement]', 'score': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_target module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_target.WorkloadPlacementRecommendationTarget(name=None, id=None, resource_type=None, warnings=None, model=None, load_projections=None, capacity=None, capacity_used_projections=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, resource_type=None, warnings=None, model=None, load_projections=None, capacity=None, capacity_used_projections=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
resource_type (str) – Type of the object (full name of the endpoint). Valid values are hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.
warnings (list[WorkloadPlacementRecommendationWarning]) – The warnings for the target.
model (str) – The model of the target. For example, FA-X20R2.
load_projections (WorkloadPlacementRecommendationTargetLoadProjections) –
capacity (int) – The usable capacity of the target, measured in bytes.
capacity_used_projections (WorkloadPlacementRecommendationTargetCapacityUsedProjections) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'capacity': 'capacity', 'capacity_used_projections': 'capacity_used_projections', 'id': 'id', 'load_projections': 'load_projections', 'model': 'model', 'name': 'name', 'resource_type': 'resource_type', 'warnings': 'warnings'}
- keys()
- required_args = {}
- swagger_types = {'capacity': 'int', 'capacity_used_projections': 'WorkloadPlacementRecommendationTargetCapacityUsedProjections', 'id': 'str', 'load_projections': 'WorkloadPlacementRecommendationTargetLoadProjections', 'model': 'str', 'name': 'str', 'resource_type': 'str', 'warnings': 'list[WorkloadPlacementRecommendationWarning]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_target_capacity_used_projections module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_target_capacity_used_projections.WorkloadPlacementRecommendationTargetCapacityUsedProjections(days_until_full=None, projection=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(days_until_full=None, projection=None)
- Keyword Arguments
days_until_full (int) – The number of days until the target is at full capacity.
projection (WorkloadPlacementRecommendationProjection) – The projection of the used capacity, assuming the workload is provisioned on this target.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'days_until_full': 'days_until_full', 'projection': 'projection'}
- keys()
- required_args = {}
- swagger_types = {'days_until_full': 'int', 'projection': 'WorkloadPlacementRecommendationProjection'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_target_load_projections module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_target_load_projections.WorkloadPlacementRecommendationTargetLoadProjections(projection_blended_max=None, projection_avg=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(projection_blended_max=None, projection_avg=None)
- Keyword Arguments
projection_blended_max (WorkloadPlacementRecommendationProjection) – The projected blended maximum load on the target.
projection_avg (WorkloadPlacementRecommendationProjection) – The projected average load on the target.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'projection_avg': 'projection_avg', 'projection_blended_max': 'projection_blended_max'}
- keys()
- required_args = {}
- swagger_types = {'projection_avg': 'WorkloadPlacementRecommendationProjection', 'projection_blended_max': 'WorkloadPlacementRecommendationProjection'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_warning module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_placement_recommendation_warning.WorkloadPlacementRecommendationWarning(code=None, message=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(code=None, message=None)
- Keyword Arguments
code (str) – The warning code. Possible values include limit_volumes_count, limit_pods_count, etc.
message (str) – The warning message. Possible values include Adding the workload on the array would exceed the limit on volumes, Adding the workload on the array would exceed the limit on pods, etc.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'code': 'code', 'message': 'message'}
- keys()
- required_args = {}
- swagger_types = {'code': 'str', 'message': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_post module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_post.WorkloadPost(parameters=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(parameters=None)
- Keyword Arguments
parameters (list[WorkloadParameter]) – The parameter values to pass to the preset when creating the workload. Value must be supplied for all parameters that do not have a default defined in the preset.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'parameters': 'parameters'}
- keys()
- required_args = {}
- swagger_types = {'parameters': 'list[WorkloadParameter]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_preset module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_preset.WorkloadPreset(name=None, id=None, resource_type=None, revision=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(name=None, id=None, resource_type=None, revision=None)
- Keyword Arguments
name (str) – The resource name, such as volume name, pod name, snapshot name, and so on.
id (str) – A globally unique, system-generated ID. The ID cannot be modified.
resource_type (str) – Type of the object (full name of the endpoint). Valid values include hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, policies/snapshot, and policies/quota, etc.
revision (int) – The revision of the preset from which the workload was deployed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'resource_type': 'resource_type', 'revision': 'revision'}
- keys()
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'resource_type': 'str', 'revision': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flasharray.FA_2_40.models.workload_response module
FlashArray REST API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: 2.40
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flasharray.FA_2_40.models.workload_response.WorkloadResponse(items=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(items=None)
- Keyword Arguments
items (list[Workload]) – Displays a list of all items after filtering. If applicable, the values are displayed for each name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- keys()
- required_args = {}
- swagger_types = {'items': 'list[Workload]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
Module contents
- class pypureclient.flasharray.FA_2_40.models.ReferenceType
Bases:
objectClass just for type annotations.
It’s used for reference arg on api function. This allows user to pass collections of Model objects to the method without transforming them to ids or names.
Should be Protocol type when the typing module will get support of it.
- pypureclient.flasharray.FA_2_40.models.quoteString(s)
Quote string according to https://wiki.purestorage.com/display/UXReviewers/Filtering
>>> quote("a") "'a'" >>> quote("a\\b") "'a\\\\b'" >>> quote("a\\b") "'a\\\\b'" >>> quote("a'b") "'a\\'b'" >>> quote(None) None
- pypureclient.flasharray.FA_2_40.models.quoteStrings(s)