pypureclient.flashblade.FB_2_17.models package
Submodules
pypureclient.flashblade.FB_2_17.models.active_directory module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.active_directory.ActiveDirectory(name=None, id=None, global_catalog_servers=None, kerberos_servers=None, computer_name=None, server=None, join_ou=None, directory_servers=None, domain=None, service_principal_names=None, encryption_types=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, global_catalog_servers=None, kerberos_servers=None, computer_name=None, server=None, join_ou=None, directory_servers=None, domain=None, service_principal_names=None, encryption_types=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
global_catalog_servers (list[str]) – A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol.
kerberos_servers (list[str]) – A list of key distribution servers to use for Kerberos protocol. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS.
computer_name (str) – The common 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.
server (FixedReference) – The server containing this active directory account.
join_ou (str) – The relative distinguished name of the organizational unit in which the computer account was created when joining the domain.
directory_servers (list[str]) – A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol.
domain (str) – The Active Directory domain to join.
service_principal_names (list[str]) – A list of service principal names registered for the machine account, which can be used for the creation of keys for Kerberos authentication.
encryption_types (list[str]) – The encryption types that are supported for use by clients for Kerberos authentication.
- __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', 'encryption_types': 'encryption_types', 'global_catalog_servers': 'global_catalog_servers', 'id': 'id', 'join_ou': 'join_ou', 'kerberos_servers': 'kerberos_servers', 'name': 'name', 'server': 'server', 'service_principal_names': 'service_principal_names'}
- required_args = {}
- swagger_types = {'computer_name': 'str', 'directory_servers': 'list[str]', 'domain': 'str', 'encryption_types': 'list[str]', 'global_catalog_servers': 'list[str]', 'id': 'str', 'join_ou': 'str', 'kerberos_servers': 'list[str]', 'name': 'str', 'server': 'FixedReference', 'service_principal_names': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.active_directory_directory_servers module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.active_directory_directory_servers.ActiveDirectoryDirectoryServers(global_catalog_servers=None, directory_servers=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(global_catalog_servers=None, directory_servers=None)
- Keyword Arguments
global_catalog_servers (list[str]) – A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50.
directory_servers (list[str]) – A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'directory_servers': 'directory_servers', 'global_catalog_servers': 'global_catalog_servers'}
- required_args = {}
- swagger_types = {'directory_servers': 'list[str]', 'global_catalog_servers': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.active_directory_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.active_directory_get_response.ActiveDirectoryGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ActiveDirectory]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.active_directory_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.active_directory_patch.ActiveDirectoryPatch(global_catalog_servers=None, directory_servers=None, kerberos_servers=None, join_ou=None, service_principal_names=None, encryption_types=None, fqdns=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(global_catalog_servers=None, directory_servers=None, kerberos_servers=None, join_ou=None, service_principal_names=None, encryption_types=None, fqdns=None)
- Keyword Arguments
global_catalog_servers (list[str]) – A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50.
directory_servers (list[str]) – A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5.
kerberos_servers (list[str]) – A list of key distribution servers to use for Kerberos protocol. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5.
join_ou (str) – The relative distinguished name of the organizational unit in which the computer account should be created when joining the domain.
service_principal_names (list[str]) – A list of service principal names to register for the machine account, which can be used for the creation of keys for Kerberos authentication. If neither service_principal_names nor fqdns is specified, the default service_principal_names are constructed using the computer_name and domain fields. Cannot be provided in combination with fqdns.
encryption_types (list[str]) – The encryption types that will be supported for use by clients for Kerberos authentication. Valid values include aes256-cts-hmac-sha1-96, aes128-cts-hmac-sha1-96, and arcfour-hmac.
fqdns (list[str]) – A list of fully qualified domain names to use to register service principal names for the machine account. If specified, every service principal that is supported by the array will be registered for each fully qualified domain name specified. If neither fqdns nor service_principal_names is specified, the default service_principal_names are constructed using the computer_name and domain fields. Cannot be provided in combination with service_principal_names.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'directory_servers': 'directory_servers', 'encryption_types': 'encryption_types', 'fqdns': 'fqdns', 'global_catalog_servers': 'global_catalog_servers', 'join_ou': 'join_ou', 'kerberos_servers': 'kerberos_servers', 'service_principal_names': 'service_principal_names'}
- required_args = {}
- swagger_types = {'directory_servers': 'list[str]', 'encryption_types': 'list[str]', 'fqdns': 'list[str]', 'global_catalog_servers': 'list[str]', 'join_ou': 'str', 'kerberos_servers': 'list[str]', 'service_principal_names': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.active_directory_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.active_directory_post.ActiveDirectoryPost(password, domain, user, global_catalog_servers=None, directory_servers=None, kerberos_servers=None, computer_name=None, join_ou=None, service_principal_names=None, encryption_types=None, fqdns=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(password, domain, user, global_catalog_servers=None, directory_servers=None, kerberos_servers=None, computer_name=None, join_ou=None, service_principal_names=None, encryption_types=None, fqdns=None)
- Keyword Arguments
global_catalog_servers (list[str]) – A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50.
directory_servers (list[str]) – A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5.
kerberos_servers (list[str]) – A list of key distribution servers to use for Kerberos protocol. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5.
computer_name (str) – The common 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 relative distinguished name of the organizational unit in which the computer account should be created when joining the domain. Cannot be provided if using an existing machine account. If not specified, defaults to CN=Computers.
password (str, required) – The login password of the user with privileges to create the computer account in the domain. If using an existing computer account, the user must have privileges to read attributes from the computer account and reset the password on that account. This is not persisted on the array.
domain (str, required) – The Active Directory domain to join.
service_principal_names (list[str]) – A list of service principal names to register for the machine account, which can be used for the creation of keys for Kerberos authentication. If neither service_principal_names nor fqdns is specified, the default service_principal_names are constructed using the computer_name and domain fields. Cannot be provided in combination with fqdns. Cannot be provided if using an existing machine account.
encryption_types (list[str]) – The encryption types that will be supported for use by clients for Kerberos authentication. Defaults to aes256-cts-hmac-sha1-96. Valid values include aes256-cts-hmac-sha1-96, aes128-cts-hmac-sha1-96, and arcfour-hmac. Cannot be provided if using an existing machine account.
fqdns (list[str]) – A list of fully qualified domain names to use to register service principal names for the machine account. If specified, every service principal that is supported by the array will be registered for each fully qualified domain name specified. If neither fqdns nor service_principal_names is specified, the default service_principal_names are constructed using the computer_name and domain fields. Cannot be provided in combination with service_principal_names. Cannot be provided if using an existing machine account.
user (str, required) – The login name of the user with privileges to create the computer account in the domain. If using an existing computer account, the user must have privileges to read attributes from the computer account and reset the password on that account. 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', 'encryption_types': 'encryption_types', 'fqdns': 'fqdns', 'global_catalog_servers': 'global_catalog_servers', 'join_ou': 'join_ou', 'kerberos_servers': 'kerberos_servers', 'password': 'password', 'service_principal_names': 'service_principal_names', 'user': 'user'}
- required_args = {'domain', 'password', 'user'}
- swagger_types = {'computer_name': 'str', 'directory_servers': 'list[str]', 'domain': 'str', 'encryption_types': 'list[str]', 'fqdns': 'list[str]', 'global_catalog_servers': 'list[str]', 'join_ou': 'str', 'kerberos_servers': 'list[str]', 'password': 'str', 'service_principal_names': 'list[str]', 'user': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.active_directory_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.admin module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin.Admin(name=None, id=None, public_key=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, id=None, public_key=None, role=None, api_token=None, lockout_remaining=None, is_local=None, locked=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
public_key (str) – Public key for SSH access. Supported key types are Ed25519 and RSA.
role (Reference) – A reference to this administrator’s management role.
api_token (ApiToken) –
lockout_remaining (int) – The remaining lockout period, in milliseconds, if the user is locked out. 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, otherwise false.
locked (bool) – Returns a value of true if the user is currently locked out, otherwise false. Can be patched 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', 'id': 'id', 'is_local': 'is_local', 'locked': 'locked', 'lockout_remaining': 'lockout_remaining', 'name': 'name', 'public_key': 'public_key', 'role': 'role'}
- required_args = {}
- swagger_types = {'api_token': 'ApiToken', 'id': 'str', 'is_local': 'bool', 'locked': 'bool', 'lockout_remaining': 'int', 'name': 'str', 'public_key': 'str', 'role': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_api_token module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin_api_token.AdminApiToken(api_token=None, admin=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(api_token=None, admin=None)
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'admin': 'admin', 'api_token': 'api_token'}
- required_args = {}
- swagger_types = {'admin': 'Reference', 'api_token': 'ApiToken'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_api_token_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin_api_token_get_response.AdminApiTokenGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[AdminApiToken]) – A list of administrator API tokens.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[AdminApiToken]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_api_token_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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]) – A list of administrator API tokens.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- 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.flashblade.FB_2_17.models.admin_cache module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin_cache.AdminCache(name=None, id=None, role=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, role=None, time=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
role (FixedReference) – A reference to the role of this user.
time (int) – Time the role was cached in milliseconds since UNIX epoch.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'role': 'role', 'time': 'time'}
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'role': 'FixedReference', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_cache_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin_cache_get_response.AdminCacheGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[AdminCache]) – A list of admin cache entries.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[AdminCache]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin_get_response.AdminGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Admin]) – A list of administrative account objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Admin]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin_patch.AdminPatch(public_key=None, old_password=None, password=None, role=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__(public_key=None, old_password=None, password=None, role=None, locked=None)
- Keyword Arguments
public_key (str) – Public key for SSH access. Supported key types are Ed25519 and RSA.
old_password (str) – Old user password.
password (str) – New user password.
role (ReferenceWritable) – A reference to this administrator’s management role. This may only be modified for non-built-in users for whom is_local is true.
locked (bool) – If set to false, the specified user is unlocked. Setting to true is not allowed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'locked': 'locked', 'old_password': 'old_password', 'password': 'password', 'public_key': 'public_key', 'role': 'role'}
- required_args = {}
- swagger_types = {'locked': 'bool', 'old_password': 'str', 'password': 'str', 'public_key': 'str', 'role': 'ReferenceWritable'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin_post.AdminPost(public_key=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__(public_key=None, password=None, role=None)
- Keyword Arguments
public_key (str) – Public key for SSH access. Supported key types include Ed25519 and RSA.
password (str) – New user password.
role (ReferenceWritable) – A reference to this administrator’s management role.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'password': 'password', 'public_key': 'public_key', 'role': 'role'}
- required_args = {}
- swagger_types = {'password': 'str', 'public_key': 'str', 'role': 'ReferenceWritable'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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
- __init__(items=None)
- Keyword Arguments
items (list[Admin]) – A list of administrative account objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- 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.flashblade.FB_2_17.models.admin_setting module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin_setting.AdminSetting(lockout_duration=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__(lockout_duration=None, min_password_length=None, max_login_attempts=None)
- Keyword Arguments
lockout_duration (int) – The lockout duration, in milliseconds, if a user has reached the maximum number of login attempts. Ranges from 1 second to 90 days. Default value is null. Use 0 to reset the value to null.
min_password_length (int) – The minimum password length. If not specified, defaults to 1 character.
max_login_attempts (int) – The maximum number of failed login attempts allowed before the user is locked out. Default value is null. 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 = {'lockout_duration': 'lockout_duration', 'max_login_attempts': 'max_login_attempts', 'min_password_length': 'min_password_length'}
- required_args = {}
- swagger_types = {'lockout_duration': 'int', 'max_login_attempts': 'int', 'min_password_length': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_settings_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.admin_settings_get_response.AdminSettingsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[AdminSetting]) – Returns global admin settings.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[AdminSetting]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.admin_settings_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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[AdminSetting]) – Returns global admin settings.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[AdminSetting]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.alert module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.alert.Alert(name=None, id=None, severity=None, summary=None, variables=None, code=None, knowledge_base_url=None, created=None, notified=None, component_name=None, description=None, index=None, component_type=None, flagged=None, action=None, state=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, severity=None, summary=None, variables=None, code=None, knowledge_base_url=None, created=None, notified=None, component_name=None, description=None, index=None, component_type=None, flagged=None, action=None, state=None, updated=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
severity (str) – Severity of the alert. Valid values are info, warning, and critical.
summary (str) – The summary of the alert.
variables (dict(str, str)) – Key-value pairs of additional information of the alert.
code (int) – Alert code.
knowledge_base_url (str) – URL of the relevant Knowledge Base page.
created (int) – The creation timestamp of the alert.
notified (int) – The last notification timestamp of the alert.
component_name (str) – The component name of the alert.
description (str) – The description of the alert.
index (int) – The unique index of the alert.
component_type (str) – The component type of the alert.
flagged (bool) – Flagged state of the alert.
action (str) – The action of the alert.
state (str) – The current state of the alert. Valid values are open, closing, closed, and waiting to downgrade.
updated (int) – The last updated timestamp of the alert.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'action': 'action', 'code': 'code', 'component_name': 'component_name', 'component_type': 'component_type', 'created': 'created', 'description': 'description', 'flagged': 'flagged', 'id': 'id', 'index': 'index', 'knowledge_base_url': 'knowledge_base_url', 'name': 'name', 'notified': 'notified', 'severity': 'severity', 'state': 'state', 'summary': 'summary', 'updated': 'updated', 'variables': 'variables'}
- required_args = {}
- swagger_types = {'action': 'str', 'code': 'int', 'component_name': 'str', 'component_type': 'str', 'created': 'int', 'description': 'str', 'flagged': 'bool', 'id': 'str', 'index': 'int', 'knowledge_base_url': 'str', 'name': 'str', 'notified': 'int', 'severity': 'str', 'state': 'str', 'summary': 'str', 'updated': 'int', 'variables': 'dict(str, str)'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.alert_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.alert_get_response.AlertGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Alert]) – A list of alert objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Alert]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.alert_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.alert_watcher module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.alert_watcher.AlertWatcher(name=None, id=None, minimum_notification_severity=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, minimum_notification_severity=None, enabled=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
minimum_notification_severity (str) – The minimum severity that an alert must have in order for emails to be sent to the watcher. Possible values include info, warning, and critical.
enabled (bool) – Is email notification enabled? 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', 'id': 'id', 'minimum_notification_severity': 'minimum_notification_severity', 'name': 'name'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'id': 'str', 'minimum_notification_severity': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.alert_watcher_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.alert_watcher_get_response.AlertWatcherGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[AlertWatcher]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.alert_watcher_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.alert_watcher_post.AlertWatcherPost(minimum_notification_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__(minimum_notification_severity=None)
- Keyword Arguments
minimum_notification_severity (str) – The minimum severity that an alert must have in order for emails to be sent to the watcher. Possible values include info, warning, and critical. If not specified, defaults to info.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'minimum_notification_severity': 'minimum_notification_severity'}
- required_args = {}
- swagger_types = {'minimum_notification_severity': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.alert_watcher_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.api_client module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.api_client.ApiClient(name=None, id=None, public_key=None, max_role=None, key_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__(name=None, id=None, public_key=None, max_role=None, key_id=None, enabled=None, issuer=None, access_token_ttl_in_ms=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
public_key (str) – The API client’s PEM formatted (Base64 encoded) RSA public key.
max_role (FixedReference) – The maximum 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 max_role and the role of the array user specified as the JWT sub (subject) claim. The max_role field is a reference to a role. Valid role`s are `readonly, ops_admin, array_admin, and storage_admin. Users with the readonly (Read Only) role can perform operations that convey the state of the array. Read Only users cannot alter the state of the array. Users with the ops_admin (Ops Admin) role can perform the same operations as Read Only users plus enable and disable remote assistance sessions. Ops Admin users cannot alter the state of the array. Users with the storage_admin (Storage Admin) role can perform the same operations as Read Only users plus storage related operations, such as administering file systems, snapshots, and buckets. Storage Admin users cannot perform operations that deal with global and system configurations. Users with the array_admin (Array Admin) role can perform the same operations as Storage Admin users plus array-wide changes dealing with global and system configurations. In other words, Array Admin users can perform all operations.
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.
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 TTL (Time To Live) duration for which the exchanged access token is valid. Measured in milliseconds.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'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'}
- required_args = {}
- swagger_types = {'access_token_ttl_in_ms': 'int', 'enabled': 'bool', 'id': 'str', 'issuer': 'str', 'key_id': 'str', 'max_role': 'FixedReference', 'name': 'str', 'public_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.api_clients_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.api_clients_post.ApiClientsPost(public_key, max_role, 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, max_role, issuer=None, access_token_ttl_in_ms=None)
- Keyword Arguments
public_key (str, required) – The API client’s PEM formatted (Base64 encoded) RSA public key. It must include the —–BEGIN PUBLIC KEY—– and —–END PUBLIC KEY—– lines.
max_role (ReferenceWritable, required) – The maximum 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 max_role and the role of the array user specified as the JWT sub (subject) claim. The max_role field is a reference to a role. Valid role`s are `readonly, ops_admin, array_admin, and storage_admin. Users with the readonly (Read Only) role can perform operations that convey the state of the array. Read Only users cannot alter the state of the array. Users with the ops_admin (Ops Admin) role can perform the same operations as Read Only users plus enable and disable remote assistance sessions. Ops Admin users cannot alter the state of the array. Users with the storage_admin (Storage Admin) role can perform the same operations as Read Only users plus storage related operations, such as administering volumes, hosts, and host groups. Storage Admin users cannot perform operations that deal with global and system configurations. Users with the array_admin (Array Admin) role can perform the same operations as Storage Admin users plus array-wide changes dealing with global and system configurations. In other words, Array Admin users can perform all operations.
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) duration for which the exchanged access token is valid. 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_token_ttl_in_ms': 'access_token_ttl_in_ms', 'issuer': 'issuer', 'max_role': 'max_role', 'public_key': 'public_key'}
- required_args = {'max_role', 'public_key'}
- swagger_types = {'access_token_ttl_in_ms': 'int', 'issuer': 'str', 'max_role': 'ReferenceWritable', 'public_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.api_clients_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.api_clients_response.ApiClientsResponse(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'}
- 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.flashblade.FB_2_17.models.api_token module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.api_version module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.api_version.ApiVersion(versions=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(versions=None)
- Keyword Arguments
versions (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 = {'versions': 'versions'}
- required_args = {}
- swagger_types = {'versions': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array.Array(name=None, id=None, network_access_policy=None, os=None, banner=None, eradication_config=None, ntp_servers=None, as_of=None, time_zone=None, default_inbound_tls_policy=None, security_update=None, smb_mode=None, version=None, revision=None, product_type=None, encryption=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, network_access_policy=None, os=None, banner=None, eradication_config=None, ntp_servers=None, as_of=None, time_zone=None, default_inbound_tls_policy=None, security_update=None, smb_mode=None, version=None, revision=None, product_type=None, encryption=None, idle_timeout=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
network_access_policy (FixedReference) – The network access policy governing which clients are allowed or denied access to different array interfaces.
os (str) – Valid values are Purity//FA and Purity//FB.
banner (str) – A string to be shown when logging in to the array.
eradication_config (ArrayEradicationConfig) –
ntp_servers (list[str]) –
as_of (int) – Array time in milliseconds since UNIX epoch.
time_zone (str) – The time zone to use for the array. In particular this affects the CLI formatting and the default snapshot policy time zone.
default_inbound_tls_policy (ReferenceWritable) – The default TLS policy governing inbound traffic from clients accessing the array. This TLS policy will be applied for any IP addresses on the system that do not have a specific policy applied to them at a more granular level.
security_update (str) – The name of the installed security update that currently applies to the system. This field will be null if either no security update has been installed, or if the most recently installed security update is no longer needed by the current FlashBlade software due to the current software fully incorporating the update.
smb_mode (str) – The current SMB mode of the array. This controls the type of authentication that is used by the array for SMB. Possible values include ad-auto, ad-rfc2307, guest, and native. Modifying this value requires the assistance of Pure Storage Support.
version (str) –
revision (str) –
product_type (str) – For FlashBlade//S arrays, the value is determined by the blades in the system. The value will be FlashBlade for all older arrays. Valid values are FlashBlade, FlashBlade//S, FlashBlade//S200, and FlashBladeS500.
encryption (ArrayEncryption) –
idle_timeout (int) – Idle timeout in milliseconds. Valid values are in the range of 300000 and 10800000. Setting this value to 0 disables timeouts.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'as_of': '_as_of', 'banner': 'banner', 'default_inbound_tls_policy': 'default_inbound_tls_policy', 'encryption': 'encryption', 'eradication_config': 'eradication_config', 'id': 'id', 'idle_timeout': 'idle_timeout', 'name': 'name', 'network_access_policy': 'network_access_policy', 'ntp_servers': 'ntp_servers', 'os': 'os', 'product_type': 'product_type', 'revision': 'revision', 'security_update': 'security_update', 'smb_mode': 'smb_mode', 'time_zone': 'time_zone', 'version': 'version'}
- required_args = {}
- swagger_types = {'as_of': 'int', 'banner': 'str', 'default_inbound_tls_policy': 'ReferenceWritable', 'encryption': 'ArrayEncryption', 'eradication_config': 'ArrayEradicationConfig', 'id': 'str', 'idle_timeout': 'int', 'name': 'str', 'network_access_policy': 'FixedReference', 'ntp_servers': 'list[str]', 'os': 'str', 'product_type': 'str', 'revision': 'str', 'security_update': 'str', 'smb_mode': 'str', 'time_zone': 'str', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_connection module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_connection.ArrayConnection(id=None, context=None, replication_addresses=None, throttle=None, encrypted=None, os=None, management_address=None, ca_certificate_group=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__(id=None, context=None, replication_addresses=None, throttle=None, encrypted=None, os=None, management_address=None, ca_certificate_group=None, remote=None, type=None, version=None, status=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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 and/or FQDNs of the target arrays. Settable on POST only. If not set on POST, will be set to all the replication addresses available on the target array at the time of the POST.
throttle (Throttle) –
encrypted (bool) – If this is set to true, then all customer data replicated over the connection will be sent over an encrypted connection using TLS, or will not be sent if a secure connection cannot be established. If this is set to false, then all customer data replicated over the connection will be sent over an unencrypted connection. Defaults to false.
os (str) – The operating system of the connected array.
management_address (str) – Management address of the target array. Settable on POST only.
ca_certificate_group (FixedReference) – The group of CA certificates that can be used, in addition to well-known Certificate Authority certificates, in order to establish a secure connection to the target array. Defaults to a reference to the _default_replication_certs group if secure_connection is true, or null otherwise.
remote (FixedReference) – The remote array.
type (str) – The type of connection. Valid values include async-replication and fleet-management.
version (str) – The version of the target array.
status (str) – Status of the connection. Valid values include connected, partially_connected, connecting, and incompatible. connected - The connection is OK. partially_connected - Some replication addresses are working, but others are not. connecting - No connection exists and the array is trying to reconnect. incompatible - The target array is not compatible.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ca_certificate_group': 'ca_certificate_group', 'context': 'context', 'encrypted': 'encrypted', 'id': 'id', 'management_address': 'management_address', 'os': 'os', 'remote': 'remote', 'replication_addresses': 'replication_addresses', 'status': 'status', 'throttle': 'throttle', 'type': 'type', 'version': 'version'}
- required_args = {}
- swagger_types = {'ca_certificate_group': 'FixedReference', 'context': 'Reference', 'encrypted': 'bool', 'id': 'str', 'management_address': 'str', 'os': 'str', 'remote': 'FixedReference', 'replication_addresses': 'list[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.flashblade.FB_2_17.models.array_connection_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_connection_get_response.ArrayConnectionGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ArrayConnection]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_connection_key module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_connection_key.ArrayConnectionKey(expires=None, connection_key=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__(expires=None, connection_key=None, created=None)
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'connection_key': 'connection_key', 'created': 'created', 'expires': 'expires'}
- required_args = {}
- swagger_types = {'connection_key': 'str', 'created': 'int', 'expires': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_connection_key_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_connection_key_get_response.ArrayConnectionKeyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ArrayConnectionKey]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_connection_key_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_connection_key_response.ArrayConnectionKeyResponse(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[ArrayConnectionKey]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ArrayConnectionKey]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_connection_path module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_connection_path.ArrayConnectionPath(id=None, context=None, destination=None, source=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__(id=None, context=None, destination=None, source=None, remote=None, type=None, status_details=None, status=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
destination (str) – IP address with the port of the target array.
source (str) – IP address of the source array.
remote (FixedReference) – The remote array.
type (str) – The type of path. Valid values include async-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 and connecting. connected - The connection is OK. connecting - No connection exists and the array is trying to reconnect.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'destination': 'destination', 'id': 'id', 'remote': 'remote', 'source': 'source', 'status': 'status', 'status_details': 'status_details', 'type': 'type'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'destination': 'str', 'id': 'str', 'remote': 'FixedReference', 'source': '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.flashblade.FB_2_17.models.array_connection_path_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_connection_path_get_response.ArrayConnectionPathGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ArrayConnectionPath]) –
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ArrayConnectionPath]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_connection_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_connection_post.ArrayConnectionPost(id=None, context=None, replication_addresses=None, throttle=None, encrypted=None, os=None, management_address=None, ca_certificate_group=None, remote=None, type=None, version=None, status=None, 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__(id=None, context=None, replication_addresses=None, throttle=None, encrypted=None, os=None, management_address=None, ca_certificate_group=None, remote=None, type=None, version=None, status=None, connection_key=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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 and/or FQDNs of the target arrays. Settable on POST only. If not set on POST, will be set to all the replication addresses available on the target array at the time of the POST.
throttle (Throttle) –
encrypted (bool) – If this is set to true, then all customer data replicated over the connection will be sent over an encrypted connection using TLS, or will not be sent if a secure connection cannot be established. If this is set to false, then all customer data replicated over the connection will be sent over an unencrypted connection. Defaults to false.
os (str) – The operating system of the connected array.
management_address (str) – Management address of the target array. Settable on POST only.
ca_certificate_group (FixedReference) – The group of CA certificates that can be used, in addition to well-known Certificate Authority certificates, in order to establish a secure connection to the target array. Defaults to a reference to the _default_replication_certs group if secure_connection is true, or null otherwise.
remote (FixedReference) – The remote array.
type (str) – The type of connection. Valid values include async-replication and fleet-management.
version (str) – The version of the target array.
status (str) – Status of the connection. Valid values include connected, partially_connected, connecting, and incompatible. connected - The connection is OK. partially_connected - Some replication addresses are working, but others are not. connecting - No connection exists and the array is trying to reconnect. incompatible - The target array is not compatible.
connection_key (str) – The connection key of the target array. Settable on POST only.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'ca_certificate_group': 'ca_certificate_group', 'connection_key': 'connection_key', 'context': 'context', 'encrypted': 'encrypted', 'id': 'id', 'management_address': 'management_address', 'os': 'os', 'remote': 'remote', 'replication_addresses': 'replication_addresses', 'status': 'status', 'throttle': 'throttle', 'type': 'type', 'version': 'version'}
- required_args = {}
- swagger_types = {'ca_certificate_group': 'FixedReference', 'connection_key': 'str', 'context': 'Reference', 'encrypted': 'bool', 'id': 'str', 'management_address': 'str', 'os': 'str', 'remote': 'FixedReference', 'replication_addresses': 'list[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.flashblade.FB_2_17.models.array_connection_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.array_encryption module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_encryption.ArrayEncryption(data_at_rest=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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)
- Keyword Arguments
data_at_rest (ArrayEncryptionDataAtRest) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'data_at_rest': 'data_at_rest'}
- required_args = {}
- swagger_types = {'data_at_rest': 'ArrayEncryptionDataAtRest'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_encryption_data_at_rest module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_encryption_data_at_rest.ArrayEncryptionDataAtRest(algorithms=None, entropy_source=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__(algorithms=None, entropy_source=None, enabled=None)
- Keyword Arguments
algorithms (list[str]) – The algorithms used to encrypt data at rest on the array.
entropy_source (str) – The entropy source used to generate the Data at Rest Encryption key on the array.
enabled (bool) – Returns a value of true if Data at Rest Encryption is enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'algorithms': 'algorithms', 'enabled': 'enabled', 'entropy_source': 'entropy_source'}
- required_args = {}
- swagger_types = {'algorithms': 'list[str]', 'enabled': 'bool', 'entropy_source': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_eradication_config module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_eradication_config.ArrayEradicationConfig(eradication_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, manual_eradication=None)
- Keyword Arguments
eradication_delay (int) – The file eradication delay is in milliseconds. Automatically eradicate destroyed filesystems and snapshots after the delay time. Valid values are 86400000 and any multiple of 86400000 in the range of 86400000 and 2592000000. Any other values will be rounded down to the nearest multiple of 86400000.
manual_eradication (str) – Manual eradication status is applied on the array level. If status is all-disabled, you cannot eradicate buckets and file systems. If status is file-disabled then you can not eradicate files systems. If status is object-disabled then you can not eradicate buckets. If status is all-enabled then you can eradicate file systems and buckets. Values include all-enabled, file-disabled, object-disabled, and all-disabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'eradication_delay': 'eradication_delay', 'manual_eradication': 'manual_eradication'}
- required_args = {}
- swagger_types = {'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.flashblade.FB_2_17.models.array_factory_reset_token module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_factory_reset_token.ArrayFactoryResetToken(name=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, token=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
token (int) – A random 7-digit 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 = {'name': 'name', 'token': 'token'}
- required_args = {}
- swagger_types = {'name': 'str', 'token': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_factory_reset_token_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_factory_reset_token_get_response.ArrayFactoryResetTokenGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ArrayFactoryResetToken]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_factory_reset_token_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.array_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_get_response.ArrayGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Array]) – A list of array objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Array]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_http_specific_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_http_specific_performance.ArrayHttpSpecificPerformance(name=None, id=None, context=None, read_files_per_sec=None, others_per_sec=None, usec_per_write_file_op=None, usec_per_other_op=None, write_dirs_per_sec=None, usec_per_write_dir_op=None, time=None, usec_per_read_file_op=None, usec_per_read_dir_op=None, read_dirs_per_sec=None, write_files_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__(name=None, id=None, context=None, read_files_per_sec=None, others_per_sec=None, usec_per_write_file_op=None, usec_per_other_op=None, write_dirs_per_sec=None, usec_per_write_dir_op=None, time=None, usec_per_read_file_op=None, usec_per_read_dir_op=None, read_dirs_per_sec=None, write_files_per_sec=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
read_files_per_sec (float) – Read file requests processed per second.
others_per_sec (float) – Other operations processed per second.
usec_per_write_file_op (float) – Average time, measured in microseconds, it takes the array to process a write file request.
usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
write_dirs_per_sec (float) – Write directory requests processed per second.
usec_per_write_dir_op (float) – Average time, measured in microseconds, it takes the array to process a write directory request.
time (int) – Sample time in milliseconds since UNIX epoch.
usec_per_read_file_op (float) – Average time, measured in microseconds, it takes the array to process a read file request.
usec_per_read_dir_op (float) – Average time, measured in microseconds, it takes the array to process a read directory request.
read_dirs_per_sec (float) – Read directory requests processed per second.
write_files_per_sec (float) – Write file requests processed per second.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'id': 'id', 'name': 'name', 'others_per_sec': 'others_per_sec', 'read_dirs_per_sec': 'read_dirs_per_sec', 'read_files_per_sec': 'read_files_per_sec', 'time': 'time', 'usec_per_other_op': 'usec_per_other_op', 'usec_per_read_dir_op': 'usec_per_read_dir_op', 'usec_per_read_file_op': 'usec_per_read_file_op', 'usec_per_write_dir_op': 'usec_per_write_dir_op', 'usec_per_write_file_op': 'usec_per_write_file_op', 'write_dirs_per_sec': 'write_dirs_per_sec', 'write_files_per_sec': 'write_files_per_sec'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'id': 'str', 'name': 'str', 'others_per_sec': 'float', 'read_dirs_per_sec': 'float', 'read_files_per_sec': 'float', 'time': 'int', 'usec_per_other_op': 'float', 'usec_per_read_dir_op': 'float', 'usec_per_read_file_op': 'float', 'usec_per_write_dir_op': 'float', 'usec_per_write_file_op': 'float', 'write_dirs_per_sec': 'float', 'write_files_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_http_specific_performance_get module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_http_specific_performance_get.ArrayHttpSpecificPerformanceGet(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ArrayHttpSpecificPerformance]) – A list of http specific array performance metrics 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ArrayHttpSpecificPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_nfs_specific_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_nfs_specific_performance.ArrayNfsSpecificPerformance(name=None, id=None, context=None, aggregate_file_metadata_creates_per_sec=None, aggregate_usec_per_file_metadata_read_op=None, aggregate_file_metadata_modifies_per_sec=None, pathconfs_per_sec=None, usec_per_mkdir_op=None, setattrs_per_sec=None, reads_per_sec=None, usec_per_access_op=None, usec_per_lookup_op=None, usec_per_readlink_op=None, fsinfos_per_sec=None, usec_per_readdir_op=None, aggregate_other_per_sec=None, readlinks_per_sec=None, usec_per_remove_op=None, usec_per_readdirplus_op=None, usec_per_rename_op=None, usec_per_create_op=None, usec_per_pathconf_op=None, links_per_sec=None, usec_per_rmdir_op=None, fsstats_per_sec=None, usec_per_read_op=None, usec_per_fsinfo_op=None, usec_per_getattr_op=None, aggregate_file_metadata_reads_per_sec=None, usec_per_fsstat_op=None, usec_per_link_op=None, usec_per_setattr_op=None, aggregate_usec_per_file_metadata_modify_op=None, writes_per_sec=None, aggregate_share_metadata_reads_per_sec=None, symlinks_per_sec=None, usec_per_symlink_op=None, usec_per_write_op=None, aggregate_usec_per_other_op=None, readdirpluses_per_sec=None, removes_per_sec=None, aggregate_usec_per_file_metadata_create_op=None, renames_per_sec=None, creates_per_sec=None, accesses_per_sec=None, lookups_per_sec=None, getattrs_per_sec=None, readdirs_per_sec=None, mkdirs_per_sec=None, rmdirs_per_sec=None, time=None, aggregate_usec_per_share_metadata_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, context=None, aggregate_file_metadata_creates_per_sec=None, aggregate_usec_per_file_metadata_read_op=None, aggregate_file_metadata_modifies_per_sec=None, pathconfs_per_sec=None, usec_per_mkdir_op=None, setattrs_per_sec=None, reads_per_sec=None, usec_per_access_op=None, usec_per_lookup_op=None, usec_per_readlink_op=None, fsinfos_per_sec=None, usec_per_readdir_op=None, aggregate_other_per_sec=None, readlinks_per_sec=None, usec_per_remove_op=None, usec_per_readdirplus_op=None, usec_per_rename_op=None, usec_per_create_op=None, usec_per_pathconf_op=None, links_per_sec=None, usec_per_rmdir_op=None, fsstats_per_sec=None, usec_per_read_op=None, usec_per_fsinfo_op=None, usec_per_getattr_op=None, aggregate_file_metadata_reads_per_sec=None, usec_per_fsstat_op=None, usec_per_link_op=None, usec_per_setattr_op=None, aggregate_usec_per_file_metadata_modify_op=None, writes_per_sec=None, aggregate_share_metadata_reads_per_sec=None, symlinks_per_sec=None, usec_per_symlink_op=None, usec_per_write_op=None, aggregate_usec_per_other_op=None, readdirpluses_per_sec=None, removes_per_sec=None, aggregate_usec_per_file_metadata_create_op=None, renames_per_sec=None, creates_per_sec=None, accesses_per_sec=None, lookups_per_sec=None, getattrs_per_sec=None, readdirs_per_sec=None, mkdirs_per_sec=None, rmdirs_per_sec=None, time=None, aggregate_usec_per_share_metadata_read_op=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
aggregate_file_metadata_creates_per_sec (float) – Sum of file-level or directory-level create-like metadata requests per second. Includes CREATE, LINK, MKDIR, and SYMLINK.
aggregate_usec_per_file_metadata_read_op (float) – Average time, measured in microseconds, it takes the array to process a file-level or directory-level read-like metadata request. Includes GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and READLINK.
aggregate_file_metadata_modifies_per_sec (float) – Sum of file-level or directory-level modify-like and delete-like metadata requests per second. Includes REMOVE, RENAME, RMDIR, and SETATTR.
pathconfs_per_sec (float) – PATHCONF requests processed per second.
usec_per_mkdir_op (float) – Average time, measured in microseconds, it takes the array to process a MKDIR request.
setattrs_per_sec (float) – SETATTR requests processed per second.
reads_per_sec (float) – READ requests processed per second.
usec_per_access_op (float) – Average time, measured in microseconds, it takes the array to process an ACCESS request.
usec_per_lookup_op (float) – Average time, measured in microseconds, it takes the array to process a LOOKUP request.
usec_per_readlink_op (float) – Average time, measured in microseconds, it takes the array to process a READLINK request.
fsinfos_per_sec (float) – FSINFO requests processed per second.
usec_per_readdir_op (float) – Average time, measured in microseconds, it takes the array to process a READDIR request.
aggregate_other_per_sec (float) – Sum of all other requests processed per second. This includes COMMIT, MKNOD, NULL, NLM operations, and operations which are supported for NFSv4.1 but not NFSv3.
readlinks_per_sec (float) – READLINK requests processed per second.
usec_per_remove_op (float) – Average time, measured in microseconds, it takes the array to process a REMOVE request.
usec_per_readdirplus_op (float) – Average time, measured in microseconds, it takes the array to process a READDIRPLUS request.
usec_per_rename_op (float) – Average time, measured in microseconds, it takes the array to process a RENAME request.
usec_per_create_op (float) – Average time, measured in microseconds, it takes the array to process a CREATE request.
usec_per_pathconf_op (float) – Average time, measured in microseconds, it takes the array to process a PATHCONF request.
links_per_sec (float) – LINK requests processed per second.
usec_per_rmdir_op (float) – Average time, measured in microseconds, it takes the array to process an RMDIR request.
fsstats_per_sec (float) – FSSTAT requests processed per second.
usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a READ request.
usec_per_fsinfo_op (float) – Average time, measured in microseconds, it takes the array to process an FSINFO request.
usec_per_getattr_op (float) – Average time, measured in microseconds, it takes the array to process a GETATTR request.
aggregate_file_metadata_reads_per_sec (float) – Sum of file-level or directory-level read-like metadata requests per second. Includes GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and READLINK.
usec_per_fsstat_op (float) – Average time, measured in microseconds, it takes the array to process an FSSTAT request.
usec_per_link_op (float) – Average time, measured in microseconds, it takes the array to process a LINK request.
usec_per_setattr_op (float) – Average time, measured in microseconds, it takes the array to process a SETATTR request.
aggregate_usec_per_file_metadata_modify_op (float) – Average time, measured in microseconds, it takes the array to process a file-level or directory-level modify-like or delete-like metadata request. Includes REMOVE, RENAME, RMDIR, and SETATTR.
writes_per_sec (float) – WRITE requests processed per second.
aggregate_share_metadata_reads_per_sec (float) – Sum of share-level read-like metadata requests per second. Includes ACCESS, FSINFO, and FSSTAT.
symlinks_per_sec (float) – SYMLINK requests processed per second.
usec_per_symlink_op (float) – Average time, measured in microseconds, it takes the array to process a SYMLINK request.
usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a WRITE request.
aggregate_usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process all other requests. This includes COMMIT, MKNOD, NULL, NLM operations, and operations which are supported for NFSv4.1 but not NFSv3.
readdirpluses_per_sec (float) – READDIRPLUS requests processed per second.
removes_per_sec (float) – REMOVE requests processed per second.
aggregate_usec_per_file_metadata_create_op (float) – Average time, measured in microseconds, it takes the array to process a file-level or directory-level create-like metadata request. Includes CREATE, LINK, MKDIR, and SYMLINK.
renames_per_sec (float) – RENAME requests processed per second.
creates_per_sec (float) – CREATE requests processed per second.
accesses_per_sec (float) – ACCESS requests processed per second.
lookups_per_sec (float) – LOOKUP requests processed per second.
getattrs_per_sec (float) – GETATTR requests processed per second.
readdirs_per_sec (float) – READDIR requests processed per second.
mkdirs_per_sec (float) – MKDIR requests processed per second.
rmdirs_per_sec (float) – RMDIR requests processed per second.
time (int) – Sample time in milliseconds since UNIX epoch.
aggregate_usec_per_share_metadata_read_op (float) – Average time, measured in microseconds, it takes the array to process a share-level read-like metadata request. Includes ACCESS, FSINFO, and FSSTAT.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'accesses_per_sec': 'accesses_per_sec', 'aggregate_file_metadata_creates_per_sec': 'aggregate_file_metadata_creates_per_sec', 'aggregate_file_metadata_modifies_per_sec': 'aggregate_file_metadata_modifies_per_sec', 'aggregate_file_metadata_reads_per_sec': 'aggregate_file_metadata_reads_per_sec', 'aggregate_other_per_sec': 'aggregate_other_per_sec', 'aggregate_share_metadata_reads_per_sec': 'aggregate_share_metadata_reads_per_sec', 'aggregate_usec_per_file_metadata_create_op': 'aggregate_usec_per_file_metadata_create_op', 'aggregate_usec_per_file_metadata_modify_op': 'aggregate_usec_per_file_metadata_modify_op', 'aggregate_usec_per_file_metadata_read_op': 'aggregate_usec_per_file_metadata_read_op', 'aggregate_usec_per_other_op': 'aggregate_usec_per_other_op', 'aggregate_usec_per_share_metadata_read_op': 'aggregate_usec_per_share_metadata_read_op', 'context': 'context', 'creates_per_sec': 'creates_per_sec', 'fsinfos_per_sec': 'fsinfos_per_sec', 'fsstats_per_sec': 'fsstats_per_sec', 'getattrs_per_sec': 'getattrs_per_sec', 'id': 'id', 'links_per_sec': 'links_per_sec', 'lookups_per_sec': 'lookups_per_sec', 'mkdirs_per_sec': 'mkdirs_per_sec', 'name': 'name', 'pathconfs_per_sec': 'pathconfs_per_sec', 'readdirpluses_per_sec': 'readdirpluses_per_sec', 'readdirs_per_sec': 'readdirs_per_sec', 'readlinks_per_sec': 'readlinks_per_sec', 'reads_per_sec': 'reads_per_sec', 'removes_per_sec': 'removes_per_sec', 'renames_per_sec': 'renames_per_sec', 'rmdirs_per_sec': 'rmdirs_per_sec', 'setattrs_per_sec': 'setattrs_per_sec', 'symlinks_per_sec': 'symlinks_per_sec', 'time': 'time', 'usec_per_access_op': 'usec_per_access_op', 'usec_per_create_op': 'usec_per_create_op', 'usec_per_fsinfo_op': 'usec_per_fsinfo_op', 'usec_per_fsstat_op': 'usec_per_fsstat_op', 'usec_per_getattr_op': 'usec_per_getattr_op', 'usec_per_link_op': 'usec_per_link_op', 'usec_per_lookup_op': 'usec_per_lookup_op', 'usec_per_mkdir_op': 'usec_per_mkdir_op', 'usec_per_pathconf_op': 'usec_per_pathconf_op', 'usec_per_read_op': 'usec_per_read_op', 'usec_per_readdir_op': 'usec_per_readdir_op', 'usec_per_readdirplus_op': 'usec_per_readdirplus_op', 'usec_per_readlink_op': 'usec_per_readlink_op', 'usec_per_remove_op': 'usec_per_remove_op', 'usec_per_rename_op': 'usec_per_rename_op', 'usec_per_rmdir_op': 'usec_per_rmdir_op', 'usec_per_setattr_op': 'usec_per_setattr_op', 'usec_per_symlink_op': 'usec_per_symlink_op', 'usec_per_write_op': 'usec_per_write_op', 'writes_per_sec': 'writes_per_sec'}
- required_args = {}
- swagger_types = {'accesses_per_sec': 'float', 'aggregate_file_metadata_creates_per_sec': 'float', 'aggregate_file_metadata_modifies_per_sec': 'float', 'aggregate_file_metadata_reads_per_sec': 'float', 'aggregate_other_per_sec': 'float', 'aggregate_share_metadata_reads_per_sec': 'float', 'aggregate_usec_per_file_metadata_create_op': 'float', 'aggregate_usec_per_file_metadata_modify_op': 'float', 'aggregate_usec_per_file_metadata_read_op': 'float', 'aggregate_usec_per_other_op': 'float', 'aggregate_usec_per_share_metadata_read_op': 'float', 'context': 'Reference', 'creates_per_sec': 'float', 'fsinfos_per_sec': 'float', 'fsstats_per_sec': 'float', 'getattrs_per_sec': 'float', 'id': 'str', 'links_per_sec': 'float', 'lookups_per_sec': 'float', 'mkdirs_per_sec': 'float', 'name': 'str', 'pathconfs_per_sec': 'float', 'readdirpluses_per_sec': 'float', 'readdirs_per_sec': 'float', 'readlinks_per_sec': 'float', 'reads_per_sec': 'float', 'removes_per_sec': 'float', 'renames_per_sec': 'float', 'rmdirs_per_sec': 'float', 'setattrs_per_sec': 'float', 'symlinks_per_sec': 'float', 'time': 'int', 'usec_per_access_op': 'float', 'usec_per_create_op': 'float', 'usec_per_fsinfo_op': 'float', 'usec_per_fsstat_op': 'float', 'usec_per_getattr_op': 'float', 'usec_per_link_op': 'float', 'usec_per_lookup_op': 'float', 'usec_per_mkdir_op': 'float', 'usec_per_pathconf_op': 'float', 'usec_per_read_op': 'float', 'usec_per_readdir_op': 'float', 'usec_per_readdirplus_op': 'float', 'usec_per_readlink_op': 'float', 'usec_per_remove_op': 'float', 'usec_per_rename_op': 'float', 'usec_per_rmdir_op': 'float', 'usec_per_setattr_op': 'float', 'usec_per_symlink_op': 'float', 'usec_per_write_op': 'float', 'writes_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_nfs_specific_performance_get module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_nfs_specific_performance_get.ArrayNfsSpecificPerformanceGet(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ArrayNfsSpecificPerformance]) – A list of NFS specific array performance metrics 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ArrayNfsSpecificPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_performance.ArrayPerformance(name=None, id=None, context=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, context=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) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
read_bytes_per_sec (float) – Bytes read per second.
others_per_sec (float) – Other operations processed per second.
reads_per_sec (float) – Read requests processed per second.
write_bytes_per_sec (float) – Bytes written per second.
bytes_per_write (float) – Average write size in bytes per write operation.
usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
writes_per_sec (float) – Write requests processed per second.
time (int) – Sample time in milliseconds since UNIX epoch.
bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).
usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.
bytes_per_read (float) – Average read size in bytes per read operation.
usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
- __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', 'context': 'context', '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'}
- required_args = {}
- swagger_types = {'bytes_per_op': 'float', 'bytes_per_read': 'float', 'bytes_per_write': 'float', 'context': 'Reference', 'id': 'str', 'name': 'str', 'others_per_sec': 'float', 'read_bytes_per_sec': 'float', 'reads_per_sec': 'float', 'time': 'int', 'usec_per_other_op': 'float', 'usec_per_read_op': 'float', 'usec_per_write_op': 'float', 'write_bytes_per_sec': 'float', 'writes_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_performance_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_performance_get_response.ArrayPerformanceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ArrayPerformance]) – A list of array performance metrics 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ArrayPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_performance_replication_get_resp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_performance_replication_get_resp.ArrayPerformanceReplicationGetResp(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[RelationshipPerformanceReplication]) –
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[RelationshipPerformanceReplication]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- required_args = {}
- swagger_types = {'items': 'list[Array]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_s3_specific_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_s3_specific_performance.ArrayS3SpecificPerformance(name=None, id=None, context=None, read_objects_per_sec=None, usec_per_write_bucket_op=None, write_buckets_per_sec=None, others_per_sec=None, usec_per_other_op=None, read_buckets_per_sec=None, usec_per_write_object_op=None, time=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, write_objects_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__(name=None, id=None, context=None, read_objects_per_sec=None, usec_per_write_bucket_op=None, write_buckets_per_sec=None, others_per_sec=None, usec_per_other_op=None, read_buckets_per_sec=None, usec_per_write_object_op=None, time=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, write_objects_per_sec=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
read_objects_per_sec (float) – Read object requests processed per second.
usec_per_write_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a write bucket request.
write_buckets_per_sec (float) – Write buckets requests processed per second.
others_per_sec (float) – Other operations processed per second.
usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
read_buckets_per_sec (float) – Read buckets requests processed per second.
usec_per_write_object_op (float) – Average time, measured in microseconds, it takes the array to process a write object request.
time (int) – Sample time in milliseconds since UNIX epoch.
usec_per_read_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a read bucket request.
usec_per_read_object_op (float) – Average time, measured in microseconds, it takes the array to process a read object request.
write_objects_per_sec (float) – Write object requests processed per second.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'id': 'id', 'name': 'name', 'others_per_sec': 'others_per_sec', 'read_buckets_per_sec': 'read_buckets_per_sec', 'read_objects_per_sec': 'read_objects_per_sec', 'time': 'time', 'usec_per_other_op': 'usec_per_other_op', 'usec_per_read_bucket_op': 'usec_per_read_bucket_op', 'usec_per_read_object_op': 'usec_per_read_object_op', 'usec_per_write_bucket_op': 'usec_per_write_bucket_op', 'usec_per_write_object_op': 'usec_per_write_object_op', 'write_buckets_per_sec': 'write_buckets_per_sec', 'write_objects_per_sec': 'write_objects_per_sec'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'id': 'str', 'name': 'str', 'others_per_sec': 'float', 'read_buckets_per_sec': 'float', 'read_objects_per_sec': 'float', 'time': 'int', 'usec_per_other_op': 'float', 'usec_per_read_bucket_op': 'float', 'usec_per_read_object_op': 'float', 'usec_per_write_bucket_op': 'float', 'usec_per_write_object_op': 'float', 'write_buckets_per_sec': 'float', 'write_objects_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_s3_specific_performance_get_resp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_s3_specific_performance_get_resp.ArrayS3SpecificPerformanceGetResp(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ArrayS3SpecificPerformance]) – A list of S3 specific array performance metrics 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ArrayS3SpecificPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_space module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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) – Sample time in milliseconds since UNIX epoch.
space (Space) –
capacity (int) – 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'}
- required_args = {}
- swagger_types = {'capacity': 'int', 'context': 'Reference', '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.flashblade.FB_2_17.models.array_space_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_space_get_response.ArraySpaceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ArraySpace]) – A list of array space metrics 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ArraySpace]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.array_space_storage_class_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.array_space_storage_class_get_response.ArraySpaceStorageClassGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (StorageClassSpace) –
items (list[StorageClassSpace]) – A list of array space metrics objects for each storage class.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[StorageClassSpace]', 'total': 'StorageClassSpace', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.arrays_supported_time_zones_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.arrays_supported_time_zones_get_response.ArraysSupportedTimeZonesGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[TimeZone]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[TimeZone]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit.Audit(name=None, id=None, subcommand=None, origin=None, user_interface=None, arguments=None, ip_address=None, time=None, user=None, command=None, user_agent=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, subcommand=None, origin=None, user_interface=None, arguments=None, ip_address=None, time=None, user=None, command=None, user_agent=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
subcommand (str) –
origin (FixedReference) –
user_interface (str) – The user interface through which the user session event was performed. Valid values are CLI, GUI, and REST.
arguments (str) –
ip_address (str) –
time (int) –
user (str) –
command (str) –
user_agent (str) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'arguments': 'arguments', 'command': 'command', 'id': 'id', 'ip_address': 'ip_address', 'name': 'name', 'origin': 'origin', 'subcommand': 'subcommand', 'time': 'time', 'user': 'user', 'user_agent': 'user_agent', 'user_interface': 'user_interface'}
- required_args = {}
- swagger_types = {'arguments': 'str', 'command': 'str', 'id': 'str', 'ip_address': 'str', 'name': 'str', 'origin': 'FixedReference', 'subcommand': 'str', 'time': 'int', 'user': 'str', 'user_agent': 'str', 'user_interface': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_get_response.AuditFileSystemsPoliciesGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[AuditFileSystemsPolicy]) – A list of audit policy 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[AuditFileSystemsPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_members_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_members_get_response.AuditFileSystemsPoliciesMembersGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PolicyMemberContext]) – A list of members for audit policies.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[PolicyMemberContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_members_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_members_response.AuditFileSystemsPoliciesMembersResponse(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[PolicyMemberContext]) – A list of members for audit policies.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[PolicyMemberContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_patch.AuditFileSystemsPoliciesPatch(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None, remove_log_targets=None, add_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, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None, remove_log_targets=None, add_log_targets=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
log_targets (list[Reference]) – List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.
remove_log_targets (list[Reference]) – The log targets which will be removed from the existing log_targets list for the audit policy. The remove_log_targets field can not be used with log_targets field.
add_log_targets (list[Reference]) – The log targets which will be added to the existing log_targets list for the audit policy. These new log targets will be appended to the end of the existing list. The add_log_targets field can not be used with log_targets field.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'add_log_targets': 'add_log_targets', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'log_targets': 'log_targets', 'name': 'name', 'policy_type': 'policy_type', 'remove_log_targets': 'remove_log_targets'}
- required_args = {}
- swagger_types = {'add_log_targets': 'list[Reference]', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'log_targets': 'list[Reference]', 'name': 'str', 'policy_type': 'str', 'remove_log_targets': 'list[Reference]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_post.AuditFileSystemsPoliciesPost(name=None, id=None, policy_type=None, location=None, is_local=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, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
log_targets (list[Reference]) – List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'log_targets': 'log_targets', 'name': 'name', 'policy_type': 'policy_type'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'log_targets': 'list[Reference]', 'name': 'str', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit_file_systems_policies_response.AuditFileSystemsPoliciesResponse(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[AuditFileSystemsPolicy]) – A list of audit policy objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[AuditFileSystemsPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_file_systems_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit_file_systems_policy.AuditFileSystemsPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=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, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None, context=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
log_targets (list[Reference]) – List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.
context (Reference) – 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', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'log_targets': 'log_targets', 'name': 'name', 'policy_type': 'policy_type'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'log_targets': 'list[Reference]', 'name': 'str', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_file_systems_policy_no_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit_file_systems_policy_no_context.AuditFileSystemsPolicyNoContext(name=None, id=None, policy_type=None, location=None, is_local=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, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
log_targets (list[Reference]) – List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'log_targets': 'log_targets', 'name': 'name', 'policy_type': 'policy_type'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'log_targets': 'list[Reference]', 'name': 'str', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.audit_get_response.AuditGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Audit]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Audit]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.audit_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.blade module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.blade.Blade(name=None, id=None, raw_capacity=None, progress=None, details=None, status=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, raw_capacity=None, progress=None, details=None, status=None, target=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
raw_capacity (int) –
progress (float) –
details (str) –
status (str) – Valid values are critical, evacuated, evacuating, healthy, identifying, unhealthy, unknown, and unused.
target (str) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'id': 'id', 'name': 'name', 'progress': 'progress', 'raw_capacity': 'raw_capacity', 'status': 'status', 'target': 'target'}
- required_args = {}
- swagger_types = {'details': 'str', 'id': 'str', 'name': 'str', 'progress': 'float', 'raw_capacity': 'int', 'status': 'str', 'target': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.blade_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.blade_get_response.BladeGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (object) –
items (list[Blade]) – A list of blade objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Blade]', 'total': 'object', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket.Bucket(name=None, id=None, context=None, quota_limit=None, time_remaining_status=None, versioning=None, bucket_type=None, public_access_config=None, created=None, public_status=None, object_count=None, eradication_config=None, space=None, object_lock_config=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, retention_lock=None, account=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, time_remaining_status=None, versioning=None, bucket_type=None, public_access_config=None, created=None, public_status=None, object_count=None, eradication_config=None, space=None, object_lock_config=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, retention_lock=None, account=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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 effective quota limit applied against the size of the bucket, displayed in bytes. If unset, the bucket is unlimited in size.
time_remaining_status (str) – Status of the time_remaining field. calculating means the bucket is retention-based, has been destroyed and the time_remaining is being calculated by a background process legal-hold means the bucket is retention-based, has been destroyed and will never be eradicated, because an object with legal hold status was found inside. null otherwise, i.e. when either the bucket is not destroyed or it’s destroyed and the time_remaining has been determined.
versioning (str) – The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.
bucket_type (str) – The bucket type for the bucket.
public_access_config (PublicAccessConfig) –
created (int) – Creation timestamp of the object.
public_status (str) – Bucket’s public status. Valid values include bucket-and-objects-not-public, only-authorized-users-of-this-account and public.
object_count (int) – The count of objects within the bucket.
eradication_config (BucketEradicationConfig) –
space (Space) – The space specification of the bucket.
object_lock_config (ObjectLockConfigResponse) –
time_remaining (int) – Time in milliseconds before the bucket is eradicated. null if not destroyed or legal hold was found or the remaining time until eradication is not known yet.
destroyed (bool) – Is the bucket destroyed?
hard_limit_enabled (bool) – If set to true, the bucket’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the bucket, but soft quota alerts will still be sent if the bucket has a value set for quota_limit.
retention_lock (str) – If set to ratcheted, then object_lock_config.default_retention_mode cannot be changed if set to compliance. In this case, the value of object_lock_config.default_retention can only be increased and object_lock_config.default_retention_mode cannot be changed once set to compliance. Valid values are unlocked and ratcheted. Contact Pure Technical Services to change ratcheted to unlocked.
account (FixedReference) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'account': 'account', 'bucket_type': 'bucket_type', 'context': 'context', 'created': 'created', 'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'hard_limit_enabled': 'hard_limit_enabled', 'id': 'id', 'name': 'name', 'object_count': 'object_count', 'object_lock_config': 'object_lock_config', 'public_access_config': 'public_access_config', 'public_status': 'public_status', 'quota_limit': 'quota_limit', 'retention_lock': 'retention_lock', 'space': 'space', 'time_remaining': 'time_remaining', 'time_remaining_status': 'time_remaining_status', 'versioning': 'versioning'}
- required_args = {}
- swagger_types = {'account': 'FixedReference', 'bucket_type': 'str', 'context': 'Reference', 'created': 'int', 'destroyed': 'bool', 'eradication_config': 'BucketEradicationConfig', 'hard_limit_enabled': 'bool', 'id': 'str', 'name': 'str', 'object_count': 'int', 'object_lock_config': 'ObjectLockConfigResponse', 'public_access_config': 'PublicAccessConfig', 'public_status': 'str', 'quota_limit': 'int', 'retention_lock': 'str', 'space': 'Space', 'time_remaining': 'int', 'time_remaining_status': 'str', 'versioning': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy.BucketAccessPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, bucket=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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, bucket=None, rules=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
context (Reference) – 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.
bucket (FixedReference) – The bucket to which this policy belongs.
rules (list[BucketAccessPolicyRule]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bucket': 'bucket', 'context': 'context', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'rules': 'rules'}
- required_args = {}
- swagger_types = {'bucket': 'FixedReference', 'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'rules': 'list[BucketAccessPolicyRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_get_response.BucketAccessPolicyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[BucketAccessPolicy]) – A list of bucket policy 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[BucketAccessPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_post.BucketAccessPolicyPost(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[BucketAccessPolicyRuleBulkManage]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- required_args = {}
- swagger_types = {'rules': 'list[BucketAccessPolicyRuleBulkManage]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_response.BucketAccessPolicyResponse(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[BucketAccessPolicy]) – A list of bucket policy objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[BucketAccessPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule.BucketAccessPolicyRule(name=None, effect=None, resources=None, principals=None, actions=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, effect=None, resources=None, principals=None, actions=None, policy=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. The only currently supported effect is allow.
resources (list[str]) – The list of resources which this rule applies to. The only currently supported resource is all objects in a bucket to which the parent policy belongs.
principals (BucketAccessPolicyRulePrincipal) – The principals to which this rule applies. Currently, only all principals are supported.
actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. The only currently supported action is s3:GetObject.
policy (FixedReference) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actions': 'actions', 'effect': 'effect', 'name': 'name', 'policy': 'policy', 'principals': 'principals', 'resources': 'resources'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'effect': 'str', 'name': 'str', 'policy': 'FixedReference', 'principals': 'BucketAccessPolicyRulePrincipal', 'resources': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_bulk_manage module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_bulk_manage.BucketAccessPolicyRuleBulkManage(effect=None, resources=None, principals=None, actions=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__(effect=None, resources=None, principals=None, actions=None, name=None)
- Keyword Arguments
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. The only currently supported effect is allow.
resources (list[str]) – The list of resources which this rule applies to. The only currently supported resource is all objects in a bucket to which the parent policy belongs.
principals (BucketAccessPolicyRulePrincipal) – The principals to which this rule applies. Currently, only all principals are supported.
actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. The only currently supported action is s3:GetObject.
name (str) – Name of the object (e.g., a file system or snapshot).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actions': 'actions', 'effect': 'effect', 'name': 'name', 'principals': 'principals', 'resources': 'resources'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'effect': 'str', 'name': 'str', 'principals': 'BucketAccessPolicyRulePrincipal', 'resources': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_get_response.BucketAccessPolicyRuleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[BucketAccessPolicyRuleWithContext]) –
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[BucketAccessPolicyRuleWithContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_post.BucketAccessPolicyRulePost(effect=None, resources=None, principals=None, actions=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(effect=None, resources=None, principals=None, actions=None)
- Keyword Arguments
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. The only currently supported effect is allow.
resources (list[str]) – The list of resources which this rule applies to. The only currently supported resource is all objects in a bucket to which the parent policy belongs.
principals (BucketAccessPolicyRulePrincipal) – The principals to which this rule applies. Currently, only all principals are supported.
actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. The only currently supported action is s3:GetObject.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actions': 'actions', 'effect': 'effect', 'principals': 'principals', 'resources': 'resources'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'effect': 'str', 'principals': 'BucketAccessPolicyRulePrincipal', 'resources': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_principal module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_principal.BucketAccessPolicyRulePrincipal(all=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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=None)
- Keyword Arguments
all (bool) – If true, the rule will apply to all object store users regardless of their origin or principal.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'all': 'all'}
- required_args = {}
- swagger_types = {'all': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_response.BucketAccessPolicyRuleResponse(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[BucketAccessPolicyRuleWithContext]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[BucketAccessPolicyRuleWithContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_with_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_access_policy_rule_with_context.BucketAccessPolicyRuleWithContext(name=None, effect=None, resources=None, principals=None, actions=None, policy=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, effect=None, resources=None, principals=None, actions=None, policy=None, context=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. The only currently supported effect is allow.
resources (list[str]) – The list of resources which this rule applies to. The only currently supported resource is all objects in a bucket to which the parent policy belongs.
principals (BucketAccessPolicyRulePrincipal) – The principals to which this rule applies. Currently, only all principals are supported.
actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. The only currently supported action is s3:GetObject.
policy (FixedReference) – The policy to which this rule belongs.
context (Reference) – 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 = {'actions': 'actions', 'context': 'context', 'effect': 'effect', 'name': 'name', 'policy': 'policy', 'principals': 'principals', 'resources': 'resources'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'context': 'Reference', 'effect': 'str', 'name': 'str', 'policy': 'FixedReference', 'principals': 'BucketAccessPolicyRulePrincipal', 'resources': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_defaults module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_defaults.BucketDefaults(quota_limit=None, hard_limit_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__(quota_limit=None, hard_limit_enabled=None)
- Keyword Arguments
quota_limit (str) – The value of this field will be used to configure the quota_limit field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If set to an empty string (“”), the bucket default is unlimited in size. If not specified, defaults to unlimited.
hard_limit_enabled (bool) – The value of this field will be used to configure the hard_limit_enabled field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'hard_limit_enabled': 'hard_limit_enabled', 'quota_limit': 'quota_limit'}
- required_args = {}
- swagger_types = {'hard_limit_enabled': 'bool', 'quota_limit': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_defaults_readonly module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_defaults_readonly.BucketDefaultsReadonly(quota_limit=None, hard_limit_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__(quota_limit=None, hard_limit_enabled=None)
- Keyword Arguments
quota_limit (int) – The value of this field will be used to configure the quota_limit field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If unset, the bucket default is unlimited in size.
hard_limit_enabled (bool) – The value of this field will be used to configure the hard_limit_enabled field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'hard_limit_enabled': 'hard_limit_enabled', 'quota_limit': 'quota_limit'}
- required_args = {}
- swagger_types = {'hard_limit_enabled': 'bool', 'quota_limit': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_eradication_config module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_eradication_config.BucketEradicationConfig(eradication_delay=None, eradication_mode=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, eradication_mode=None, manual_eradication=None)
- Keyword Arguments
eradication_delay (int) – Minimum eradication delay in milliseconds. Automatically eradicate destroyed buckets after the delay time passes unless automatic eradication is delayed due to other configuration values.
eradication_mode (str) – The eradication mode of the bucket. If it’s permission-based the bucket can be eradicated based on user permissions. If it’s retention-based the bucket can never be eradicated as long as there are locked objects still being retained. Valid values are permission-based and retention-based.
manual_eradication (str) – The manual eradication status of the bucket. If disabled, the bucket cannot be eradicated after it has been destroyed, unless it is empty. If enabled, the bucket can be eradicated. Valid values are disabled and enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'eradication_delay': 'eradication_delay', 'eradication_mode': 'eradication_mode', 'manual_eradication': 'manual_eradication'}
- required_args = {}
- swagger_types = {'eradication_delay': 'int', 'eradication_mode': 'str', 'manual_eradication': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_get_response.BucketGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Bucket]) – A list of bucket objects.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (Bucket) –
- __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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[Bucket]', 'total': 'Bucket', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_patch.BucketPatch(object_lock_config=None, quota_limit=None, destroyed=None, versioning=None, hard_limit_enabled=None, public_access_config=None, eradication_config=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__(object_lock_config=None, quota_limit=None, destroyed=None, versioning=None, hard_limit_enabled=None, public_access_config=None, eradication_config=None, retention_lock=None)
- Keyword Arguments
object_lock_config (ObjectLockConfigRequestBody) –
quota_limit (str) – The effective quota limit applied against the size of the bucket, displayed in bytes. If set to an empty string (“”), the bucket is unlimited in size.
destroyed (bool) – Is the bucket destroyed?
versioning (str) – The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.
hard_limit_enabled (bool) – If set to true, the bucket’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the bucket, but soft quota alerts will still be sent if the bucket has a value set for quota_limit.
public_access_config (PublicAccessConfig) –
eradication_config (BucketEradicationConfig) –
retention_lock (str) – If set to ratcheted, then object_lock_config.default_retention_mode cannot be changed if set to compliance. In this case, the value of object_lock_config.default_retention can only be increased and object_lock_config.default_retention_mode cannot be changed once set to compliance. Valid values are unlocked and ratcheted. Contact Pure Technical Services to change ratcheted to unlocked.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'hard_limit_enabled': 'hard_limit_enabled', 'object_lock_config': 'object_lock_config', 'public_access_config': 'public_access_config', 'quota_limit': 'quota_limit', 'retention_lock': 'retention_lock', 'versioning': 'versioning'}
- required_args = {}
- swagger_types = {'destroyed': 'bool', 'eradication_config': 'BucketEradicationConfig', 'hard_limit_enabled': 'bool', 'object_lock_config': 'ObjectLockConfigRequestBody', 'public_access_config': 'PublicAccessConfig', 'quota_limit': 'str', 'retention_lock': 'str', 'versioning': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_performance.BucketPerformance(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) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
read_bytes_per_sec (float) – Bytes read per second.
others_per_sec (float) – Other operations processed per second.
reads_per_sec (float) – Read requests processed per second.
write_bytes_per_sec (float) – Bytes written per second.
bytes_per_write (float) – Average write size in bytes per write operation.
usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
writes_per_sec (float) – Write requests processed per second.
time (int) – Sample time in milliseconds since UNIX epoch.
bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).
usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.
bytes_per_read (float) – Average read size in bytes per read operation.
usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
- __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'}
- required_args = {}
- swagger_types = {'bytes_per_op': 'float', 'bytes_per_read': 'float', 'bytes_per_write': 'float', 'id': 'str', 'name': 'str', 'others_per_sec': 'float', 'read_bytes_per_sec': 'float', 'reads_per_sec': 'float', 'time': 'int', 'usec_per_other_op': 'float', 'usec_per_read_op': 'float', 'usec_per_write_op': 'float', 'write_bytes_per_sec': 'float', 'writes_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_performance_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_performance_get_response.BucketPerformanceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (list[BucketPerformance]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
items (list[BucketPerformance]) – A list of bucket 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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[BucketPerformance]', 'total': 'list[BucketPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_post.BucketPost(object_lock_config=None, quota_limit=None, hard_limit_enabled=None, bucket_type=None, eradication_config=None, retention_lock=None, account=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(object_lock_config=None, quota_limit=None, hard_limit_enabled=None, bucket_type=None, eradication_config=None, retention_lock=None, account=None)
- Keyword Arguments
object_lock_config (ObjectLockConfigRequestBody) –
quota_limit (str) – The effective quota limit applied against the size of the bucket, displayed in bytes. If set to an empty string (“”), the bucket is unlimited in size. If not specified, defaults to the value of bucket_defaults.quota_limit of the object store account this bucket is associated with.
hard_limit_enabled (bool) – If set to true, the bucket’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the bucket, but soft quota alerts will still be sent if the bucket has a value set for quota_limit. If not specified, defaults to the value of bucket_defaults.hard_limit_enabled of the object store account this bucket is associated with.
bucket_type (str) – The bucket type for the bucket. Valid values are classic, and multi-site-writable. Default value is multi-site-writable.
eradication_config (BucketEradicationConfig) –
retention_lock (str) – If set to ratcheted, then object_lock_config.default_retention_mode cannot be changed if set to compliance. In this case, the value of object_lock_config.default_retention can only be increased and object_lock_config.default_retention_mode cannot be changed once set to compliance. Valid values are unlocked and ratcheted. If not specified, defaults to unlocked.
account (ReferenceWritable) – The account name for bucket creation.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'account': 'account', 'bucket_type': 'bucket_type', 'eradication_config': 'eradication_config', 'hard_limit_enabled': 'hard_limit_enabled', 'object_lock_config': 'object_lock_config', 'quota_limit': 'quota_limit', 'retention_lock': 'retention_lock'}
- required_args = {}
- swagger_types = {'account': 'ReferenceWritable', 'bucket_type': 'str', 'eradication_config': 'BucketEradicationConfig', 'hard_limit_enabled': 'bool', 'object_lock_config': 'ObjectLockConfigRequestBody', 'quota_limit': 'str', 'retention_lock': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_replica_link module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_replica_link.BucketReplicaLink(id=None, lag=None, status_details=None, direction=None, context=None, paused=None, remote_credentials=None, local_bucket=None, recovery_point=None, remote_bucket=None, cascading_enabled=None, remote=None, object_backlog=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, lag=None, status_details=None, direction=None, context=None, paused=None, remote_credentials=None, local_bucket=None, recovery_point=None, remote_bucket=None, cascading_enabled=None, remote=None, object_backlog=None, status=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
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.
status_details (str) – Detailed information about the status of the replica link when it is unhealthy.
direction (Direction) –
context (Reference) – 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) – Is the replica link paused?
remote_credentials (ReferenceWritable) – Reference to a remote-credentials object to access the remote bucket.
local_bucket (FixedReference) – Reference to a local bucket.
recovery_point (int) – Time, in milliseconds since UNIX epoch, where all object changes before this time are guaranteed to have been replicated. Changes after this time may have been replicated.
remote_bucket (FixedReferenceNameOnly) – Reference to a remote bucket.
cascading_enabled (bool) – If set to true, objects replicated to this bucket via a replica link from another array will also be replicated by this link to the remote bucket. Defaults to false.
remote (FixedReference) – Reference to the associated remote, which can either be a target or remote array. If it is an array, then the resource-type field will not be populated.
object_backlog (ObjectBacklog) – The number of pending operations and their size that are currently in the backlog.
status (str) – Status of the replica link. Values include replicating, paused, and unhealthy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'cascading_enabled': 'cascading_enabled', 'context': 'context', 'direction': 'direction', 'id': 'id', 'lag': 'lag', 'local_bucket': 'local_bucket', 'object_backlog': 'object_backlog', 'paused': 'paused', 'recovery_point': 'recovery_point', 'remote': 'remote', 'remote_bucket': 'remote_bucket', 'remote_credentials': 'remote_credentials', 'status': 'status', 'status_details': 'status_details'}
- required_args = {}
- swagger_types = {'cascading_enabled': 'bool', 'context': 'Reference', 'direction': 'Direction', 'id': 'str', 'lag': 'int', 'local_bucket': 'FixedReference', 'object_backlog': 'ObjectBacklog', 'paused': 'bool', 'recovery_point': 'int', 'remote': 'FixedReference', 'remote_bucket': 'FixedReferenceNameOnly', 'remote_credentials': 'ReferenceWritable', 'status': 'str', 'status_details': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_replica_link_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_replica_link_get_response.BucketReplicaLinkGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (BucketReplicaLink) – If total_only query param is true, then it will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.
items (list[BucketReplicaLink]) – A list of object store bucket replica link 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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[BucketReplicaLink]', 'total': 'BucketReplicaLink', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_replica_link_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_replica_link_post.BucketReplicaLinkPost(paused=None, cascading_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__(paused=None, cascading_enabled=None)
- Keyword Arguments
paused (bool) – Create link in the paused state? Defaults to false.
cascading_enabled (bool) – If set to true, objects replicated to this bucket via a replica link from another array will also be replicated by this link to the remote bucket. Defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'cascading_enabled': 'cascading_enabled', 'paused': 'paused'}
- required_args = {}
- swagger_types = {'cascading_enabled': 'bool', 'paused': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_replica_link_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_replica_link_response.BucketReplicaLinkResponse(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 (BucketReplicaLink) – If total_only query param is true, then it will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.
items (list[BucketReplicaLink]) – A list of object store bucket replica link objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items', 'total': 'total'}
- required_args = {}
- swagger_types = {'items': 'list[BucketReplicaLink]', 'total': 'BucketReplicaLink'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_response.BucketResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[Bucket]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_s3_specific_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_s3_specific_performance.BucketS3SpecificPerformance(name=None, id=None, read_objects_per_sec=None, usec_per_write_bucket_op=None, write_buckets_per_sec=None, others_per_sec=None, usec_per_other_op=None, read_buckets_per_sec=None, usec_per_write_object_op=None, time=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, write_objects_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__(name=None, id=None, read_objects_per_sec=None, usec_per_write_bucket_op=None, write_buckets_per_sec=None, others_per_sec=None, usec_per_other_op=None, read_buckets_per_sec=None, usec_per_write_object_op=None, time=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, write_objects_per_sec=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
read_objects_per_sec (float) – Read object requests processed per second.
usec_per_write_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a write bucket request.
write_buckets_per_sec (float) – Write buckets requests processed per second.
others_per_sec (float) – Other operations processed per second.
usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
read_buckets_per_sec (float) – Read buckets requests processed per second.
usec_per_write_object_op (float) – Average time, measured in microseconds, it takes the array to process a write object request.
time (int) – Sample time in milliseconds since UNIX epoch.
usec_per_read_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a read bucket request.
usec_per_read_object_op (float) – Average time, measured in microseconds, it takes the array to process a read object request.
write_objects_per_sec (float) – Write object requests processed per second.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'others_per_sec': 'others_per_sec', 'read_buckets_per_sec': 'read_buckets_per_sec', 'read_objects_per_sec': 'read_objects_per_sec', 'time': 'time', 'usec_per_other_op': 'usec_per_other_op', 'usec_per_read_bucket_op': 'usec_per_read_bucket_op', 'usec_per_read_object_op': 'usec_per_read_object_op', 'usec_per_write_bucket_op': 'usec_per_write_bucket_op', 'usec_per_write_object_op': 'usec_per_write_object_op', 'write_buckets_per_sec': 'write_buckets_per_sec', 'write_objects_per_sec': 'write_objects_per_sec'}
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'others_per_sec': 'float', 'read_buckets_per_sec': 'float', 'read_objects_per_sec': 'float', 'time': 'int', 'usec_per_other_op': 'float', 'usec_per_read_bucket_op': 'float', 'usec_per_read_object_op': 'float', 'usec_per_write_bucket_op': 'float', 'usec_per_write_object_op': 'float', 'write_buckets_per_sec': 'float', 'write_objects_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.bucket_s3_specific_performance_get_resp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.bucket_s3_specific_performance_get_resp.BucketS3SpecificPerformanceGetResp(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (list[BucketS3SpecificPerformance]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
items (list[BucketS3SpecificPerformance]) – A list of S3 specific bucket performance metrics objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[BucketS3SpecificPerformance]', 'total': 'list[BucketS3SpecificPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.built_in module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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) – Name of the object (e.g., a file system or snapshot).
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', 'name': 'name'}
- 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.flashblade.FB_2_17.models.built_in_no_id module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.built_in_no_id.BuiltInNoId(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) – Name of the object (e.g., a file system or snapshot).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- 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.flashblade.FB_2_17.models.built_in_relationship module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.certificate module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate.Certificate(name=None, id=None, country=None, issued_by=None, issued_to=None, subject_alternative_names=None, certificate=None, locality=None, valid_from=None, intermediate_certificate=None, organization=None, valid_to=None, state=None, certificate_type=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, id=None, country=None, issued_by=None, issued_to=None, subject_alternative_names=None, certificate=None, locality=None, valid_from=None, intermediate_certificate=None, organization=None, valid_to=None, state=None, certificate_type=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
country (str) – The country field listed in the certificate.
issued_by (str) – Who issued this certificate.
issued_to (str) – Who this certificate was issued to.
subject_alternative_names (list[str]) – The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs.
certificate (str) – The text of the certificate.
locality (str) – The locality field listed in the certificate.
valid_from (str) – The start date of when this certificate is valid.
intermediate_certificate (str) – Intermediate certificate chains.
organization (str) – The organization field listed in the certificate.
valid_to (str) – The end date of when this certificate is valid.
state (str) – The state/province field listed in the certificate.
certificate_type (str) – The type of certificate. Possible values are appliance and external. Certificates of type appliance are used by the array to verify its identity to clients. Certificates of type external are used by the array to identify external servers to which it is configured to communicate.
common_name (str) – FQDN or management IP address of the current array.
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 this certificate in 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', 'certificate_type': 'certificate_type', 'common_name': 'common_name', 'country': 'country', 'email': 'email', 'id': 'id', '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', 'subject_alternative_names': 'subject_alternative_names', 'valid_from': 'valid_from', 'valid_to': 'valid_to'}
- required_args = {}
- swagger_types = {'certificate': 'str', 'certificate_type': 'str', 'common_name': 'str', 'country': 'str', 'email': 'str', 'id': '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', 'subject_alternative_names': 'list[str]', 'valid_from': 'str', 'valid_to': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_certificate_group_get_resp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_certificate_group_get_resp.CertificateCertificateGroupGetResp(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Member]) – 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Member]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_certificate_group_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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[Member]) – 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'}
- 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.flashblade.FB_2_17.models.certificate_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_get_response.CertificateGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Certificate]) – A list of certificate objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Certificate]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_group module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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) – Name of the object (e.g., a file system or snapshot).
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', 'name': 'name'}
- 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.flashblade.FB_2_17.models.certificate_group_certificate_get_resp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_group_certificate_get_resp.CertificateGroupCertificateGetResp(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Member]) – 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Member]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_group_certificate_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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[Member]) – 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'}
- 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.flashblade.FB_2_17.models.certificate_group_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_group_get_response.CertificateGroupGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[CertificateGroup]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_group_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.certificate_group_use module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_group_use.CertificateGroupUse(name=None, id=None, use=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, use=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
use (FixedReferenceWithRemote) – A reference to an object using this certificate group.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'use': 'use'}
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'use': 'FixedReferenceWithRemote'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_group_use_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_group_use_get_response.CertificateGroupUseGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[CertificateGroupUse]) – A list of certificate group use objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[CertificateGroupUse]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_patch.CertificatePatch(name=None, id=None, certificate=None, passphrase=None, private_key=None, intermediate_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__(name=None, id=None, certificate=None, passphrase=None, private_key=None, intermediate_certificate=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
certificate (str) – The text of the certificate.
passphrase (str) – The passphrase used to encrypt private_key.
private_key (str) – The private key used to sign the certificate.
intermediate_certificate (str) – Intermediate certificate chains.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'certificate': 'certificate', 'id': 'id', 'intermediate_certificate': 'intermediate_certificate', 'name': 'name', 'passphrase': 'passphrase', 'private_key': 'private_key'}
- required_args = {}
- swagger_types = {'certificate': 'str', 'id': 'str', 'intermediate_certificate': 'str', 'name': 'str', 'passphrase': 'str', 'private_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_post.CertificatePost(name=None, country=None, issued_by=None, issued_to=None, certificate=None, locality=None, valid_from=None, private_key=None, intermediate_certificate=None, organization=None, valid_to=None, passphrase=None, state=None, certificate_type=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, private_key=None, intermediate_certificate=None, organization=None, valid_to=None, passphrase=None, state=None, certificate_type=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
country (str) – The country field listed in the certificate.
issued_by (str) – Who issued this certificate.
issued_to (str) – Who this certificate was issued to.
certificate (str) – The text of the certificate.
locality (str) – The locality field listed in the certificate.
valid_from (str) – The start date of when this certificate is valid.
private_key (str) – The private key used to sign the certificate.
intermediate_certificate (str) – Intermediate certificate chains.
organization (str) – The organization field listed in the certificate.
valid_to (str) – The end date of when this certificate is valid.
passphrase (str) – The passphrase used to encrypt private_key.
state (str) – The state/province field listed in the certificate.
certificate_type (str) – The type of certificate. Possible values are appliance and external. Certificates of type appliance are used by the array to verify its identity to clients. Certificates of type external are used by the array to identify external servers to which it is configured to communicate.
common_name (str) – FQDN or management IP address of the current array.
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 this certificate in 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', 'certificate_type': 'certificate_type', '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', 'passphrase': 'passphrase', 'private_key': 'private_key', 'state': 'state', 'status': 'status', 'valid_from': 'valid_from', 'valid_to': 'valid_to'}
- required_args = {}
- swagger_types = {'certificate': 'str', 'certificate_type': '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', 'passphrase': 'str', 'private_key': 'str', 'state': 'str', 'status': 'str', 'valid_from': 'str', 'valid_to': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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]) – A list of certificate objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- 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.flashblade.FB_2_17.models.certificate_use module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_use.CertificateUse(name=None, id=None, use=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, id=None, use=None, group=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
use (FixedReferenceWithRemote) – A reference to an object using this certificate.
group (FixedReference) – A reference to a certificate group that is being used, if any, where this certificate is a member of the certificate-group. This field is null if the referenced use object is not using a group, but is rather using this certificate directly.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'group': 'group', 'id': 'id', 'name': 'name', 'use': 'use'}
- required_args = {}
- swagger_types = {'group': 'FixedReference', 'id': 'str', 'name': 'str', 'use': 'FixedReferenceWithRemote'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.certificate_use_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.certificate_use_get_response.CertificateUseGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[CertificateUse]) – A list of certificate use objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[CertificateUse]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.client_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.client_performance.ClientPerformance(name=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, 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) – Name of the object (e.g., a file system or snapshot).
read_bytes_per_sec (int) – Bytes read per second.
others_per_sec (int) – Other operations processed per second.
reads_per_sec (int) – Read requests processed per second.
write_bytes_per_sec (int) – Bytes written per second.
bytes_per_write (int) – Average write size in bytes per write operation.
usec_per_other_op (int) – Average time, measured in microseconds, it takes the client to process other operations.
writes_per_sec (int) – Write requests processed per second.
time (int) – Sample time in milliseconds since UNIX epoch.
bytes_per_op (int) – Average operation size (read bytes+write bytes/read ops+write ops).
usec_per_write_op (int) – Average time, measured in microseconds, it takes the client to process a write request.
bytes_per_read (int) – Average read size in bytes per read operation.
usec_per_read_op (int) – Average time, measured in microseconds, it takes the client to process a read request.
- __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', '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'}
- required_args = {}
- swagger_types = {'bytes_per_op': 'int', 'bytes_per_read': 'int', 'bytes_per_write': 'int', '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.flashblade.FB_2_17.models.client_performance_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.client_performance_get_response.ClientPerformanceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (list[ClientPerformance]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
items (list[ClientPerformance]) – A list of client performance metrics 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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ClientPerformance]', 'total': 'list[ClientPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.connection_relationship_performance_replication module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.connection_relationship_performance_replication.ConnectionRelationshipPerformanceReplication(id=None, periodic=None, continuous=None, time=None, remote=None, aggregate=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, periodic=None, continuous=None, time=None, remote=None, aggregate=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
periodic (ReplicationPerformance) – Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based.
continuous (ContinuousReplicationPerformance) – Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication.
time (int) – Sample time in milliseconds since UNIX epoch.
remote (FixedReferenceNoResourceType) – Reference to a remote array.
aggregate (ReplicationPerformance) – Total bytes transmitted or received per second for all types of replication.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'aggregate': 'aggregate', 'continuous': 'continuous', 'id': 'id', 'periodic': 'periodic', 'remote': 'remote', 'time': 'time'}
- required_args = {}
- swagger_types = {'aggregate': 'ReplicationPerformance', 'continuous': 'ContinuousReplicationPerformance', 'id': 'str', 'periodic': 'ReplicationPerformance', 'remote': 'FixedReferenceNoResourceType', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.connection_relationship_performance_replication_get_resp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.connection_relationship_performance_replication_get_resp.ConnectionRelationshipPerformanceReplicationGetResp(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (list[ConnectionRelationshipPerformanceReplication]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
items (list[ConnectionRelationshipPerformanceReplication]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ConnectionRelationshipPerformanceReplication]', 'total': 'list[ConnectionRelationshipPerformanceReplication]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 (Reference) – 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'}
- required_args = {}
- swagger_types = {'context': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.continuous_replication_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.continuous_replication_performance.ContinuousReplicationPerformance(transmitted_bytes_per_sec=None, received_bytes_per_sec=None, object_backlog=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(transmitted_bytes_per_sec=None, received_bytes_per_sec=None, object_backlog=None)
- Keyword Arguments
transmitted_bytes_per_sec (float) – Total bytes transmitted per second.
received_bytes_per_sec (float) – Total bytes received per second.
object_backlog (ObjectBacklog) – The total number of pending object operations and their size that are currently in the backlog.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'object_backlog': 'object_backlog', 'received_bytes_per_sec': 'received_bytes_per_sec', 'transmitted_bytes_per_sec': 'transmitted_bytes_per_sec'}
- required_args = {}
- swagger_types = {'object_backlog': 'ObjectBacklog', 'received_bytes_per_sec': 'float', 'transmitted_bytes_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy.CrossOriginResourceSharingPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, bucket=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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, bucket=None, rules=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
context (Reference) – 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.
bucket (FixedReference) – The bucket to which this policy belongs.
rules (list[CrossOriginResourceSharingPolicyRuleWithContext]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bucket': 'bucket', 'context': 'context', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'rules': 'rules'}
- required_args = {}
- swagger_types = {'bucket': 'FixedReference', 'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'rules': 'list[CrossOriginResourceSharingPolicyRuleWithContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_get_response.CrossOriginResourceSharingPolicyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[CrossOriginResourceSharingPolicy]) – A list of cross origin resource sharing policy 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[CrossOriginResourceSharingPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_patch.CrossOriginResourceSharingPolicyPatch(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[CrossOriginResourceSharingPolicyRuleBulkManage]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- required_args = {}
- swagger_types = {'rules': 'list[CrossOriginResourceSharingPolicyRuleBulkManage]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_response.CrossOriginResourceSharingPolicyResponse(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[CrossOriginResourceSharingPolicy]) – A list of cross origin resource sharing policy objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[CrossOriginResourceSharingPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule.CrossOriginResourceSharingPolicyRule(name=None, allowed_methods=None, allowed_headers=None, allowed_origins=None, context=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, allowed_methods=None, allowed_headers=None, allowed_origins=None, context=None, policy=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
allowed_methods (list[str]) – A list of HTTP methods that are permitted for cross-origin requests to access a bucket. The only currently supported combination of allowed methods is all methods [“GET”, “PUT”, “HEAD”, “POST”, “DELETE”].
allowed_headers (list[str]) – A list of headers that are permitted to be included in cross-origin requests to access a bucket. The only currently supported allowed header is *.
allowed_origins (list[str]) – A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.
context (Reference) – 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 (FixedReference) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed_headers': 'allowed_headers', 'allowed_methods': 'allowed_methods', 'allowed_origins': 'allowed_origins', 'context': 'context', 'name': 'name', 'policy': 'policy'}
- required_args = {}
- swagger_types = {'allowed_headers': 'list[str]', 'allowed_methods': 'list[str]', 'allowed_origins': 'list[str]', 'context': 'Reference', 'name': 'str', 'policy': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_bulk_manage module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_bulk_manage.CrossOriginResourceSharingPolicyRuleBulkManage(allowed_methods=None, allowed_headers=None, allowed_origins=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__(allowed_methods=None, allowed_headers=None, allowed_origins=None, name=None)
- Keyword Arguments
allowed_methods (list[str]) – A list of HTTP methods that are permitted for cross-origin requests to access a bucket. The only currently supported combination of allowed methods is all methods [“GET”, “PUT”, “HEAD”, “POST”, “DELETE”].
allowed_headers (list[str]) – A list of headers that are permitted to be included in cross-origin requests to access a bucket. The only currently supported allowed header is *.
allowed_origins (list[str]) – A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.
name (str) – Name of the object (e.g., a file system or snapshot).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed_headers': 'allowed_headers', 'allowed_methods': 'allowed_methods', 'allowed_origins': 'allowed_origins', 'name': 'name'}
- required_args = {}
- swagger_types = {'allowed_headers': 'list[str]', 'allowed_methods': 'list[str]', 'allowed_origins': 'list[str]', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_get_response.CrossOriginResourceSharingPolicyRuleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[CrossOriginResourceSharingPolicyRuleWithContext]) –
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[CrossOriginResourceSharingPolicyRuleWithContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_post.CrossOriginResourceSharingPolicyRulePost(allowed_methods=None, allowed_headers=None, allowed_origins=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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_methods=None, allowed_headers=None, allowed_origins=None)
- Keyword Arguments
allowed_methods (list[str]) – A list of HTTP methods that are permitted for cross-origin requests to access a bucket. The only currently supported combination of allowed methods is all methods [“GET”, “PUT”, “HEAD”, “POST”, “DELETE”].
allowed_headers (list[str]) – A list of headers that are permitted to be included in cross-origin requests to access a bucket. The only currently supported allowed header is *.
allowed_origins (list[str]) – A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed_headers': 'allowed_headers', 'allowed_methods': 'allowed_methods', 'allowed_origins': 'allowed_origins'}
- required_args = {}
- swagger_types = {'allowed_headers': 'list[str]', 'allowed_methods': 'list[str]', 'allowed_origins': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_response.CrossOriginResourceSharingPolicyRuleResponse(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[CrossOriginResourceSharingPolicyRuleWithContext]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[CrossOriginResourceSharingPolicyRuleWithContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_with_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.cross_origin_resource_sharing_policy_rule_with_context.CrossOriginResourceSharingPolicyRuleWithContext(name=None, allowed_methods=None, allowed_headers=None, allowed_origins=None, context=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, allowed_methods=None, allowed_headers=None, allowed_origins=None, context=None, policy=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
allowed_methods (list[str]) – A list of HTTP methods that are permitted for cross-origin requests to access a bucket. The only currently supported combination of allowed methods is all methods [“GET”, “PUT”, “HEAD”, “POST”, “DELETE”].
allowed_headers (list[str]) – A list of headers that are permitted to be included in cross-origin requests to access a bucket. The only currently supported allowed header is *.
allowed_origins (list[str]) – A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.
context (Reference) – 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 (FixedReference) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'allowed_headers': 'allowed_headers', 'allowed_methods': 'allowed_methods', 'allowed_origins': 'allowed_origins', 'context': 'context', 'name': 'name', 'policy': 'policy'}
- required_args = {}
- swagger_types = {'allowed_headers': 'list[str]', 'allowed_methods': 'list[str]', 'allowed_origins': 'list[str]', 'context': 'Reference', 'name': 'str', 'policy': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.direction module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.direction.Direction
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__()
Keyword args:
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {}
- required_args = {}
- swagger_types = {}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.directory_service module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.directory_service.DirectoryService(name=None, id=None, ca_certificate=None, uris=None, base_dn=None, bind_password=None, management=None, smb=None, ca_certificate_group=None, nfs=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, id=None, ca_certificate=None, uris=None, base_dn=None, bind_password=None, management=None, smb=None, ca_certificate_group=None, nfs=None, services=None, bind_user=None, enabled=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
ca_certificate (Reference) – CA certificate used to validate the authenticity of the configured servers.
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) – Obfuscated password used to query the directory.
management (DirectoryServiceManagement) –
smb (DirectoryServiceSmb) –
ca_certificate_group (Reference) – A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers.
nfs (DirectoryServiceNfs) –
services (list[str]) – Services that the directory service configuration is used for.
bind_user (str) – Username used to query the directory.
enabled (bool) – Is the directory service enabled or not?
- __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', 'ca_certificate_group': 'ca_certificate_group', 'enabled': 'enabled', 'id': 'id', 'management': 'management', 'name': 'name', 'nfs': 'nfs', 'services': 'services', 'smb': 'smb', 'uris': 'uris'}
- required_args = {}
- swagger_types = {'base_dn': 'str', 'bind_password': 'str', 'bind_user': 'str', 'ca_certificate': 'Reference', 'ca_certificate_group': 'Reference', 'enabled': 'bool', 'id': 'str', 'management': 'DirectoryServiceManagement', 'name': 'str', 'nfs': 'DirectoryServiceNfs', 'services': 'list[str]', 'smb': 'DirectoryServiceSmb', 'uris': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.directory_service_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.directory_service_get_response.DirectoryServiceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[DirectoryService]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.directory_service_management module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.directory_service_management.DirectoryServiceManagement(user_login_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, 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.
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 = {'user_login_attribute': 'user_login_attribute', 'user_object_class': 'user_object_class'}
- required_args = {}
- swagger_types = {'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.flashblade.FB_2_17.models.directory_service_nfs module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.directory_service_nfs.DirectoryServiceNfs(nis_domains=None, nis_servers=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(nis_domains=None, nis_servers=None)
- Keyword Arguments
nis_domains (list[str]) – NIS domains to search.
nis_servers (list[str]) – A list of the IP addresses or hostnames of NIS servers to search.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'nis_domains': 'nis_domains', 'nis_servers': 'nis_servers'}
- required_args = {}
- swagger_types = {'nis_domains': 'list[str]', 'nis_servers': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.directory_service_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.directory_service_role module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.directory_service_role.DirectoryServiceRole(role=None, group_base=None, name=None, id=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__(role=None, group_base=None, name=None, id=None, group=None)
- Keyword Arguments
role (ReferenceWritable) – A reference to the role; can be any role that exists on the system.
group_base (str) – Specifies where the configured group is located in the directory tree.
name (str) – Name of the role mapping object.
id (str) – A non-modifiable, globally unique ID chosen by the system.
group (str) – Common Name (CN) of the directory service group containing users with authority level of the specified role name.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'group': 'group', 'group_base': 'group_base', 'id': 'id', 'name': 'name', 'role': 'role'}
- required_args = {}
- swagger_types = {'group': 'str', 'group_base': 'str', 'id': 'str', 'name': 'str', 'role': 'ReferenceWritable'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.directory_service_roles_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.directory_service_roles_get_response.DirectoryServiceRolesGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[DirectoryServiceRole]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.directory_service_roles_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.directory_service_roles_response.DirectoryServiceRolesResponse(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'}
- 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.flashblade.FB_2_17.models.directory_service_smb module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.directory_service_smb.DirectoryServiceSmb(join_ou=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(join_ou=None)
- Keyword Arguments
join_ou (str) – Optional organizational unit where the machine account for the directory service will be created.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'join_ou': 'join_ou'}
- required_args = {}
- swagger_types = {'join_ou': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.dns module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.dns.Dns(name=None, id=None, nameservers=None, sources=None, domain=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, id=None, nameservers=None, sources=None, domain=None, services=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
nameservers (list[str]) – List of DNS server IP addresses.
sources (list[Reference]) – The network interfaces used for communication with the DNS server. The network interfaces must have the services value of data. Clear this by setting an empty list.
domain (str) – Domain suffix to be appended by the appliance when performing DNS lookups.
services (list[str]) – The list of services utilizing the DNS configuration.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'domain': 'domain', 'id': 'id', 'name': 'name', 'nameservers': 'nameservers', 'services': 'services', 'sources': 'sources'}
- required_args = {}
- swagger_types = {'domain': 'str', 'id': 'str', 'name': 'str', 'nameservers': 'list[str]', 'services': 'list[str]', 'sources': 'list[Reference]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.dns_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.dns_get_response.DnsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Dns]) – A list of dns objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Dns]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.dns_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.dns_post.DnsPost(nameservers=None, sources=None, domain=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__(nameservers=None, sources=None, domain=None, services=None)
- Keyword Arguments
nameservers (list[str]) – List of DNS server IP addresses.
sources (list[Reference]) – The network interfaces used for communication with the DNS server. The network interfaces must have the services value of data. Clear this by setting an empty list.
domain (str) – Domain suffix to be appended by the appliance when performing DNS lookups.
services (list[str]) – The list of services utilizing the DNS configuration.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'domain': 'domain', 'nameservers': 'nameservers', 'services': 'services', 'sources': 'sources'}
- required_args = {}
- swagger_types = {'domain': 'str', 'nameservers': 'list[str]', 'services': 'list[str]', 'sources': 'list[Reference]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.dns_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.drive module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.drive.Drive(name=None, id=None, raw_capacity=None, progress=None, details=None, type=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, raw_capacity=None, progress=None, details=None, type=None, status=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
raw_capacity (int) –
progress (float) – Reflects this drive’s current progress toward completing a planned evacuation. If a planned evacuation is not occurring, the value will be null.
details (str) – Details about the status of the drive if not healthy.
type (str) – The type of the module. Valid values are DFM and DFMe.
status (str) – Current status of the drive. Valid values are evacuated, evacuating, healthy, unhealthy, unused, and updating.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'details': 'details', 'id': 'id', 'name': 'name', 'progress': 'progress', 'raw_capacity': 'raw_capacity', 'status': 'status', 'type': 'type'}
- required_args = {}
- swagger_types = {'details': 'str', 'id': 'str', 'name': 'str', 'progress': 'float', 'raw_capacity': 'int', 'status': 'str', 'type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.drive_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.drive_get_response.DriveGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (object) –
items (list[Drive]) – A list of drive objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Drive]', 'total': 'object', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.error_context_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.error_context_response_errors module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.error_context_response_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'}
- 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.flashblade.FB_2_17.models.eula module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.eula_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.eula_get_response.EulaGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Eula]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.eula_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.eula_signature module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.file_info module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_info.FileInfo(name=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__(name=None, length=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
length (int) – Length of the file (in bytes).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'length': 'length', 'name': 'name'}
- required_args = {}
- swagger_types = {'length': 'int', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_lock module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_lock.FileLock(name=None, inode=None, path=None, access_type=None, protocol=None, client=None, created_at=None, range=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, inode=None, path=None, access_type=None, protocol=None, client=None, created_at=None, range=None, source=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
inode (int) – The inode of the file where the lock is found relative to the specified source.
path (str) – Path to the file where the lock is found relative to source. If it is longer than 1023 characters, it will be truncated and only the last 1023 characters will be returned. If multiple hard links exist to the file on which the lock is held, only one is returned. This field will be null if the path cannot be resolved.
access_type (str) – Type of access the lock provides. Valid values are shared, exclusive and no-access.
protocol (str) – The protocol utilized for obtaining and managing the lock. Valid values include NLM, NFSv4.1 and SMB.
client (FixedReferenceNoId) – Reference to the file system client that holds the lock.
created_at (int) – Creation timestamp of the lock. Measured in milliseconds since the UNIX epoch.
range (FileLockRange) –
source (FixedReference) – Reference to location where the path/inode can be found.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_type': 'access_type', 'client': 'client', 'created_at': 'created_at', 'inode': 'inode', 'name': 'name', 'path': 'path', 'protocol': 'protocol', 'range': 'range', 'source': 'source'}
- required_args = {}
- swagger_types = {'access_type': 'str', 'client': 'FixedReferenceNoId', 'created_at': 'int', 'inode': 'int', 'name': 'str', 'path': 'str', 'protocol': 'str', 'range': 'FileLockRange', 'source': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_lock_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_lock_get_response.FileLockGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[FileLock]) – A list of file locks.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[FileLock]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_lock_nlm_reclamation_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_lock_nlm_reclamation_response.FileLockNlmReclamationResponse(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[FileSystemLockNlmReclamation]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[FileSystemLockNlmReclamation]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_lock_range module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_lock_range.FileLockRange(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__(offset=None, length=None)
- Keyword Arguments
offset (int) –
length (int) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'length': 'length', 'offset': 'offset'}
- required_args = {}
- swagger_types = {'length': 'int', 'offset': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_lock_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_lock_response.FileLockResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[FileLock]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_session module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_session.FileSession(name=None, connection_time=None, protocol=None, port=None, client=None, opens=None, idle_time=None, time=None, user=None, authentication=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, connection_time=None, protocol=None, port=None, client=None, opens=None, idle_time=None, time=None, user=None, authentication=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
connection_time (int) – Connection time in milliseconds since UNIX epoch.
protocol (str) – The protocol utilized for obtaining and managing the session. Valid values include nfs and smb.
port (int) – Port number the client is connected from.
client (FixedReferenceNameOnly) – Client that holds the session.
opens (int) – Number of opens for the given session.
idle_time (int) – Duration in milliseconds that indicates how long the session has been idle.
time (int) – Current time in milliseconds since UNIX epoch.
user (UserNoId) – The user who has created the session.
authentication (str) – Describes how was the user authenticated. Valid values include KRB and NTLMv2.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'authentication': 'authentication', 'client': 'client', 'connection_time': 'connection_time', 'idle_time': 'idle_time', 'name': 'name', 'opens': 'opens', 'port': 'port', 'protocol': 'protocol', 'time': 'time', 'user': 'user'}
- required_args = {}
- swagger_types = {'authentication': 'str', 'client': 'FixedReferenceNameOnly', 'connection_time': 'int', 'idle_time': 'int', 'name': 'str', 'opens': 'int', 'port': 'int', 'protocol': 'str', 'time': 'int', 'user': 'UserNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_session_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_session_get_response.FileSessionGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[FileSession]) – A list of file sessions.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[FileSession]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_session_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_session_response.FileSessionResponse(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[FileSession]) – A list of file sessions.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[FileSession]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system.FileSystem(name=None, id=None, context=None, promotion_status=None, storage_class=None, created=None, qos_policy=None, smb=None, eradication_config=None, source=None, multi_protocol=None, space=None, fast_remove_directory_enabled=None, writable=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_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, promotion_status=None, storage_class=None, created=None, qos_policy=None, smb=None, eradication_config=None, source=None, multi_protocol=None, space=None, fast_remove_directory_enabled=None, writable=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_enabled=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
promotion_status (str) – Possible values are promoted and demoted. The current status of the file system with respect to replication. Changes via requested_promotion_state. The default for new file systems is promoted.
storage_class (StorageClassInfo) –
created (int) – Creation timestamp of the file system.
qos_policy (FixedReference) – The QoS policy for the File System defines the performance controls that can be applied to the aggregate performance of all the clients accessing the file system. If no policy is configured for a file system, then no performance controls are applied to it.
smb (Smb) – SMB configuration.
eradication_config (FileSystemEradicationConfig) –
source (LocationReference) – A reference to the source file system.
multi_protocol (MultiProtocol) – Multi-protocol configuration.
space (Space) – The space usage of the file system.
fast_remove_directory_enabled (bool) – If set to true, the file system, when mounted, will contain a directory that can be used for fast removal of other directories. Directories can be moved into the fast remove directory in order to have them deleted, and their space freed, more quickly than a normal removal operation.
writable (bool) – Whether the file system is writable or not. If false, this overrides any protocol or file permission settings and prevents changes. If true, then the protocol and file permission settings are evaluated. If not specified, defaults to true. Modifiable.
time_remaining (int) – Time in milliseconds before the file system is eradicated. null if not destroyed.
destroyed (bool) – Returns a value of true if the file system has been destroyed and is pending eradication. The file system cannot be modified while it is in the destroyed state. The time_remaining value displays the amount of time left until the destroyed file system is permanently eradicated. Once eradication has begun, the file system can no longer be recovered. Before the time_remaining period has elapsed, the destroyed file system can be recovered through the PATCH method by setting destroyed=false.
hard_limit_enabled (bool) – If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota.
provisioned (int) – The provisioned size of the file system, displayed in bytes. If set to an empty string (“”), the file system is unlimited in size.
requested_promotion_state (str) – Possible values are promoted and demoted. The demoted state is used for replication targets and is only allowed to be set if the file system is in a replica-link relationship. The additional query param discard-non-snapshotted-data must be set to true when demoting a file system. The default for new file systems is promoted.
default_user_quota (int) – The default space quota for a user writing to this file system.
group_ownership (str) – The group ownership for new files and directories in a file system. Possible values are creator and parent-directory. If creator is selected, the owning group of new files and directories is the primary group of the user who creates them. If parent-directory is selected, the owning group is the parent directory group. Note: Existing files and directories are unaffected by this change.
http (Http) – HTTP configuration.
nfs (Nfs) – NFS configuration.
default_group_quota (int) – The default space quota for a group writing to this file system.
snapshot_directory_enabled (bool) – If set to true, a hidden .snapshot directory will be present in each directory of the file system when it is mounted. The .snapshot directory allows clients read access to the contents of the snapshots that have been taken of a directory. If set to false, the .snapshot directory will not be present in any directories within a mounted file system.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'default_group_quota': 'default_group_quota', 'default_user_quota': 'default_user_quota', 'destroyed': 'destroyed', 'eradication_config': 'eradication_config', 'fast_remove_directory_enabled': 'fast_remove_directory_enabled', 'group_ownership': 'group_ownership', 'hard_limit_enabled': 'hard_limit_enabled', 'http': 'http', 'id': 'id', 'multi_protocol': 'multi_protocol', 'name': 'name', 'nfs': 'nfs', 'promotion_status': 'promotion_status', 'provisioned': 'provisioned', 'qos_policy': 'qos_policy', 'requested_promotion_state': 'requested_promotion_state', 'smb': 'smb', 'snapshot_directory_enabled': 'snapshot_directory_enabled', 'source': 'source', 'space': 'space', 'storage_class': 'storage_class', 'time_remaining': 'time_remaining', 'writable': 'writable'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'created': 'int', 'default_group_quota': 'int', 'default_user_quota': 'int', 'destroyed': 'bool', 'eradication_config': 'FileSystemEradicationConfig', 'fast_remove_directory_enabled': 'bool', 'group_ownership': 'str', 'hard_limit_enabled': 'bool', 'http': 'Http', 'id': 'str', 'multi_protocol': 'MultiProtocol', 'name': 'str', 'nfs': 'Nfs', 'promotion_status': 'str', 'provisioned': 'int', 'qos_policy': 'FixedReference', 'requested_promotion_state': 'str', 'smb': 'Smb', 'snapshot_directory_enabled': 'bool', 'source': 'LocationReference', 'space': 'Space', 'storage_class': 'StorageClassInfo', 'time_remaining': 'int', 'writable': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_client module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_client.FileSystemClient(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) – Name of the object (e.g., a file system or snapshot).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- 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.flashblade.FB_2_17.models.file_system_clients_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_clients_get_response.FileSystemClientsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[FileSystemClient]) – A list of file system clients.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[FileSystemClient]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_clients_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_clients_response.FileSystemClientsResponse(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[FileSystemClient]) – A list of file system clients.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[FileSystemClient]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_eradication_config module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_eradication_config.FileSystemEradicationConfig(eradication_mode=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_mode=None, manual_eradication=None)
- Keyword Arguments
eradication_mode (str) – The eradication mode of the file system. If it’s permission-based the file system can be eradicated based on user permissions. If it’s retention-based the file system can not be eradicated until no files/inodes are locked or retained. Valid values are permission-based and retention-based.
manual_eradication (str) – The manual eradication status of the file system. If disabled, the file system cannot be eradicated after it has been destroyed, unless it is empty. If enabled, the file system can be eradicated. Valid values are disabled and enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'eradication_mode': 'eradication_mode', 'manual_eradication': 'manual_eradication'}
- required_args = {}
- swagger_types = {'eradication_mode': 'str', 'manual_eradication': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_export module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_export.FileSystemExport(name=None, id=None, context=None, server=None, policy_type=None, share_policy=None, export_name=None, member=None, enabled=None, policy=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, server=None, policy_type=None, share_policy=None, export_name=None, member=None, enabled=None, policy=None, status=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
server (FixedReference) – Reference to the server the export will be visible on.
policy_type (str) – Policy type attached to the export. It is either SMB or NFS.
share_policy (Reference) – Reference to the SMB share policy (only used for SMB).
export_name (str) – The name of the export used by clients to mount the file system. Export names must be unique within the same protocol/server combination.
member (FixedReference) – Reference to the file system 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 the protocol is enabled on the file system.
policy (Reference) – Reference to the NFS export policy or SMB client policy.
status (str) – Explains why enabled is false. Valid values include policy_disabled and protocol_disabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'enabled': 'enabled', 'export_name': 'export_name', 'id': 'id', 'member': 'member', 'name': 'name', 'policy': 'policy', 'policy_type': 'policy_type', 'server': 'server', 'share_policy': 'share_policy', 'status': 'status'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'enabled': 'bool', 'export_name': 'str', 'id': 'str', 'member': 'FixedReference', 'name': 'str', 'policy': 'Reference', 'policy_type': 'str', 'server': 'FixedReference', 'share_policy': 'Reference', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_export_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_export_get_response.FileSystemExportGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[FileSystemExport]) – A list of file system export 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[FileSystemExport]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_export_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_export_post.FileSystemExportPost(server=None, share_policy=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__(server=None, share_policy=None, export_name=None)
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'export_name': 'export_name', 'server': 'server', 'share_policy': 'share_policy'}
- required_args = {}
- swagger_types = {'export_name': 'str', 'server': 'Reference', 'share_policy': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_export_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_export_response.FileSystemExportResponse(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[FileSystemExport]) – A list of file system export objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[FileSystemExport]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_get_response.FileSystemGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[FileSystem]) – A list of file system objects.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (FileSystem) –
- __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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[FileSystem]', 'total': 'FileSystem', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_group_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_group_performance.FileSystemGroupPerformance(name=None, read_bytes_per_sec=None, others_per_sec=None, write_bytes_per_sec=None, usec_per_other_op=None, bytes_per_op=None, bytes_per_read=None, usec_per_read_op=None, file_system=None, reads_per_sec=None, bytes_per_write=None, writes_per_sec=None, time=None, usec_per_write_op=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, read_bytes_per_sec=None, others_per_sec=None, write_bytes_per_sec=None, usec_per_other_op=None, bytes_per_op=None, bytes_per_read=None, usec_per_read_op=None, file_system=None, reads_per_sec=None, bytes_per_write=None, writes_per_sec=None, time=None, usec_per_write_op=None, group=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
read_bytes_per_sec (float) – Bytes read per second.
others_per_sec (float) – Other operations processed per second.
write_bytes_per_sec (float) – Bytes written per second.
usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).
bytes_per_read (float) – Average read size in bytes per read operation.
usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
file_system (FixedReference) – The file system on which the performance was measured.
reads_per_sec (float) – Read requests processed per second.
bytes_per_write (float) – Average write size in bytes per write operation.
writes_per_sec (float) – Write requests processed per second.
time (int) – Sample time in milliseconds since UNIX epoch.
usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.
group (Group) – The group whose performance is represented.
- __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', 'file_system': 'file_system', 'group': 'group', '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'}
- required_args = {}
- swagger_types = {'bytes_per_op': 'float', 'bytes_per_read': 'float', 'bytes_per_write': 'float', 'file_system': 'FixedReference', 'group': 'Group', 'name': 'str', 'others_per_sec': 'float', 'read_bytes_per_sec': 'float', 'reads_per_sec': 'float', 'time': 'int', 'usec_per_other_op': 'float', 'usec_per_read_op': 'float', 'usec_per_write_op': 'float', 'write_bytes_per_sec': 'float', 'writes_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_groups_performance_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_groups_performance_get_response.FileSystemGroupsPerformanceGetResponse(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[FileSystemGroupPerformance]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
items (list[FileSystemGroupPerformance]) – A list of file system group performance objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items', 'total': 'total'}
- required_args = {}
- swagger_types = {'items': 'list[FileSystemGroupPerformance]', 'total': 'list[FileSystemGroupPerformance]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_lock_nlm_reclamation module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_lock_nlm_reclamation.FileSystemLockNlmReclamation(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'}
- 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.flashblade.FB_2_17.models.file_system_open_file module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_open_file.FileSystemOpenFile(mode=None, lock_count=None, path=None, session=None, client=None, id=None, source=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__(mode=None, lock_count=None, path=None, session=None, client=None, id=None, source=None, user=None)
- Keyword Arguments
mode (str) – The mode in which the file is open: “ro” for Read-Only, “wo” for Write-Only, “rw” for Read-Write or “no-access” if no read or write access was granted.
lock_count (int) – The number of locks on the file.
path (str) – The path to the open file.
session (FixedReferenceNameOnly) – The name of the session with the open file.
client (FixedReferenceNameOnly) – Client that has the file open.
id (str) – The unique identifier of the open file.
source (FixedReference) – Reference to the file system.
user (UserNoId) – The user who has the file open.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'id': 'id', 'lock_count': 'lock_count', 'mode': 'mode', 'path': 'path', 'session': 'session', 'source': 'source', 'user': 'user'}
- required_args = {}
- swagger_types = {'client': 'FixedReferenceNameOnly', 'id': 'str', 'lock_count': 'int', 'mode': 'str', 'path': 'str', 'session': 'FixedReferenceNameOnly', 'source': 'FixedReference', 'user': 'UserNoId'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_open_files_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_open_files_get_response.FileSystemOpenFilesGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[FileSystemOpenFile]) – A list of file system open file objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[FileSystemOpenFile]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_open_files_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_open_files_response.FileSystemOpenFilesResponse(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[FileSystemOpenFile]) – A list of file system open file objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[FileSystemOpenFile]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_patch.FileSystemPatch(name=None, id=None, promotion_status=None, storage_class=None, created=None, qos_policy=None, smb=None, source=None, multi_protocol=None, fast_remove_directory_enabled=None, writable=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_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, promotion_status=None, storage_class=None, created=None, qos_policy=None, smb=None, source=None, multi_protocol=None, fast_remove_directory_enabled=None, writable=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_enabled=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
promotion_status (str) – Possible values are promoted and demoted. The current status of the file system with respect to replication. Changes via requested_promotion_state. The default for new file systems is promoted.
storage_class (StorageClassInfo) –
created (int) – Creation timestamp of the file system.
qos_policy (Reference) – The QoS policy for the File System defines the performance controls that can be applied to the aggregate performance of all the clients accessing the file system. If no policy is configured for a file system, then no performance controls are applied to it. Use “” to clear an attached policy.
smb (Smb) – SMB configuration.
source (FixedLocationReference) – A reference to the source file system.
multi_protocol (MultiProtocol) – Multi-protocol configuration.
fast_remove_directory_enabled (bool) – If set to true, the file system, when mounted, will contain a directory that can be used for fast removal of other directories. Directories can be moved into the fast remove directory in order to have them deleted, and their space freed, more quickly than a normal removal operation.
writable (bool) – Whether the file system is writable or not. If false, this overrides any protocol or file permission settings and prevents changes. If true, then the protocol and file permission settings are evaluated. If not specified, defaults to true. Modifiable.
time_remaining (int) – Time in milliseconds before the file system is eradicated. null if not destroyed.
destroyed (bool) – Returns a value of true if the file system has been destroyed and is pending eradication. The file system cannot be modified while it is in the destroyed state. The time_remaining value displays the amount of time left until the destroyed file system is permanently eradicated. Once eradication has begun, the file system can no longer be recovered. Before the time_remaining period has elapsed, the destroyed file system can be recovered through the PATCH method by setting destroyed=false.
hard_limit_enabled (bool) – If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota.
provisioned (int) – The provisioned size of the file system, displayed in bytes. If set to an empty string (“”), the file system is unlimited in size.
requested_promotion_state (str) – Possible values are promoted and demoted. The demoted state is used for replication targets and is only allowed to be set if the file system is in a replica-link relationship. The additional query param discard-non-snapshotted-data must be set to true when demoting a file system. The default for new file systems is promoted.
default_user_quota (int) – The default space quota for a user writing to this file system.
group_ownership (str) – The group ownership for new files and directories in a file system. Possible values are creator and parent-directory. If creator is selected, the owning group of new files and directories is the primary group of the user who creates them. If parent-directory is selected, the owning group is the parent directory group. Note: Existing files and directories are unaffected by this change.
http (Http) – HTTP configuration.
nfs (NfsPatch) – NFS configuration.
default_group_quota (int) – The default space quota for a group writing to this file system.
snapshot_directory_enabled (bool) – If set to true, a hidden .snapshot directory will be present in each directory of the file system when it is mounted. The .snapshot directory allows clients read access to the contents of the snapshots that have been taken of a directory. If set to false, the .snapshot directory will not be present in any directories within a mounted file system.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'default_group_quota': 'default_group_quota', 'default_user_quota': 'default_user_quota', 'destroyed': 'destroyed', 'fast_remove_directory_enabled': 'fast_remove_directory_enabled', 'group_ownership': 'group_ownership', 'hard_limit_enabled': 'hard_limit_enabled', 'http': 'http', 'id': 'id', 'multi_protocol': 'multi_protocol', 'name': 'name', 'nfs': 'nfs', 'promotion_status': 'promotion_status', 'provisioned': 'provisioned', 'qos_policy': 'qos_policy', 'requested_promotion_state': 'requested_promotion_state', 'smb': 'smb', 'snapshot_directory_enabled': 'snapshot_directory_enabled', 'source': 'source', 'storage_class': 'storage_class', 'time_remaining': 'time_remaining', 'writable': 'writable'}
- required_args = {}
- swagger_types = {'created': 'int', 'default_group_quota': 'int', 'default_user_quota': 'int', 'destroyed': 'bool', 'fast_remove_directory_enabled': 'bool', 'group_ownership': 'str', 'hard_limit_enabled': 'bool', 'http': 'Http', 'id': 'str', 'multi_protocol': 'MultiProtocol', 'name': 'str', 'nfs': 'NfsPatch', 'promotion_status': 'str', 'provisioned': 'int', 'qos_policy': 'Reference', 'requested_promotion_state': 'str', 'smb': 'Smb', 'snapshot_directory_enabled': 'bool', 'source': 'FixedLocationReference', 'storage_class': 'StorageClassInfo', 'time_remaining': 'int', 'writable': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_performance.FileSystemPerformance(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) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
read_bytes_per_sec (float) – Bytes read per second.
others_per_sec (float) – Other operations processed per second.
reads_per_sec (float) – Read requests processed per second.
write_bytes_per_sec (float) – Bytes written per second.
bytes_per_write (float) – Average write size in bytes per write operation.
usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
writes_per_sec (float) – Write requests processed per second.
time (int) – Sample time in milliseconds since UNIX epoch.
bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).
usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.
bytes_per_read (float) – Average read size in bytes per read operation.
usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
- __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'}
- required_args = {}
- swagger_types = {'bytes_per_op': 'float', 'bytes_per_read': 'float', 'bytes_per_write': 'float', 'id': 'str', 'name': 'str', 'others_per_sec': 'float', 'read_bytes_per_sec': 'float', 'reads_per_sec': 'float', 'time': 'int', 'usec_per_other_op': 'float', 'usec_per_read_op': 'float', 'usec_per_write_op': 'float', 'write_bytes_per_sec': 'float', 'writes_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_performance_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_performance_get_response.FileSystemPerformanceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (list[FileSystemPerformance]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
items (list[FileSystemPerformance]) – A list of file system 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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[FileSystemPerformance]', 'total': 'list[FileSystemPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_post.FileSystemPost(qos_policy=None, smb=None, eradication_config=None, source=None, multi_protocol=None, fast_remove_directory_enabled=None, writable=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_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__(qos_policy=None, smb=None, eradication_config=None, source=None, multi_protocol=None, fast_remove_directory_enabled=None, writable=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_enabled=None)
- Keyword Arguments
qos_policy (Reference) – The QoS policy for the File System defines the performance controls that can be applied to the aggregate performance of all the clients accessing the file system. If no policy is set here, no explicit performance controls are applied to the file system beyond the system’s default fairness.
smb (SmbPost) – SMB configuration.
eradication_config (FileSystemEradicationConfig) –
source (Reference) – The source snapshot whose data is copied to the file system specified.
multi_protocol (MultiProtocolPost) – Multi-protocol configuration.
fast_remove_directory_enabled (bool) – If set to true, the file system, when mounted, will contain a directory that can be used for fast removal of other directories. Directories can be moved into the fast remove directory in order to have them deleted, and their space freed, more quickly than a normal removal operation. If not specified, defaults to false.
writable (bool) – Whether the file system is writable or not. If false, this overrides any protocol or file permission settings and prevents changes. If true, then the protocol and file permission settings are evaluated. If not specified, defaults to true. Modifiable.
hard_limit_enabled (bool) – If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota. If not specified, defaults to false.
provisioned (int) – The provisioned size of the file system, displayed in bytes. If set to an empty string (“”), the file system is unlimited in size. If not specified, defaults to unlimited.
requested_promotion_state (str) – Possible values are promoted and demoted. The demoted state is used for replication targets and is only allowed to be set if the file system is in a replica-link relationship. The additional query param discard-non-snapshotted-data must be set to true when demoting a file system. The default for new file systems is promoted.
default_user_quota (int) – The default space quota for a user writing to this file system.
group_ownership (str) – The group ownership for new files and directories in a file system. Possible values are creator and parent-directory. If creator is selected, the owning group of new files and directories is the primary group of the user who creates them. If parent-directory is selected, the owning group is the parent directory group. Note: Existing files and directories are unaffected by this change. If not specified, defaults to creator.
http (Http) – HTTP configuration.
nfs (Nfs) – NFS configuration.
default_group_quota (int) – The default space quota for a group writing to this file system.
snapshot_directory_enabled (bool) – If set to true, a hidden .snapshot directory will be present in each directory of the file system when it is mounted. The .snapshot directory allows clients read access to the contents of the snapshots that have been taken of a directory. If set to false, the .snapshot directory will not be present in any directories within a mounted file system. If not specified, defaults to true.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'default_group_quota': 'default_group_quota', 'default_user_quota': 'default_user_quota', 'eradication_config': 'eradication_config', 'fast_remove_directory_enabled': 'fast_remove_directory_enabled', 'group_ownership': 'group_ownership', 'hard_limit_enabled': 'hard_limit_enabled', 'http': 'http', 'multi_protocol': 'multi_protocol', 'nfs': 'nfs', 'provisioned': 'provisioned', 'qos_policy': 'qos_policy', 'requested_promotion_state': 'requested_promotion_state', 'smb': 'smb', 'snapshot_directory_enabled': 'snapshot_directory_enabled', 'source': 'source', 'writable': 'writable'}
- required_args = {}
- swagger_types = {'default_group_quota': 'int', 'default_user_quota': 'int', 'eradication_config': 'FileSystemEradicationConfig', 'fast_remove_directory_enabled': 'bool', 'group_ownership': 'str', 'hard_limit_enabled': 'bool', 'http': 'Http', 'multi_protocol': 'MultiProtocolPost', 'nfs': 'Nfs', 'provisioned': 'int', 'qos_policy': 'Reference', 'requested_promotion_state': 'str', 'smb': 'SmbPost', 'snapshot_directory_enabled': 'bool', 'source': 'Reference', 'writable': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_replica_link module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_replica_link.FileSystemReplicaLink(id=None, lag=None, status_details=None, direction=None, context=None, link_type=None, policies=None, recovery_point=None, remote=None, local_file_system=None, remote_file_system=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, lag=None, status_details=None, direction=None, context=None, link_type=None, policies=None, recovery_point=None, remote=None, local_file_system=None, remote_file_system=None, status=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
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.
status_details (str) – Detailed information about the status of the replica link when it is unhealthy.
direction (Direction) –
context (Reference) – 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.
link_type (str) – Type of the replica link. Values include full-replica, and partial-replica.
policies (list[LocationReference]) –
recovery_point (int) – Time when the last replicated snapshot was created, in milliseconds since UNIX epoch. I.e. the recovery point if the file system is promoted.
remote (FixedReferenceNoResourceType) – Reference to a remote array.
local_file_system (FixedReference) – Reference to a local file system.
remote_file_system (FixedReferenceNoResourceType) – Reference to a remote file system.
status (str) – Status of the replica link. Values include replicating, 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', 'link_type': 'link_type', 'local_file_system': 'local_file_system', 'policies': 'policies', 'recovery_point': 'recovery_point', 'remote': 'remote', 'remote_file_system': 'remote_file_system', 'status': 'status', 'status_details': 'status_details'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'direction': 'Direction', 'id': 'str', 'lag': 'int', 'link_type': 'str', 'local_file_system': 'FixedReference', 'policies': 'list[LocationReference]', 'recovery_point': 'int', 'remote': 'FixedReferenceNoResourceType', 'remote_file_system': 'FixedReferenceNoResourceType', 'status': 'str', 'status_details': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_replica_link_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_replica_link_get_response.FileSystemReplicaLinkGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[FileSystemReplicaLink]) – A list of file system 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[FileSystemReplicaLink]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_replica_link_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_replica_link_response.FileSystemReplicaLinkResponse(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[FileSystemReplicaLink]) – A list of file system replica link objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[FileSystemReplicaLink]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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]) – A list of file system objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- 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.flashblade.FB_2_17.models.file_system_snapshot module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_snapshot.FileSystemSnapshot(name=None, id=None, context=None, owner=None, time_remaining=None, destroyed=None, created=None, policies=None, source=None, suffix=None, owner_destroyed=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, context=None, owner=None, time_remaining=None, destroyed=None, created=None, policies=None, source=None, suffix=None, owner_destroyed=None, policy=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
owner (FixedReference) – A reference to the file system that owns this snapshot. If the owner is destroyed, this will be destroyed.
time_remaining (int) – Time in milliseconds before the file system snapshot is eradicated. null if not destroyed.
destroyed (bool) – Is the file system snapshot destroyed? If not specified, defaults to false.
created (int) – Creation timestamp of the object.
policies (list[FixedLocationReference]) – An array of references to the associated policies.
source (FixedLocationReference) – A reference to the file system that was the source of the data in this snapshot. Normally this is the same as the owner, but if the snapshot is replicated, the source is the original file system.
suffix (str) – The suffix of the snapshot, e.g., snap1.
owner_destroyed (bool) – Is the owning file system destroyed?
policy (FixedLocationReference) – A reference to the associated policy that drives the behavior of the snapshot.
- __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', 'owner': 'owner', 'owner_destroyed': 'owner_destroyed', 'policies': 'policies', 'policy': 'policy', 'source': 'source', 'suffix': 'suffix', 'time_remaining': 'time_remaining'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'owner': 'FixedReference', 'owner_destroyed': 'bool', 'policies': 'list[FixedLocationReference]', 'policy': 'FixedLocationReference', 'source': 'FixedLocationReference', 'suffix': 'str', 'time_remaining': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_snapshot_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_snapshot_get_response.FileSystemSnapshotGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[FileSystemSnapshot]) – A list of file system snapshot objects.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (FileSystemSnapshot) – If total_only query param is true, then it will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.
- __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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[FileSystemSnapshot]', 'total': 'FileSystemSnapshot', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_snapshot_get_transfer_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_snapshot_get_transfer_response.FileSystemSnapshotGetTransferResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[FileSystemSnapshotTransfer]) – A list of file system snapshot objects.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
total (FileSystemSnapshotTransfer) – If total_only query param is true, then it will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.
- __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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[FileSystemSnapshotTransfer]', 'total': 'FileSystemSnapshotTransfer', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_snapshot_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_snapshot_post.FileSystemSnapshotPost(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 of the snapshot, e.g., snap1.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'suffix': 'suffix'}
- 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.flashblade.FB_2_17.models.file_system_snapshot_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_snapshot_response.FileSystemSnapshotResponse(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[FileSystemSnapshot]) – A list of file system snapshot objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[FileSystemSnapshot]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_snapshot_transfer module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_snapshot_transfer.FileSystemSnapshotTransfer(name=None, id=None, context=None, data_transferred=None, progress=None, started=None, completed=None, remote=None, remote_snapshot=None, direction=None, local_snapshot=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, data_transferred=None, progress=None, started=None, completed=None, remote=None, remote_snapshot=None, direction=None, local_snapshot=None, status=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
data_transferred (int) – The amount of data transferred to the target, in bytes.
progress (float) – A percentage that indicates how much progress has been made on the transfer.
started (int) – A timestamp at which the replication of the snapshot started.
completed (int) – A timestamp at which the replication of the snapshot completed.
remote (FixedReferenceNoResourceType) – The array where the remote file system snapshot is located.
remote_snapshot (FixedReferenceNoResourceType) – A reference to the associated remote file system snapshot.
direction (Direction) –
local_snapshot (FixedReferenceNoResourceType) – A reference to the associated local file system snapshot.
status (str) – The status of current replication. Valid values are completed, in-progress, and queued.
- __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', 'direction': 'direction', 'id': 'id', 'local_snapshot': 'local_snapshot', 'name': 'name', 'progress': 'progress', 'remote': 'remote', 'remote_snapshot': 'remote_snapshot', 'started': 'started', 'status': 'status'}
- required_args = {}
- swagger_types = {'completed': 'int', 'context': 'Reference', 'data_transferred': 'int', 'direction': 'Direction', 'id': 'str', 'local_snapshot': 'FixedReferenceNoResourceType', 'name': 'str', 'progress': 'float', 'remote': 'FixedReferenceNoResourceType', 'remote_snapshot': 'FixedReferenceNoResourceType', 'started': 'int', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_snapshot_transfer_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_snapshot_transfer_response.FileSystemSnapshotTransferResponse(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[FileSystemSnapshotTransfer]) – A list of file system snapshot objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[FileSystemSnapshotTransfer]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_user_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_user_performance.FileSystemUserPerformance(name=None, read_bytes_per_sec=None, others_per_sec=None, write_bytes_per_sec=None, usec_per_other_op=None, bytes_per_op=None, bytes_per_read=None, usec_per_read_op=None, file_system=None, reads_per_sec=None, bytes_per_write=None, writes_per_sec=None, time=None, usec_per_write_op=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, read_bytes_per_sec=None, others_per_sec=None, write_bytes_per_sec=None, usec_per_other_op=None, bytes_per_op=None, bytes_per_read=None, usec_per_read_op=None, file_system=None, reads_per_sec=None, bytes_per_write=None, writes_per_sec=None, time=None, usec_per_write_op=None, user=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
read_bytes_per_sec (float) – Bytes read per second.
others_per_sec (float) – Other operations processed per second.
write_bytes_per_sec (float) – Bytes written per second.
usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).
bytes_per_read (float) – Average read size in bytes per read operation.
usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
file_system (FixedReference) – The file system on which the performance was measured.
reads_per_sec (float) – Read requests processed per second.
bytes_per_write (float) – Average write size in bytes per write operation.
writes_per_sec (float) – Write requests processed per second.
time (int) – Sample time in milliseconds since UNIX epoch.
usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.
user (User) – The user whose performance is represented.
- __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', 'file_system': 'file_system', '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', 'user': 'user', 'write_bytes_per_sec': 'write_bytes_per_sec', 'writes_per_sec': 'writes_per_sec'}
- required_args = {}
- swagger_types = {'bytes_per_op': 'float', 'bytes_per_read': 'float', 'bytes_per_write': 'float', 'file_system': 'FixedReference', 'name': 'str', 'others_per_sec': 'float', 'read_bytes_per_sec': 'float', 'reads_per_sec': 'float', 'time': 'int', 'usec_per_other_op': 'float', 'usec_per_read_op': 'float', 'usec_per_write_op': 'float', 'user': 'User', 'write_bytes_per_sec': 'float', 'writes_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.file_system_users_performance_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.file_system_users_performance_get_response.FileSystemUsersPerformanceGetResponse(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[FileSystemUserPerformance]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
items (list[FileSystemUserPerformance]) – A list of file system user performance objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items', 'total': 'total'}
- required_args = {}
- swagger_types = {'items': 'list[FileSystemUserPerformance]', 'total': 'list[FileSystemUserPerformance]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.fixed_location_reference module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fixed_location_reference.FixedLocationReference(name=None, resource_type=None, id=None, location=None, display_name=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, resource_type=None, id=None, location=None, display_name=None, is_local=None)
- Keyword Arguments
name (str) –
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 file system would have a resource_type of file-systems.
id (str) – A non-modifiable, globally unique ID chosen by the system.
location (FixedReference) – A reference to the location where the object is defined.
display_name (str) – Full name of the source with remote array information. Response will be same as source name for local file systems and policies.
is_local (bool) – Is the location reference to the local array or somewhere remote?
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'display_name': 'display_name', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'resource_type': 'resource_type'}
- required_args = {}
- swagger_types = {'display_name': 'str', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.fixed_reference module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fixed_reference.FixedReference(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) –
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 file system would have a resource_type of file-systems.
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', 'name': 'name', 'resource_type': 'resource_type'}
- 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.flashblade.FB_2_17.models.fixed_reference_name_only module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fixed_reference_name_only.FixedReferenceNameOnly(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) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- 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.flashblade.FB_2_17.models.fixed_reference_no_id module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fixed_reference_no_id.FixedReferenceNoId(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) –
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 file system would have a resource_type of file-systems.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'resource_type': 'resource_type'}
- 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.flashblade.FB_2_17.models.fixed_reference_no_resource_type module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fixed_reference_no_resource_type.FixedReferenceNoResourceType(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) –
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', 'name': 'name'}
- 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.flashblade.FB_2_17.models.fixed_reference_with_is_local module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fixed_reference_with_is_local.FixedReferenceWithIsLocal(name=None, resource_type=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, resource_type=None, id=None, is_local=None)
- Keyword Arguments
name (str) –
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 file system would have a resource_type of file-systems.
id (str) – A non-modifiable, globally unique ID chosen by the system.
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', 'resource_type': 'resource_type'}
- 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.flashblade.FB_2_17.models.fixed_reference_with_remote module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fixed_reference_with_remote.FixedReferenceWithRemote(name=None, resource_type=None, id=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, resource_type=None, id=None, remote=None)
- Keyword Arguments
name (str) –
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 file system would have a resource_type of file-systems.
id (str) – A non-modifiable, globally unique ID chosen by the system.
remote (FixedReferenceNoResourceType) – The remote field of the corresponding array connection.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'remote': 'remote', 'resource_type': 'resource_type'}
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'remote': 'FixedReferenceNoResourceType', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.fixed_reference_with_type module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fixed_reference_with_type.FixedReferenceWithType(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) –
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.
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', 'name': 'name', 'resource_type': 'resource_type'}
- 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.flashblade.FB_2_17.models.fleet module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
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'}
- 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.flashblade.FB_2_17.models.fleet_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fleet_get_response.FleetGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Fleet]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.fleet_key module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.fleet_key_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fleet_key_get_response.FleetKeyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[FleetKey]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.fleet_key_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.fleet_member module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 (FixedReferenceWithIsLocal) –
member (FixedReferenceWithIsLocal) –
status_details (str) – Describes the error, if any.
status (str) – Current fleet membership status. Valid values include: 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'}
- required_args = {}
- swagger_types = {'fleet': 'FixedReferenceWithIsLocal', 'member': 'FixedReferenceWithIsLocal', 'status': 'str', 'status_details': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.fleet_member_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fleet_member_get_response.FleetMemberGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[FleetMember]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.fleet_member_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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]) – Info 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'}
- 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.flashblade.FB_2_17.models.fleet_member_post_members module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fleet_member_post_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 (FleetMemberPostMembersMember) –
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'}
- required_args = {}
- swagger_types = {'key': 'str', 'member': 'FleetMemberPostMembersMember'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.fleet_member_post_members_member module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.fleet_member_post_members_member.FleetMemberPostMembersMember(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'}
- 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.flashblade.FB_2_17.models.fleet_member_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.fleet_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.fleet_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.group module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.group.Group(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 group name that represents the group’s identity, and which resolves to the group’s id in a configured directory service.
id (int) – The numeric group id that represents the group’s identity in a POSIX system.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'id': 'int', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.group_quota module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.group_quota.GroupQuota(name=None, context=None, file_system=None, quota=None, usage=None, file_system_default_quota=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, context=None, file_system=None, quota=None, usage=None, file_system_default_quota=None, group=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
context (Reference) – 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.
file_system (FixedReference) –
quota (int) – The space limit of the quota (in bytes) for the specified group, cannot be 0. If specified, this value will override the file system’s default group quota.
usage (int) – The usage of the file system (in bytes) by the specified group.
file_system_default_quota (int) – File system’s default group quota (in bytes). If it is 0, it means there is no default quota. This will be the effective group quota if the group doesn’t have an individual quota. This default quota is set through the file-systems endpoint.
group (Group) – The group on which this quota is enforced.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'file_system': 'file_system', 'file_system_default_quota': 'file_system_default_quota', 'group': 'group', 'name': 'name', 'quota': 'quota', 'usage': 'usage'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'file_system': 'FixedReference', 'file_system_default_quota': 'int', 'group': 'Group', 'name': 'str', 'quota': 'int', 'usage': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.group_quota_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.group_quota_get_response.GroupQuotaGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[GroupQuota]) – A list of quota 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[GroupQuota]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.group_quota_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.group_quota_patch.GroupQuotaPatch(quota, 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__(quota, name=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
quota (int, required) – The space limit of the quota (in bytes) for the specified group, cannot be 0. If specified, this value will override the file system’s default group quota.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'quota': 'quota'}
- required_args = {'quota'}
- swagger_types = {'name': 'str', 'quota': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.group_quota_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.group_quota_post.GroupQuotaPost(quota, 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__(quota, name=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
quota (int, required) – The space limit of the quota (in bytes) for the specified group, cannot be 0. If specified, this value will override the file system’s default group quota.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'quota': 'quota'}
- required_args = {'quota'}
- swagger_types = {'name': 'str', 'quota': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.group_quota_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.group_quota_response.GroupQuotaResponse(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[GroupQuota]) – A list of quota objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[GroupQuota]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.hardware module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.hardware.Hardware(name=None, id=None, management_mac=None, index=None, slot=None, type=None, speed=None, identify_enabled=None, serial=None, temperature=None, part_number=None, details=None, model=None, data_mac=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, management_mac=None, index=None, slot=None, type=None, speed=None, identify_enabled=None, serial=None, temperature=None, part_number=None, details=None, model=None, data_mac=None, status=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
management_mac (str) – Hardware component (burned-in) MAC address
index (int) – Number that identifies the relative position of a hardware component within the array.
slot (int) – Slot number occupied by the PCI Express card that hosts the component.
type (str) – Type of hardware component. Valid values are bay, ch, eth, fan, fb, fm, pwr, and xfm.
speed (int) – The maximum speed (in b/s) at which the component is capable of operating.
identify_enabled (bool) – State of an LED used to visually identify the component.
serial (str) – Serial number of the hardware component.
temperature (int) – Temperature (in degrees celsius) reported by the component.
part_number (str) – Part number of the hardware component.
details (str) – Details about the status of the component if not healthy.
model (str) – Model number of the hardware component.
data_mac (str) – Ethernet (data) MAC address
status (str) – Component status. Valid values are critical, healthy, identifying, unhealthy, unknown, and unused.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'data_mac': 'data_mac', 'details': 'details', 'id': 'id', 'identify_enabled': 'identify_enabled', 'index': 'index', 'management_mac': 'management_mac', 'model': 'model', 'name': 'name', 'part_number': 'part_number', 'serial': 'serial', 'slot': 'slot', 'speed': 'speed', 'status': 'status', 'temperature': 'temperature', 'type': 'type'}
- required_args = {}
- swagger_types = {'data_mac': 'str', 'details': 'str', 'id': 'str', 'identify_enabled': 'bool', 'index': 'int', 'management_mac': 'str', 'model': 'str', 'name': 'str', 'part_number': 'str', 'serial': 'str', 'slot': 'int', 'speed': 'int', 'status': 'str', 'temperature': 'int', 'type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.hardware_connector module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.hardware_connector.HardwareConnector(name=None, id=None, lane_speed=None, port_speed=None, transceiver_type=None, connector_type=None, port_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__(name=None, id=None, lane_speed=None, port_speed=None, transceiver_type=None, connector_type=None, port_count=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
lane_speed (int) – Configured speed of each lane in the connector in bits-per-second.
port_speed (int) – Configured speed of each port in the connector in bits-per-second.
transceiver_type (str) – Details about the transceiver which is plugged into the connector port. Transceiver type will be read-only for pureuser. If nothing is plugged into QSFP port, value will be Unused and type cannot be auto-detected, and internal user has not specified a type - value will be Unknown. If transceiver is plugged in, and type is auto-detected, and/or type has been explicitly set by internal user - that value will be shown. Transceiver type is not applicable for RJ-45 connectors.
connector_type (str) – Form-factor of the interface. Valid values include QSFP and RJ-45.
port_count (int) – Configured number of ports in the connector (1/2/4 for QSFP).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'connector_type': 'connector_type', 'id': 'id', 'lane_speed': 'lane_speed', 'name': 'name', 'port_count': 'port_count', 'port_speed': 'port_speed', 'transceiver_type': 'transceiver_type'}
- required_args = {}
- swagger_types = {'connector_type': 'str', 'id': 'str', 'lane_speed': 'int', 'name': 'str', 'port_count': 'int', 'port_speed': 'int', 'transceiver_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.hardware_connector_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.hardware_connector_get_response.HardwareConnectorGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[HardwareConnector]) – A list of connector objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[HardwareConnector]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.hardware_connector_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.hardware_connector_performance.HardwareConnectorPerformance(name=None, id=None, link_aggregation_group=None, received_crc_errors_per_sec=None, transmitted_dropped_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_carrier_errors_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, time=None, total_errors_per_sec=None, received_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__(name=None, id=None, link_aggregation_group=None, received_crc_errors_per_sec=None, transmitted_dropped_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_carrier_errors_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, time=None, total_errors_per_sec=None, received_packets_per_sec=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
link_aggregation_group (FixedReference) – The link aggregation group which this entity belongs to.
received_crc_errors_per_sec (int) – Reception CRC errors per second.
transmitted_dropped_errors_per_sec (int) – Transmitted packets dropped per second.
transmitted_packets_per_sec (int) – Packets transmitted per second.
transmitted_carrier_errors_per_sec (int) – Transmission carrier errors per second.
transmitted_bytes_per_sec (int) – Bytes transmitted per second.
received_bytes_per_sec (int) – Bytes received per second.
received_frame_errors_per_sec (int) – Received packet frame errors per second.
other_errors_per_sec (int) – The sum of unspecified reception and transmission errors per second.
time (int) – Sample time in milliseconds since UNIX epoch.
total_errors_per_sec (int) – The sum of all reception and transmission errors per second.
received_packets_per_sec (int) – Packets received per second.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'link_aggregation_group': 'link_aggregation_group', 'name': 'name', 'other_errors_per_sec': 'other_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', 'time': 'time', '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'}
- required_args = {}
- swagger_types = {'id': 'str', 'link_aggregation_group': 'FixedReference', 'name': 'str', 'other_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', 'time': '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.flashblade.FB_2_17.models.hardware_connector_performance_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.hardware_connector_performance_get_response.HardwareConnectorPerformanceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (list[HardwareConnectorPerformance]) – Total of all records after filtering. If total_only query param is true, then no individual items will be returned.
items (list[HardwareConnectorPerformance]) – A list of hardware connector 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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[HardwareConnectorPerformance]', 'total': 'list[HardwareConnectorPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.hardware_connector_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.hardware_connector_response.HardwareConnectorResponse(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[HardwareConnector]) – A list of connector objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[HardwareConnector]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.hardware_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.hardware_get_response.HardwareGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Hardware]) – A list of hardware component objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Hardware]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.hardware_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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
- __init__(items=None)
- Keyword Arguments
items (list[Hardware]) – A list of hardware component objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- 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.flashblade.FB_2_17.models.http module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.http.Http(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) – Is the protocol enabled? If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled'}
- 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.flashblade.FB_2_17.models.index module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.index.Index(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__(index=None)
- Keyword Arguments
index (int) – Index of the object in the containing array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'index': 'index'}
- required_args = {}
- swagger_types = {'index': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.inline_response400 module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.inline_response401 module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.keytab module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.keytab.Keytab(name=None, id=None, encryption_type=None, principal=None, server=None, fqdn=None, prefix=None, realm=None, source=None, suffix=None, kvno=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, encryption_type=None, principal=None, server=None, fqdn=None, prefix=None, realm=None, source=None, suffix=None, kvno=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
encryption_type (str) – The encryption type used by the Kerberos key distribution center to generate the keytab.
principal (str) – The service name for which the keytab was issued.
server (FixedReference) – The server where the keytab is used.
fqdn (str) – The fully qualified domain name to which the keytab was issued.
prefix (str) – The prefix in the name of the keytab object. This is the same for all keytab objects created from a single keytab file. The name of a keytab entry is created in the format <prefix>.<suffix> for all entries.
realm (str) – The Kerberos realm that issued the keytab.
source (FixedReference) – A reference to the Active Directory configuration for the computer account that was used to create this keytab. If this keytab was uploaded from a file, all fields in the reference possess null values.
suffix (int) – The suffix in the name of the keytab object, determined at creation time using the slot number of the keytab entry in a file and the number of existing entries with the same prefix. The name of a keytab entry is created in the format <prefix>.<suffix> for all entries.
kvno (int) – The key version number of the key used to generate the keytab.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'encryption_type': 'encryption_type', 'fqdn': 'fqdn', 'id': 'id', 'kvno': 'kvno', 'name': 'name', 'prefix': 'prefix', 'principal': 'principal', 'realm': 'realm', 'server': 'server', 'source': 'source', 'suffix': 'suffix'}
- required_args = {}
- swagger_types = {'encryption_type': 'str', 'fqdn': 'str', 'id': 'str', 'kvno': 'int', 'name': 'str', 'prefix': 'str', 'principal': 'str', 'realm': 'str', 'server': 'FixedReference', 'source': 'FixedReference', 'suffix': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.keytab_file_base64 module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.keytab_file_base64.KeytabFileBase64
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__()
Keyword args:
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {}
- required_args = {}
- swagger_types = {}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.keytab_file_binary module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.keytab_file_binary.KeytabFileBinary
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__()
Keyword args:
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {}
- required_args = {}
- swagger_types = {}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.keytab_file_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.keytab_file_response.KeytabFileResponse
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__()
Keyword args:
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {}
- required_args = {}
- swagger_types = {}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.keytab_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.keytab_get_response.KeytabGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Keytab]) – A list of Kerberos keytab objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Keytab]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.keytab_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.keytab_post.KeytabPost(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 (Reference) – A reference to the Active Directory configuration for the computer account whose keys will be rotated in order to create new keytabs for all of its registered service principal names.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'source': 'source'}
- required_args = {}
- swagger_types = {'source': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.keytab_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.keytab_response.KeytabResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[Keytab]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.kmip_server module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.kmip_server.KmipServer(name=None, id=None, ca_certificate=None, uris=None, ca_certificate_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, id=None, ca_certificate=None, uris=None, ca_certificate_group=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
ca_certificate (Reference) – CA certificate used to validate the authenticity of the configured servers.
uris (list[str]) – List of URIs for the configured KMIP servers in the format [protocol://]hostname:port.
ca_certificate_group (Reference) – A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers.
- __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', 'id': 'id', 'name': 'name', 'uris': 'uris'}
- required_args = {}
- swagger_types = {'ca_certificate': 'Reference', 'ca_certificate_group': 'Reference', 'id': 'str', 'name': 'str', 'uris': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.kmip_server_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.kmip_server_response.KmipServerResponse(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[KmipServer]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[KmipServer]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.legal_hold module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.legal_hold.LegalHold(name=None, id=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__(name=None, id=None, description=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
description (str) – The description of the legal hold instance.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'description': 'description', 'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'description': 'str', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.legal_hold_held_entity module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.legal_hold_held_entity.LegalHoldHeldEntity(path=None, file_system=None, legal_hold=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__(path=None, file_system=None, legal_hold=None, status=None)
- Keyword Arguments
path (str) – The path of the file or directory being held.
file_system (FixedReference) – Reference to the file system that the legal hold is applied to.
legal_hold (FixedReference) – Reference to the legal hold.
status (str) – The status of the legal hold with respect to the held entity. Valid values include: applied for holds that are actively applied, applying for holds that are being recursively applied but have not yet completed, releasing for holds that are being released recursively but have not yet completed. Entities that are releasing will no longer be held once this operation completes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'file_system': 'file_system', 'legal_hold': 'legal_hold', 'path': 'path', 'status': 'status'}
- required_args = {}
- swagger_types = {'file_system': 'FixedReference', 'legal_hold': 'FixedReference', 'path': 'str', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.legal_holds_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.legal_holds_get_response.LegalHoldsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[LegalHold]) – A list of legal hold instances.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[LegalHold]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.legal_holds_held_entities_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.legal_holds_held_entities_get_response.LegalHoldsHeldEntitiesGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[LegalHoldHeldEntity]) – A list of held entities for legal holds.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[LegalHoldHeldEntity]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.legal_holds_held_entities_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.legal_holds_held_entities_response.LegalHoldsHeldEntitiesResponse(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[LegalHoldHeldEntity]) – A list of held entities for legal holds.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[LegalHoldHeldEntity]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.legal_holds_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.legal_holds_response.LegalHoldsResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[LegalHold]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.lifecycle_rule module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.lifecycle_rule.LifecycleRule(name=None, id=None, context=None, keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, bucket=None, rule_id=None, prefix=None, keep_previous_version_for=None, enabled=None, cleanup_expired_object_delete_marker=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, bucket=None, rule_id=None, prefix=None, keep_previous_version_for=None, enabled=None, cleanup_expired_object_delete_marker=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
keep_current_version_until (int) – Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.
abort_incomplete_multipart_uploads_after (int) – Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
keep_current_version_for (int) – Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
bucket (FixedReference) – The bucket which this lifecycle rule is targeting.
rule_id (str) – Unique identifier for the rule. Can have a maximum length of 255 characters.
prefix (str) – Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.
keep_previous_version_for (int) – Time after which previous versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
enabled (bool) – If set to true, this rule will be enabled.
cleanup_expired_object_delete_marker (bool) – Returns a value of true if the expired object delete markers will be removed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'abort_incomplete_multipart_uploads_after': 'abort_incomplete_multipart_uploads_after', 'bucket': 'bucket', 'cleanup_expired_object_delete_marker': 'cleanup_expired_object_delete_marker', 'context': 'context', 'enabled': 'enabled', 'id': 'id', 'keep_current_version_for': 'keep_current_version_for', 'keep_current_version_until': 'keep_current_version_until', 'keep_previous_version_for': 'keep_previous_version_for', 'name': 'name', 'prefix': 'prefix', 'rule_id': 'rule_id'}
- required_args = {}
- swagger_types = {'abort_incomplete_multipart_uploads_after': 'int', 'bucket': 'FixedReference', 'cleanup_expired_object_delete_marker': 'bool', 'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'keep_current_version_for': 'int', 'keep_current_version_until': 'int', 'keep_previous_version_for': 'int', 'name': 'str', 'prefix': 'str', 'rule_id': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.lifecycle_rule_config_extension module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.lifecycle_rule_config_extension.LifecycleRuleConfigExtension(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None)
- Keyword Arguments
keep_current_version_until (int) – Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.
abort_incomplete_multipart_uploads_after (int) – Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
keep_current_version_for (int) – Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'abort_incomplete_multipart_uploads_after': 'abort_incomplete_multipart_uploads_after', 'keep_current_version_for': 'keep_current_version_for', 'keep_current_version_until': 'keep_current_version_until'}
- required_args = {}
- swagger_types = {'abort_incomplete_multipart_uploads_after': 'int', 'keep_current_version_for': 'int', 'keep_current_version_until': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.lifecycle_rule_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.lifecycle_rule_get_response.LifecycleRuleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[LifecycleRule]) – A list of lifecycle rule 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[LifecycleRule]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.lifecycle_rule_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.lifecycle_rule_patch.LifecycleRulePatch(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, prefix=None, keep_previous_version_for=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__(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, prefix=None, keep_previous_version_for=None, enabled=None)
- Keyword Arguments
keep_current_version_until (int) – Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.
abort_incomplete_multipart_uploads_after (int) – Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
keep_current_version_for (int) – Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
prefix (str) – Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.
keep_previous_version_for (int) – Time after which previous versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
enabled (bool) – If set to true, this rule will be enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'abort_incomplete_multipart_uploads_after': 'abort_incomplete_multipart_uploads_after', 'enabled': 'enabled', 'keep_current_version_for': 'keep_current_version_for', 'keep_current_version_until': 'keep_current_version_until', 'keep_previous_version_for': 'keep_previous_version_for', 'prefix': 'prefix'}
- required_args = {}
- swagger_types = {'abort_incomplete_multipart_uploads_after': 'int', 'enabled': 'bool', 'keep_current_version_for': 'int', 'keep_current_version_until': 'int', 'keep_previous_version_for': 'int', 'prefix': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.lifecycle_rule_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.lifecycle_rule_post.LifecycleRulePost(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, bucket=None, rule_id=None, prefix=None, keep_previous_version_for=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, bucket=None, rule_id=None, prefix=None, keep_previous_version_for=None)
- Keyword Arguments
keep_current_version_until (int) – Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.
abort_incomplete_multipart_uploads_after (int) – Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
keep_current_version_for (int) – Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
bucket (ReferenceWritable) – The bucket name for lifecycle rule creation.
rule_id (str) – Identifier for the rule that is unique to the bucket that it applies to. Can have a maximum length of 255 characters. If not specified, an id unique to the bucket will be generated in the format fbRuleId<number> where number increments, starting at 1.
prefix (str) – Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.
keep_previous_version_for (int) – Time after which previous versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'abort_incomplete_multipart_uploads_after': 'abort_incomplete_multipart_uploads_after', 'bucket': 'bucket', 'keep_current_version_for': 'keep_current_version_for', 'keep_current_version_until': 'keep_current_version_until', 'keep_previous_version_for': 'keep_previous_version_for', 'prefix': 'prefix', 'rule_id': 'rule_id'}
- required_args = {}
- swagger_types = {'abort_incomplete_multipart_uploads_after': 'int', 'bucket': 'ReferenceWritable', 'keep_current_version_for': 'int', 'keep_current_version_until': 'int', 'keep_previous_version_for': 'int', 'prefix': 'str', 'rule_id': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.lifecycle_rule_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.lifecycle_rule_response.LifecycleRuleResponse(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[LifecycleRule]) – A list of lifecycle rule objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[LifecycleRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.link_aggregation_group module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.link_aggregation_group.LinkAggregationGroup(name=None, id=None, lag_speed=None, port_speed=None, mac_address=None, ports=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, lag_speed=None, port_speed=None, mac_address=None, ports=None, status=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
lag_speed (int) – Combined speed of all ports in the LAG in bits-per-second.
port_speed (int) – Configured speed of each port in the LAG in bits-per-second.
mac_address (str) – Unique MAC address assigned to the LAG.
ports (list[FixedReference]) – Ports associated with the LAG.
status (str) – Health status of the LAG. Valid values are critical, healthy, identifying, unclaimed, unhealthy, unrecognized, and unused.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'lag_speed': 'lag_speed', 'mac_address': 'mac_address', 'name': 'name', 'port_speed': 'port_speed', 'ports': 'ports', 'status': 'status'}
- required_args = {}
- swagger_types = {'id': 'str', 'lag_speed': 'int', 'mac_address': 'str', 'name': 'str', 'port_speed': 'int', 'ports': 'list[FixedReference]', 'status': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.link_aggregation_group_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.link_aggregation_group_get_response.LinkAggregationGroupGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[LinkAggregationGroup]) – A list of lag objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[LinkAggregationGroup]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.link_aggregation_group_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.link_aggregation_group_response.LinkAggregationGroupResponse(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[LinkAggregationGroup]) – A list of lag objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[LinkAggregationGroup]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.linkaggregationgroup module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.linkaggregationgroup.Linkaggregationgroup(remove_ports=None, add_ports=None, ports=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(remove_ports=None, add_ports=None, ports=None)
- Keyword Arguments
remove_ports (list[FixedReference]) –
add_ports (list[FixedReference]) –
ports (list[FixedReference]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'add_ports': 'add_ports', 'ports': 'ports', 'remove_ports': 'remove_ports'}
- required_args = {}
- swagger_types = {'add_ports': 'list[FixedReference]', 'ports': 'list[FixedReference]', 'remove_ports': 'list[FixedReference]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.location_reference module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.location_reference.LocationReference(name=None, resource_type=None, id=None, location=None, display_name=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, resource_type=None, id=None, location=None, display_name=None, is_local=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
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 file system would have a resource_type of file-systems.
id (str) – A non-modifiable, globally unique ID chosen by the system.
location (Reference) – A reference to the location where the object is defined.
display_name (str) – Full name of the source with remote array information. Response will be same as source name for local file systems and policies.
is_local (bool) – Is the location reference to the local array or somewhere remote?
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'display_name': 'display_name', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'resource_type': 'resource_type'}
- required_args = {}
- swagger_types = {'display_name': 'str', 'id': 'str', 'is_local': 'bool', 'location': 'Reference', 'name': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.login module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.login.Login(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'}
- 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.flashblade.FB_2_17.models.logs_async module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.logs_async.LogsAsync(name=None, id=None, available_files=None, start_time=None, end_time=None, processing=None, progress=None, hardware_components=None, last_request_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, available_files=None, start_time=None, end_time=None, processing=None, progress=None, hardware_components=None, last_request_time=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
available_files (list[FileInfo]) – All of the available files ready for download.
start_time (int) – When the time window starts (in milliseconds since epoch). start_time and end_time determine the number of hours for which the logs are prepared for. At most 6 hours of logs can be prepared in one request. start_time and end_time are truncated to hour boundaries.
end_time (int) – When the time window ends (in milliseconds since epoch). start_time and end_time determine the number of hours for which the logs are prepared for. At most 6 hours of logs can be prepared in one request. start_time and end_time are truncated to hour boundaries.
processing (bool) – Returns a value of true if the logs are being prepared.
progress (float) – A representation of log preparation progress. Ranges from 0 to 1.0.
hardware_components (list[FixedReference]) – All of the hardware components for which logs are being processed.
last_request_time (int) – The last time log preparation was requested (in milliseconds since epoch).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'available_files': 'available_files', 'end_time': 'end_time', 'hardware_components': 'hardware_components', 'id': 'id', 'last_request_time': 'last_request_time', 'name': 'name', 'processing': 'processing', 'progress': 'progress', 'start_time': 'start_time'}
- required_args = {}
- swagger_types = {'available_files': 'list[FileInfo]', 'end_time': 'int', 'hardware_components': 'list[FixedReference]', 'id': 'str', 'last_request_time': 'int', 'name': 'str', 'processing': 'bool', 'progress': 'float', 'start_time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.logs_async_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.logs_async_get_response.LogsAsyncGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[LogsAsync]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[LogsAsync]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.logs_async_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.logs_async_response.LogsAsyncResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[LogsAsync]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.maintenance_window module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.maintenance_window.MaintenanceWindow(name=None, id=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, id=None, expires=None, created=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
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', 'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'created': 'int', 'expires': 'int', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.maintenance_window_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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) – Duration of a maintenance window measured in milliseconds. The names and timeout parameters must be set together, and the names parameter must be set to array.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'timeout': 'timeout'}
- 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.flashblade.FB_2_17.models.maintenance_windows_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.maintenance_windows_get_response.MaintenanceWindowsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[MaintenanceWindow]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.maintenance_windows_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.member module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.member.Member(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)
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'group': 'group', 'member': 'member'}
- required_args = {}
- swagger_types = {'group': 'Reference', 'member': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.member_link module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.member_link.MemberLink(remote=None, local_file_system=None, remote_file_system=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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=None, local_file_system=None, remote_file_system=None)
- Keyword Arguments
remote (FixedReferenceNoResourceType) – Reference to a remote array.
local_file_system (FixedReference) – Reference to a local file system.
remote_file_system (FixedReferenceNoResourceType) – Reference to a remote file system.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'local_file_system': 'local_file_system', 'remote': 'remote', 'remote_file_system': 'remote_file_system'}
- required_args = {}
- swagger_types = {'local_file_system': 'FixedReference', 'remote': 'FixedReferenceNoResourceType', 'remote_file_system': 'FixedReferenceNoResourceType'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.multi_protocol module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.multi_protocol.MultiProtocol(safeguard_acls=None, access_control_style=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(safeguard_acls=None, access_control_style=None)
- Keyword Arguments
safeguard_acls (bool) – If set to true, prevents NFS clients from erasing a configured ACL when setting NFS mode bits. If this is true, then attempts to set mode bits on a file or directory will fail if they cannot be combined with the existing ACL set on a file or directory without erasing the ACL. Attempts to set mode bits that would not erase an existing ACL will still succeed and the mode bit changes will be merged with the existing ACL. This must be false when access_control_style is set to either independent or mode-bits.
access_control_style (str) – The access control style that is utilized for client actions such as setting file and directory ACLs. Possible values include nfs, smb, shared, independent, and mode-bits. If nfs is specified, then SMB clients will be unable to set permissions on files and directories. If smb is specified, then NFS clients will be unable to set permissions on files and directories. If shared is specified, then NFS and SMB clients will both be able to set permissions on files and directories. Any client will be able to overwrite the permissions set by another client, regardless of protocol. If independent is specified, then NFS and SMB clients will both be able to set permissions on files and directories, and can access files and directories created over any protocol. Permissions set by SMB clients will not affect NFS clients and vice versa. NFS clients will be restricted to only using mode bits to set permissions. If mode-bits is specified, then NFS and SMB clients will both be able to set permissions on files and directories, but only mode bits may be used to set permissions for NFS clients. When SMB clients set an ACL, it will be converted to have the same permission granularity as NFS mode bits.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_control_style': 'access_control_style', 'safeguard_acls': 'safeguard_acls'}
- required_args = {}
- swagger_types = {'access_control_style': 'str', 'safeguard_acls': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.multi_protocol_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.multi_protocol_post.MultiProtocolPost(safeguard_acls=None, access_control_style=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(safeguard_acls=None, access_control_style=None)
- Keyword Arguments
safeguard_acls (bool) – If set to true, prevents NFS clients from erasing a configured ACL when setting NFS mode bits. If this is true, then attempts to set mode bits on a file or directory will fail if they cannot be combined with the existing ACL set on a file or directory without erasing the ACL. Attempts to set mode bits that would not erase an existing ACL will still succeed and the mode bit changes will be merged with the existing ACL. This must be false when access_control_style is set to either independent or mode-bits. Defaults to true.
access_control_style (str) – The access control style that is utilized for client actions such as setting file and directory ACLs. Possible values include nfs, smb, shared, independent, and mode-bits. If nfs is specified, then SMB clients will be unable to set permissions on files and directories. If smb is specified, then NFS clients will be unable to set permissions on files and directories. If shared is specified, then NFS and SMB clients will both be able to set permissions on files and directories. Any client will be able to overwrite the permissions set by another client, regardless of protocol. If independent is specified, then NFS and SMB clients will both be able to set permissions on files and directories, and can access files and directories created over any protocol. Permissions set by SMB clients will not affect NFS clients and vice versa. NFS clients will be restricted to only using mode bits to set permissions. If mode-bits is specified, then NFS and SMB clients will both be able to set permissions on files and directories, but only mode bits may be used to set permissions for NFS clients. When SMB clients set an ACL, it will be converted to have the same permission granularity as NFS mode bits. Defaults to shared.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_control_style': 'access_control_style', 'safeguard_acls': 'safeguard_acls'}
- required_args = {}
- swagger_types = {'access_control_style': 'str', 'safeguard_acls': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy.NetworkAccessPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, rules=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
version (str) – A hash of the other properties of this resource. This can be used when updating the resource to ensure there aren’t any updates since the resource was read.
rules (list[NetworkAccessPolicyRuleInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order. If a client does not match any rule in the policy for the interface that they are attempting to access, the default is to deny access.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'rules': 'rules', 'version': 'version'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'rules': 'list[NetworkAccessPolicyRuleInPolicy]', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy_get_response.NetworkAccessPolicyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[NetworkAccessPolicy]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkAccessPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy_response.NetworkAccessPolicyResponse(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[NetworkAccessPolicy]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[NetworkAccessPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy_rule module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy_rule.NetworkAccessPolicyRule(name=None, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=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, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=None, index=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.
interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.
effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny.
client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.
policy (FixedReference) – The policy to which this rule belongs.
index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'effect': 'effect', 'id': 'id', 'index': 'index', 'interfaces': 'interfaces', 'name': 'name', 'policy': 'policy', 'policy_version': 'policy_version'}
- required_args = {}
- swagger_types = {'client': 'str', 'effect': 'str', 'id': 'str', 'index': 'int', 'interfaces': 'list[str]', 'name': 'str', 'policy': 'FixedReference', 'policy_version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_base module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_base.NetworkAccessPolicyRuleBase(name=None, id=None, policy_version=None, interfaces=None, effect=None, client=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, policy_version=None, interfaces=None, effect=None, client=None, policy=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.
interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.
effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny.
client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.
policy (FixedReference) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'effect': 'effect', 'id': 'id', 'interfaces': 'interfaces', 'name': 'name', 'policy': 'policy', 'policy_version': 'policy_version'}
- required_args = {}
- swagger_types = {'client': 'str', 'effect': 'str', 'id': 'str', 'interfaces': 'list[str]', 'name': 'str', 'policy': 'FixedReference', 'policy_version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_get_response.NetworkAccessPolicyRuleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[NetworkAccessPolicyRule]) – Displays a list of all items after filtering.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkAccessPolicyRule]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_in_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_in_policy.NetworkAccessPolicyRuleInPolicy(name=None, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=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, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=None, index=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.
interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.
effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny.
client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.
policy (FixedReference) – The policy to which this rule belongs.
index (int) – The index within the policy. The index indicates the order the rules are evaluated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'effect': 'effect', 'id': 'id', 'index': 'index', 'interfaces': 'interfaces', 'name': 'name', 'policy': 'policy', 'policy_version': 'policy_version'}
- required_args = {}
- swagger_types = {'client': 'str', 'effect': 'str', 'id': 'str', 'index': 'int', 'interfaces': 'list[str]', 'name': 'str', 'policy': 'FixedReference', 'policy_version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_post.NetworkAccessPolicyRulePost(name=None, id=None, interfaces=None, effect=None, client=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, id=None, interfaces=None, effect=None, client=None, index=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.
effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny. The default value is allow if not specified.
client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.
index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'effect': 'effect', 'id': 'id', 'index': 'index', 'interfaces': 'interfaces', 'name': 'name'}
- required_args = {}
- swagger_types = {'client': 'str', 'effect': 'str', 'id': 'str', 'index': 'int', 'interfaces': 'list[str]', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_post_base module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_post_base.NetworkAccessPolicyRulePostBase(name=None, id=None, interfaces=None, effect=None, client=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, interfaces=None, effect=None, client=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.
effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny. The default value is allow if not specified.
client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'effect': 'effect', 'id': 'id', 'interfaces': 'interfaces', 'name': 'name'}
- required_args = {}
- swagger_types = {'client': 'str', 'effect': 'str', 'id': 'str', 'interfaces': 'list[str]', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_access_policy_rule_response.NetworkAccessPolicyRuleResponse(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[NetworkAccessPolicyRule]) – Displays a list of all items after filtering.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[NetworkAccessPolicyRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interface module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interface.NetworkInterface(name=None, id=None, server=None, subnet=None, address=None, vlan=None, netmask=None, services=None, type=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, id=None, server=None, subnet=None, address=None, vlan=None, netmask=None, services=None, type=None, enabled=None, gateway=None, mtu=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
server (Reference) – The server that is using this interface for data ingress. Will be null if services does not include data. Defaults to _array_server when services does include data.
subnet (object) –
address (str) – The IPv4 or IPv6 address to be associated with the specified network interface.
vlan (int) – Derived from subnet.vlan.
netmask (str) – Derived from subnet.prefix.
services (list[str]) – Services and protocols that are enabled on the interface.
type (str) – The only valid value is vip.
enabled (bool) – Indicates if the specified network interface is enabled (true) or disabled (false). If not specified, defaults to true.
gateway (str) – Derived from subnet.gateway.
mtu (int) – Derived from subnet.mtu.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'address': 'address', 'enabled': 'enabled', 'gateway': 'gateway', 'id': 'id', 'mtu': 'mtu', 'name': 'name', 'netmask': 'netmask', 'server': 'server', 'services': 'services', 'subnet': 'subnet', 'type': 'type', 'vlan': 'vlan'}
- required_args = {}
- swagger_types = {'address': 'str', 'enabled': 'bool', 'gateway': 'str', 'id': 'str', 'mtu': 'int', 'name': 'str', 'netmask': 'str', 'server': 'Reference', 'services': 'list[str]', 'subnet': 'object', 'type': 'str', 'vlan': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interface_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interface_get_response.NetworkInterfaceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[NetworkInterface]) – A list of network interface objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterface]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interface_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interface_patch.NetworkInterfacePatch(server=None, address=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__(server=None, address=None, services=None)
- Keyword Arguments
server (Reference) – The server that is using this interface for data ingress. Will be null if services does not include data. Defaults to _array_server when services does include data.
address (str) – The IPv4 or IPv6 address to be associated with the specified network interface.
services (list[str]) – Services and protocols that are enabled on the interface.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'address': 'address', 'server': 'server', 'services': 'services'}
- required_args = {}
- swagger_types = {'address': 'str', 'server': 'Reference', 'services': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interface_ping module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interface_ping.NetworkInterfacePing(component_name=None, destination=None, details=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__(component_name=None, destination=None, details=None, source=None)
- Keyword Arguments
component_name (str) – Name of the component running the check.
destination (str) – The destination address or hostname provided in the request that the operation is run against.
details (str) – Giant text block that contains raw output of the operation and a client needs to parse.
source (str) – The address where the check starts. Can be a subnet or IP inside the subnet.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'component_name': 'component_name', 'destination': 'destination', 'details': 'details', 'source': 'source'}
- required_args = {}
- swagger_types = {'component_name': 'str', 'destination': 'str', 'details': 'str', 'source': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interface_ping_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interface_ping_get_response.NetworkInterfacePingGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[NetworkInterfacePing]) – A list of network ping run result.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterfacePing]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interface_ping_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interface_ping_response.NetworkInterfacePingResponse(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[NetworkInterfacePing]) – A list of network ping run result.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[NetworkInterfacePing]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interface_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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]) – A list of network interface objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- 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.flashblade.FB_2_17.models.network_interface_trace module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interface_trace.NetworkInterfaceTrace(component_name=None, destination=None, details=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__(component_name=None, destination=None, details=None, source=None)
- Keyword Arguments
component_name (str) – Name of the component running the check.
destination (str) – The destination address or hostname provided in the request that the operation is run against.
details (str) – Giant text block that contains raw output of the operation and a client needs to parse.
source (str) – The address where the check starts. Can be a subnet or IP inside the subnet.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'component_name': 'component_name', 'destination': 'destination', 'details': 'details', 'source': 'source'}
- required_args = {}
- swagger_types = {'component_name': 'str', 'destination': 'str', 'details': 'str', 'source': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interface_trace_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interface_trace_get_response.NetworkInterfaceTraceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[NetworkInterfaceTrace]) – A list of network trace run result.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterfaceTrace]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interface_trace_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interface_trace_response.NetworkInterfaceTraceResponse(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[NetworkInterfaceTrace]) – A list of network trace run result.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[NetworkInterfaceTrace]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_get_response.NetworkInterfacesConnectorsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[HardwareConnector]) – A list of network connector objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[HardwareConnector]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_performance.NetworkInterfacesConnectorsPerformance(name=None, id=None, link_aggregation_group=None, received_crc_errors_per_sec=None, transmitted_dropped_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_carrier_errors_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, time=None, total_errors_per_sec=None, received_packets_per_sec=None, flow_control_received_pause_frames_per_sec=None, rdma_received_req_cqe_errors_per_sec=None, flow_control_transmitted_lossless_bytes_per_sec=None, rdma_received_sequence_errors_per_sec=None, flow_control_transmitted_pause_frames_per_sec=None, flow_control_received_congestion_packets_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, flow_control_transmitted_discarded_packets_per_sec=None, flow_control_received_lossless_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__(name=None, id=None, link_aggregation_group=None, received_crc_errors_per_sec=None, transmitted_dropped_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_carrier_errors_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, time=None, total_errors_per_sec=None, received_packets_per_sec=None, flow_control_received_pause_frames_per_sec=None, rdma_received_req_cqe_errors_per_sec=None, flow_control_transmitted_lossless_bytes_per_sec=None, rdma_received_sequence_errors_per_sec=None, flow_control_transmitted_pause_frames_per_sec=None, flow_control_received_congestion_packets_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, flow_control_transmitted_discarded_packets_per_sec=None, flow_control_received_lossless_bytes_per_sec=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
link_aggregation_group (FixedReference) – The link aggregation group which this entity belongs to.
received_crc_errors_per_sec (int) – Reception CRC errors per second.
transmitted_dropped_errors_per_sec (int) – Transmitted packets dropped per second.
transmitted_packets_per_sec (int) – Packets transmitted per second.
transmitted_carrier_errors_per_sec (int) – Transmission carrier errors per second.
transmitted_bytes_per_sec (int) – Bytes transmitted per second.
received_bytes_per_sec (int) – Bytes received per second.
received_frame_errors_per_sec (int) – Received packet frame errors per second.
other_errors_per_sec (int) – The sum of unspecified reception and transmission errors per second.
time (int) – Sample time in milliseconds since UNIX epoch.
total_errors_per_sec (int) – The sum of all reception and transmission errors per second.
received_packets_per_sec (int) – Packets received per second.
flow_control_received_pause_frames_per_sec (int) – Received pause frames per second.
rdma_received_req_cqe_errors_per_sec (int) – The number of times port detected RDMA CQEs with error per second.
flow_control_transmitted_lossless_bytes_per_sec (int) – Bytes transmitted per second with lossless flow control settings.
rdma_received_sequence_errors_per_sec (int) – The number of received RDMA packet sequence errors per second.
flow_control_transmitted_pause_frames_per_sec (int) – Transmitted pause frames per second.
flow_control_received_congestion_packets_per_sec (int) – Number of congestion control packets 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 per second due to errors or other reasons.
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.
flow_control_received_lossless_bytes_per_sec (int) – Bytes received per second with lossless flow control settings.
- __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', 'id': 'id', 'link_aggregation_group': 'link_aggregation_group', 'name': 'name', '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', 'time': 'time', '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'}
- 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', 'id': 'str', 'link_aggregation_group': 'FixedReference', 'name': 'str', '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', 'time': '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.flashblade.FB_2_17.models.network_interfaces_connectors_performance_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_performance_get_response.NetworkInterfacesConnectorsPerformanceGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (list[NetworkInterfacesConnectorsPerformance]) – Total of all records after filtering. If total_only query param is true, then no individual items will be returned.
items (list[NetworkInterfacesConnectorsPerformance]) – A list of network connector 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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterfacesConnectorsPerformance]', 'total': 'list[NetworkInterfacesConnectorsPerformance]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_response.NetworkInterfacesConnectorsResponse(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[HardwareConnector]) – A list of network connector objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[HardwareConnector]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_setting module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_setting.NetworkInterfacesConnectorsSetting(name=None, id=None, roce=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, roce=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
roce (NetworkInterfacesConnectorsSettingRoce) – RoCE(RDMA over Converged Ethernet) configuration for network connectors.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'roce': 'roce'}
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'roce': 'NetworkInterfacesConnectorsSettingRoce'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_setting_roce module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_setting_roce.NetworkInterfacesConnectorsSettingRoce(default_pfc=None, network_congestion_mode=None, default_ecn=None, trust_mode=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__(default_pfc=None, network_congestion_mode=None, default_ecn=None, trust_mode=None, enabled=None)
- Keyword Arguments
default_pfc (NetworkInterfacesConnectorsSettingRocePfc) – The default PFC(Priority Flow Control) setting for network connectors.
network_congestion_mode (str) – The RoCE network mode to be used. Valid values include lossy and lossless. For lossy mode, only Explicit Congestion Notification (ECN) is enabled. For lossless mode, both ECN and Priority Flow Control (PFC) are enabled.
default_ecn (NetworkInterfacesConnectorsSettingRoceEcn) – The default ECN(Explicit Congestion Notification) setting for network connectors.
trust_mode (str) – The trust mode of the RoCE network. Valid values include pcp and dscp.
enabled (bool) – If true, then RoCE networking is enabled. Otherwise, it is disabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'default_ecn': 'default_ecn', 'default_pfc': 'default_pfc', 'enabled': 'enabled', 'network_congestion_mode': 'network_congestion_mode', 'trust_mode': 'trust_mode'}
- required_args = {}
- swagger_types = {'default_ecn': 'NetworkInterfacesConnectorsSettingRoceEcn', 'default_pfc': 'NetworkInterfacesConnectorsSettingRocePfc', 'enabled': 'bool', 'network_congestion_mode': 'str', 'trust_mode': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_setting_roce_ecn module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_setting_roce_ecn.NetworkInterfacesConnectorsSettingRoceEcn(max_ecn_marked_threshold=None, min_ecn_marked_threshold=None, marking_probability=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(max_ecn_marked_threshold=None, min_ecn_marked_threshold=None, marking_probability=None)
- Keyword Arguments
max_ecn_marked_threshold (int) – The maximum threshold value in bytes at which the packets start being marked with ECN at the highest probability or dropped.
min_ecn_marked_threshold (int) – The minimum threshold value in bytes at which the packets start being marked with ECN.
marking_probability (float) – The ECN marking probability when min ECN marked threshold is reached.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'marking_probability': 'marking_probability', 'max_ecn_marked_threshold': 'max_ecn_marked_threshold', 'min_ecn_marked_threshold': 'min_ecn_marked_threshold'}
- required_args = {}
- swagger_types = {'marking_probability': 'float', 'max_ecn_marked_threshold': 'int', 'min_ecn_marked_threshold': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_setting_roce_pfc module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_setting_roce_pfc.NetworkInterfacesConnectorsSettingRocePfc(xoff_threshold=None, xon_threshold=None, port_buffer=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(xoff_threshold=None, xon_threshold=None, port_buffer=None)
- Keyword Arguments
xoff_threshold (int) – The PFC XOFF threshold value in bytes. When the buffer for a particular traffic class reaches this threshold, the pause frame(XOFF) will be transimitted to the sender, requesting it to stop sending packets for that class.
xon_threshold (int) – The PFC XON threshold value in bytes. When the buffer for a particular traffic class drops below this threshold, the un-pause frame(XON) will be transmitted to the sender, requesting it to resume sending packets for that class.
port_buffer (int) – The buffer size in bytes reserved to absorb in-flight packets after XOFF threshold is reached.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'port_buffer': 'port_buffer', 'xoff_threshold': 'xoff_threshold', 'xon_threshold': 'xon_threshold'}
- required_args = {}
- swagger_types = {'port_buffer': 'int', 'xoff_threshold': 'int', 'xon_threshold': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_settings_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.network_interfaces_connectors_settings_get_response.NetworkInterfacesConnectorsSettingsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[NetworkInterfacesConnectorsSetting]) – A list of global network settings for network connectors.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterfacesConnectorsSetting]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs.Nfs(export_policy=None, v3_enabled=None, rules=None, v4_1_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__(export_policy=None, v3_enabled=None, rules=None, v4_1_enabled=None)
- Keyword Arguments
export_policy (ReferenceWritable) – Deprecated. See File System Exports for newer functionality. The value returned will be the policy of the File System Export for the default server, and NFS, with the export_name matching the file system name, if there is one and null otherwise. Modifying this field will still work. If the current value is null, then setting this field will attempt to create a File System Export with the policy and other default values. The export_name will be the same as the file system’s name. If the current value is not null, then setting this field will change the policy in the matching File System Export. Either the export_policy or rules will control the NFS export functionality for the file system. If this is set, then the rules field will be cleared. Both export_policy and rules can not be set in the same request.
v3_enabled (bool) – If set to true, the NFSv3 protocol will be enabled.
rules (str) – Deprecated. See File System Exports and NFS Export Policies for newer functionality. Modifying this field will still work, causing the matching File System Export to be deleted, if there is one. See export_policy. Both export_policy and rules can not be set in the same request. Rules can be applied to an individual client or a range of clients specified by IP address (ip_address(options)), netmask (ip_address/length(options)), netgroup (@groupname(options)), hostname (hostname(options)) (see RFC-1123 part 2.1), fully qualified domain name (host.exampledomain.com(options)) (see RFC-1123 part 2.1, RFC 2181 part 11), or wildcards with fully qualified domain name or hostname (*.exampledomain?.com(options)). Possible export options include rw, ro, fileid_32bit, no_fileid_32bit, anonuid, anongid, root_squash, no_root_squash, all_squash, no_all_squash, secure, insecure, atime, noatime, and sec. If not specified, defaults to *(rw,no_root_squash).
v4_1_enabled (bool) – If set to true, the NFSv4.1 protocol will be enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'export_policy': 'export_policy', 'rules': 'rules', 'v3_enabled': 'v3_enabled', 'v4_1_enabled': 'v4_1_enabled'}
- required_args = {}
- swagger_types = {'export_policy': 'ReferenceWritable', 'rules': 'str', 'v3_enabled': 'bool', 'v4_1_enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_export_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_export_policy.NfsExportPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, context=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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, context=None, rules=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
version (str) – A hash of the other properties of this resource. This can be used when updating the resource to ensure there aren’t any updates since the resource was read.
context (Reference) – 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.
rules (list[NfsExportPolicyRuleInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'rules': 'rules', 'version': 'version'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'rules': 'list[NfsExportPolicyRuleInPolicy]', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_export_policy_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_export_policy_get_response.NfsExportPolicyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[NfsExportPolicy]) – A list of NFS export policy 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[NfsExportPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_export_policy_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_export_policy_post.NfsExportPolicyPost(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, rules=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
rules (list[NfsExportPolicyRuleInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'rules': 'rules'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'rules': 'list[NfsExportPolicyRuleInPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_export_policy_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_export_policy_response.NfsExportPolicyResponse(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[NfsExportPolicy]) – A list of NFS export policy objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[NfsExportPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule.NfsExportPolicyRule(name=None, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None, index=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, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None, index=None, context=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.
security (list[str]) – The security flavors to use for accessing files on this mount point. If the server does not support the requested flavor, the mount operation fails. If sys, trusts the client to specify user’s identity. If krb5, provides cryptographic proof of a user’s identity 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 in order to enable Kerberos security. If krb5i, adds integrity checking to krb5, to ensure the data has not been tampered with. If krb5p, adds integrity checking and encryption to krb5. This is the most secure setting, but it also involves the most performance overhead. The default is sys if not specified.
access (str) – Specifies access control for the export. Valid values are root-squash, all-squash, and no-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-squash allows users and groups to access the file system with their UIDs and GIDs. The default is root-squash if not specified.
atime (bool) – If true, after a read operation has occurred, the inode access time is updated only if any of the following conditions is true: the previous access time is less than the inode modify time, the previous access time is less than the inode change time, or the previous access time is more than 24 hours ago. If false, disables the update of inode access times after read operations. Defaults to true.
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.
fileid_32bit (bool) – Whether the file id is 32 bits or not. Defaults to false.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, netgroup, hostname (see RFC-1123 part 2.1), fully qualified domain name (see RFC-1123 part 2.1, RFC 2181 part 11), wildcards with fully qualified domain name or hostname, or anonymous (*). 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 ro if not specified.
secure (bool) – If true, prevents NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. If false, allows NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. The default is false if not specified.
policy (FixedReference) – The policy to which this rule belongs.
index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.
context (Reference) – 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 = {'access': 'access', 'anongid': 'anongid', 'anonuid': 'anonuid', 'atime': 'atime', 'client': 'client', 'context': 'context', 'fileid_32bit': 'fileid_32bit', 'id': 'id', 'index': 'index', 'name': 'name', 'permission': 'permission', 'policy': 'policy', 'policy_version': 'policy_version', 'secure': 'secure', 'security': 'security'}
- required_args = {}
- swagger_types = {'access': 'str', 'anongid': 'str', 'anonuid': 'str', 'atime': 'bool', 'client': 'str', 'context': 'Reference', 'fileid_32bit': 'bool', 'id': 'str', 'index': 'int', 'name': 'str', 'permission': 'str', 'policy': 'FixedReference', 'policy_version': 'str', 'secure': 'bool', 'security': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule_base module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule_base.NfsExportPolicyRuleBase(name=None, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=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, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.
security (list[str]) – The security flavors to use for accessing files on this mount point. If the server does not support the requested flavor, the mount operation fails. If sys, trusts the client to specify user’s identity. If krb5, provides cryptographic proof of a user’s identity 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 in order to enable Kerberos security. If krb5i, adds integrity checking to krb5, to ensure the data has not been tampered with. If krb5p, adds integrity checking and encryption to krb5. This is the most secure setting, but it also involves the most performance overhead. The default is sys if not specified.
access (str) – Specifies access control for the export. Valid values are root-squash, all-squash, and no-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-squash allows users and groups to access the file system with their UIDs and GIDs. The default is root-squash if not specified.
atime (bool) – If true, after a read operation has occurred, the inode access time is updated only if any of the following conditions is true: the previous access time is less than the inode modify time, the previous access time is less than the inode change time, or the previous access time is more than 24 hours ago. If false, disables the update of inode access times after read operations. Defaults to true.
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.
fileid_32bit (bool) – Whether the file id is 32 bits or not. Defaults to false.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, netgroup, hostname (see RFC-1123 part 2.1), fully qualified domain name (see RFC-1123 part 2.1, RFC 2181 part 11), wildcards with fully qualified domain name or hostname, or anonymous (*). 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 ro if not specified.
secure (bool) – If true, prevents NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. If false, allows NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. The default is false if not specified.
policy (FixedReference) – 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', 'atime': 'atime', 'client': 'client', 'fileid_32bit': 'fileid_32bit', 'id': 'id', 'name': 'name', 'permission': 'permission', 'policy': 'policy', 'policy_version': 'policy_version', 'secure': 'secure', 'security': 'security'}
- required_args = {}
- swagger_types = {'access': 'str', 'anongid': 'str', 'anonuid': 'str', 'atime': 'bool', 'client': 'str', 'fileid_32bit': 'bool', 'id': 'str', 'name': 'str', 'permission': 'str', 'policy': 'FixedReference', 'policy_version': 'str', 'secure': 'bool', 'security': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule_get_response.NfsExportPolicyRuleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[NfsExportPolicyRule]) – Displays a list of all items after filtering.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[NfsExportPolicyRule]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule_in_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule_in_policy.NfsExportPolicyRuleInPolicy(name=None, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=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, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None, index=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.
security (list[str]) – The security flavors to use for accessing files on this mount point. If the server does not support the requested flavor, the mount operation fails. If sys, trusts the client to specify user’s identity. If krb5, provides cryptographic proof of a user’s identity 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 in order to enable Kerberos security. If krb5i, adds integrity checking to krb5, to ensure the data has not been tampered with. If krb5p, adds integrity checking and encryption to krb5. This is the most secure setting, but it also involves the most performance overhead. The default is sys if not specified.
access (str) – Specifies access control for the export. Valid values are root-squash, all-squash, and no-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-squash allows users and groups to access the file system with their UIDs and GIDs. The default is root-squash if not specified.
atime (bool) – If true, after a read operation has occurred, the inode access time is updated only if any of the following conditions is true: the previous access time is less than the inode modify time, the previous access time is less than the inode change time, or the previous access time is more than 24 hours ago. If false, disables the update of inode access times after read operations. Defaults to true.
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.
fileid_32bit (bool) – Whether the file id is 32 bits or not. Defaults to false.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, netgroup, hostname (see RFC-1123 part 2.1), fully qualified domain name (see RFC-1123 part 2.1, RFC 2181 part 11), wildcards with fully qualified domain name or hostname, or anonymous (*). 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 ro if not specified.
secure (bool) – If true, prevents NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. If false, allows NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. The default is false if not specified.
policy (FixedReference) – The policy to which this rule belongs.
index (int) – The index within the policy. The index indicates the order the rules are evaluated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access': 'access', 'anongid': 'anongid', 'anonuid': 'anonuid', 'atime': 'atime', 'client': 'client', 'fileid_32bit': 'fileid_32bit', 'id': 'id', 'index': 'index', 'name': 'name', 'permission': 'permission', 'policy': 'policy', 'policy_version': 'policy_version', 'secure': 'secure', 'security': 'security'}
- required_args = {}
- swagger_types = {'access': 'str', 'anongid': 'str', 'anonuid': 'str', 'atime': 'bool', 'client': 'str', 'fileid_32bit': 'bool', 'id': 'str', 'index': 'int', 'name': 'str', 'permission': 'str', 'policy': 'FixedReference', 'policy_version': 'str', 'secure': 'bool', 'security': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_export_policy_rule_response.NfsExportPolicyRuleResponse(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[NfsExportPolicyRule]) – Displays a list of all items after filtering.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[NfsExportPolicyRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.nfs_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.nfs_patch.NfsPatch(export_policy=None, v3_enabled=None, rules=None, v4_1_enabled=None, add_rules=None, after=None, remove_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__(export_policy=None, v3_enabled=None, rules=None, v4_1_enabled=None, add_rules=None, after=None, remove_rules=None)
- Keyword Arguments
export_policy (ReferenceWritable) – Deprecated. See File System Exports for newer functionality. The value returned will be the policy of the File System Export for the default server, and NFS, with the export_name matching the file system name, if there is one and null otherwise. Modifying this field will still work. If the current value is null, then setting this field will attempt to create a File System Export with the policy and other default values. The export_name will be the same as the file system’s name. If the current value is not null, then setting this field will change the policy in the matching File System Export. Either the export_policy or rules will control the NFS export functionality for the file system. If this is set, then the rules field will be cleared. Both export_policy and rules can not be set in the same request.
v3_enabled (bool) – If set to true, the NFSv3 protocol will be enabled.
rules (str) – Deprecated. See File System Exports and NFS Export Policies for newer functionality. Modifying this field will still work, causing the matching File System Export to be deleted, if there is one. See export_policy. Both export_policy and rules can not be set in the same request. Rules can be applied to an individual client or a range of clients specified by IP address (ip_address(options)), netmask (ip_address/length(options)), netgroup (@groupname(options)), hostname (hostname(options)) (see RFC-1123 part 2.1), fully qualified domain name (host.exampledomain.com(options)) (see RFC-1123 part 2.1, RFC 2181 part 11), or wildcards with fully qualified domain name or hostname (*.exampledomain?.com(options)). Possible export options include rw, ro, fileid_32bit, no_fileid_32bit, anonuid, anongid, root_squash, no_root_squash, all_squash, no_all_squash, secure, insecure, atime, noatime, and sec. If not specified, defaults to *(rw,no_root_squash).
v4_1_enabled (bool) – If set to true, the NFSv4.1 protocol will be enabled.
add_rules (str) – The rules which will be added to the existing NFS export rules for the file system. If export_policy is in use and and this field is set, the operation will fail.
after (str) – The after field can be used with add_rules or remove_rules or both. If used with add_rules, then the add_rules string will be inserted after the first occurrence of the after string. If used with remove_rules, then remove the first occurrence of remove_rules after the first occurrence of the after string. The remove_rules will be processed before the add_rules.
remove_rules (str) – The rules which will be removed from the existing NFS export rules for the file system. Only the first occurrence of the remove_rules will be removed. If export_policy is in use and and this field is set, the operation will fail.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'add_rules': 'add_rules', 'after': 'after', 'export_policy': 'export_policy', 'remove_rules': 'remove_rules', 'rules': 'rules', 'v3_enabled': 'v3_enabled', 'v4_1_enabled': 'v4_1_enabled'}
- required_args = {}
- swagger_types = {'add_rules': 'str', 'after': 'str', 'export_policy': 'ReferenceWritable', 'remove_rules': 'str', 'rules': 'str', 'v3_enabled': 'bool', 'v4_1_enabled': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.oauth_token_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.object_backlog module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_backlog.ObjectBacklog(delete_ops_count=None, bytes_count=None, put_ops_count=None, other_ops_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__(delete_ops_count=None, bytes_count=None, put_ops_count=None, other_ops_count=None)
- Keyword Arguments
delete_ops_count (int) – The number of DELETE operations that need to be replicated.
bytes_count (int) – The size of the objects in bytes that need to be replicated. This does not include the size of custom metadata.
put_ops_count (int) – The number of PUT operations that need to be replicated.
other_ops_count (int) – The number of other operations that need to be replicated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bytes_count': 'bytes_count', 'delete_ops_count': 'delete_ops_count', 'other_ops_count': 'other_ops_count', 'put_ops_count': 'put_ops_count'}
- required_args = {}
- swagger_types = {'bytes_count': 'int', 'delete_ops_count': 'int', 'other_ops_count': 'int', 'put_ops_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_lock_config_base module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_lock_config_base.ObjectLockConfigBase(enabled=None, freeze_locked_objects=None, default_retention_mode=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, freeze_locked_objects=None, default_retention_mode=None)
- Keyword Arguments
enabled (bool) – If set to true, then S3 APIs relating to object lock may be used.
freeze_locked_objects (bool) – If set to true, a locked object will be read-only and no new versions of the object may be created due to modifications. If not specified, defaults to false.
default_retention_mode (str) – The retention mode used to apply locks on new objects if none is specified by the S3 client. Valid values include compliance and governance. If there is no default, this value is null. Use “” to clear.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'default_retention_mode': 'default_retention_mode', 'enabled': 'enabled', 'freeze_locked_objects': 'freeze_locked_objects'}
- required_args = {}
- swagger_types = {'default_retention_mode': 'str', 'enabled': 'bool', 'freeze_locked_objects': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_lock_config_request_body module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_lock_config_request_body.ObjectLockConfigRequestBody(enabled=None, freeze_locked_objects=None, default_retention_mode=None, default_retention=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, freeze_locked_objects=None, default_retention_mode=None, default_retention=None)
- Keyword Arguments
enabled (bool) – If set to true, then S3 APIs relating to object lock may be used.
freeze_locked_objects (bool) – If set to true, a locked object will be read-only and no new versions of the object may be created due to modifications. If not specified, defaults to false.
default_retention_mode (str) – The retention mode used to apply locks on new objects if none is specified by the S3 client. Valid values include compliance and governance. If there is no default, this value is null. Use “” to clear.
default_retention (str) – The retention period, in milliseconds, used to apply locks on new objects if none is specified by the S3 client. Valid values are any multiple of 86400000 (1 day), up to 3153600000000 (36500 days). If there is no default, this value is null. Use “” to clear.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'default_retention': 'default_retention', 'default_retention_mode': 'default_retention_mode', 'enabled': 'enabled', 'freeze_locked_objects': 'freeze_locked_objects'}
- required_args = {}
- swagger_types = {'default_retention': 'str', 'default_retention_mode': 'str', 'enabled': 'bool', 'freeze_locked_objects': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_lock_config_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_lock_config_response.ObjectLockConfigResponse(enabled=None, freeze_locked_objects=None, default_retention_mode=None, default_retention=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, freeze_locked_objects=None, default_retention_mode=None, default_retention=None)
- Keyword Arguments
enabled (bool) – If set to true, then S3 APIs relating to object lock may be used.
freeze_locked_objects (bool) – If set to true, a locked object will be read-only and no new versions of the object may be created due to modifications. If not specified, defaults to false.
default_retention_mode (str) – The retention mode used to apply locks on new objects if none is specified by the S3 client. Valid values include compliance and governance. If there is no default, this value is null. Use “” to clear.
default_retention (int) – The retention period, in milliseconds, used to apply locks on new objects if none is specified by the S3 client. Valid values are any multiple of 86400000 (1 day), up to 3153600000000 (36500 days). If there is no default, this value is null.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'default_retention': 'default_retention', 'default_retention_mode': 'default_retention_mode', 'enabled': 'enabled', 'freeze_locked_objects': 'freeze_locked_objects'}
- required_args = {}
- swagger_types = {'default_retention': 'int', 'default_retention_mode': 'str', 'enabled': 'bool', 'freeze_locked_objects': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_key module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_key.ObjectStoreAccessKey(name=None, context=None, created=None, secret_access_key=None, 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, context=None, created=None, secret_access_key=None, user=None, enabled=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
context (Reference) – 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.
created (int) – Creation timestamp of the object.
secret_access_key (str) – The secret access key, only populated on creation if it is not imported from another FlashBlade.
user (FixedReference) – Reference of the associated user.
enabled (bool) – Is the access key enabled? If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'created': 'created', 'enabled': 'enabled', 'name': 'name', 'secret_access_key': 'secret_access_key', 'user': 'user'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'created': 'int', 'enabled': 'bool', 'name': 'str', 'secret_access_key': 'str', 'user': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_key_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_key_get_response.ObjectStoreAccessKeyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ObjectStoreAccessKey]) – A list of object store access key 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ObjectStoreAccessKey]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_key_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_key_post.ObjectStoreAccessKeyPost(secret_access_key=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__(secret_access_key=None, user=None)
- Keyword Arguments
secret_access_key (str) – The secret access key to import from another FlashBlade. To import a set of credentials, this field must be specified with the names query parameter. If both of these not specified, the system will generate a new set of credentials.
user (object) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'secret_access_key': 'secret_access_key', 'user': 'user'}
- required_args = {}
- swagger_types = {'secret_access_key': 'str', 'user': 'object'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_key_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_key_response.ObjectStoreAccessKeyResponse(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[ObjectStoreAccessKey]) – A list of object store access key objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ObjectStoreAccessKey]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy.ObjectStoreAccessPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, created=None, description=None, rules=None, arn=None, updated=None, account=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, policy_type=None, location=None, is_local=None, enabled=None, context=None, created=None, description=None, rules=None, arn=None, updated=None, account=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
context (Reference) – 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.
created (int) – Creation timestamp of the object.
description (str) – A description of the policy, optionally specified when the policy is created. Cannot be modified for an existing policy.
rules (list[PolicyRuleObjectAccess]) –
arn (str) – Amazon Resource Name of the policy. Used when referencing the policy via S3 APIs.
updated (int) – The last updated timestamp of the object.
account (FixedReference) – Reference of the associated account. If the policy is not associated with an account, all fields in the reference possess null values.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'account': 'account', 'arn': 'arn', 'context': 'context', 'created': 'created', 'description': 'description', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'rules': 'rules', 'updated': 'updated'}
- required_args = {}
- swagger_types = {'account': 'FixedReference', 'arn': 'str', 'context': 'Reference', 'created': 'int', 'description': 'str', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'rules': 'list[PolicyRuleObjectAccess]', 'updated': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy_action module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy_action.ObjectStoreAccessPolicyAction(name=None, context=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__(name=None, context=None, description=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
context (Reference) – 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.
description (str) – A description of the action.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'description': 'description', 'name': 'name'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'description': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy_action_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy_action_get_response.ObjectStoreAccessPolicyActionGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ObjectStoreAccessPolicyAction]) –
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ObjectStoreAccessPolicyAction]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy_action_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy_action_response.ObjectStoreAccessPolicyActionResponse(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[ObjectStoreAccessPolicyAction]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ObjectStoreAccessPolicyAction]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy_get_response.ObjectStoreAccessPolicyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ObjectStoreAccessPolicy]) –
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ObjectStoreAccessPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy_patch.ObjectStoreAccessPolicyPatch(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[PolicyRuleObjectAccessBulkManage]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'rules': 'rules'}
- required_args = {}
- swagger_types = {'rules': 'list[PolicyRuleObjectAccessBulkManage]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy_post.ObjectStoreAccessPolicyPost(rules=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__(rules=None, description=None)
- Keyword Arguments
rules (list[PolicyRuleObjectAccessBulkManage]) –
description (str) – A description of the policy, optionally specified when the policy is created. Cannot be modified for an existing policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'description': 'description', 'rules': 'rules'}
- required_args = {}
- swagger_types = {'description': 'str', 'rules': 'list[PolicyRuleObjectAccessBulkManage]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy_response.ObjectStoreAccessPolicyResponse(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[ObjectStoreAccessPolicy]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ObjectStoreAccessPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy_rule_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy_rule_get_response.ObjectStoreAccessPolicyRuleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[PolicyRuleObjectAccess]) –
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[PolicyRuleObjectAccess]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_access_policy_rule_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_access_policy_rule_response.ObjectStoreAccessPolicyRuleResponse(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[PolicyRuleObjectAccess]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[PolicyRuleObjectAccess]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_account module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_account.ObjectStoreAccount(name=None, id=None, context=None, quota_limit=None, bucket_defaults=None, hard_limit_enabled=None, public_access_config=None, created=None, object_count=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, quota_limit=None, bucket_defaults=None, hard_limit_enabled=None, public_access_config=None, created=None, object_count=None, space=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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 effective quota limit applied against the size of the account, displayed in bytes. If unset, the account is unlimited in size.
bucket_defaults (BucketDefaultsReadonly) – Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields.
hard_limit_enabled (bool) – If set to true, the account’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for quota_limit.
public_access_config (PublicAccessConfig) –
created (int) – Creation timestamp of the object.
object_count (int) – The count of objects within the account.
space (Space) – The space specification of the object store account.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bucket_defaults': 'bucket_defaults', 'context': 'context', 'created': 'created', 'hard_limit_enabled': 'hard_limit_enabled', 'id': 'id', 'name': 'name', 'object_count': 'object_count', 'public_access_config': 'public_access_config', 'quota_limit': 'quota_limit', 'space': 'space'}
- required_args = {}
- swagger_types = {'bucket_defaults': 'BucketDefaultsReadonly', 'context': 'Reference', 'created': 'int', 'hard_limit_enabled': 'bool', 'id': 'str', 'name': 'str', 'object_count': 'int', 'public_access_config': 'PublicAccessConfig', 'quota_limit': 'int', 'space': 'Space'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_account_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_account_get_response.ObjectStoreAccountGetResponse(continuation_token=None, total_item_count=None, errors=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, total_item_count=None, errors=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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ObjectStoreAccount]) – A list of object store account objects.
total (ObjectStoreAccount) – If total_only query param is true, then this field will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.
- __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', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ObjectStoreAccount]', 'total': 'ObjectStoreAccount', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_account_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_account_patch.ObjectStoreAccountPatch(quota_limit=None, bucket_defaults=None, hard_limit_enabled=None, public_access_config=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, bucket_defaults=None, hard_limit_enabled=None, public_access_config=None)
- Keyword Arguments
quota_limit (str) – The effective quota limit to be applied against the size of the account, displayed in bytes. If set to an empty string (“”), the account is unlimited in size.
bucket_defaults (BucketDefaults) – Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields.
hard_limit_enabled (bool) – If set to true, the account’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for quota_limit.
public_access_config (PublicAccessConfig) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'bucket_defaults': 'bucket_defaults', 'hard_limit_enabled': 'hard_limit_enabled', 'public_access_config': 'public_access_config', 'quota_limit': 'quota_limit'}
- required_args = {}
- swagger_types = {'bucket_defaults': 'BucketDefaults', 'hard_limit_enabled': 'bool', 'public_access_config': 'PublicAccessConfig', 'quota_limit': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_account_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_account_post.ObjectStoreAccountPost(quota_limit=None, bucket_defaults=None, hard_limit_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__(quota_limit=None, bucket_defaults=None, hard_limit_enabled=None)
- Keyword Arguments
quota_limit (str) – The effective quota limit to be applied against the size of the account, displayed in bytes. If set to an empty string (“”), the account is unlimited in size. If not specified, defaults to unlimited.
bucket_defaults (BucketDefaults) – Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields.
hard_limit_enabled (bool) – If set to true, the account’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for 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 = {'bucket_defaults': 'bucket_defaults', 'hard_limit_enabled': 'hard_limit_enabled', 'quota_limit': 'quota_limit'}
- required_args = {}
- swagger_types = {'bucket_defaults': 'BucketDefaults', 'hard_limit_enabled': 'bool', 'quota_limit': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_account_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_account_response.ObjectStoreAccountResponse(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[ObjectStoreAccount]) – A list of object store account objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ObjectStoreAccount]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_remote_credential_get_resp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_remote_credential_get_resp.ObjectStoreRemoteCredentialGetResp(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ObjectStoreRemoteCredentials]) – A list of object store remote credentials.
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ObjectStoreRemoteCredentials]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_remote_credentials module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_remote_credentials.ObjectStoreRemoteCredentials(name=None, id=None, context=None, access_key_id=None, secret_access_key=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, access_key_id=None, secret_access_key=None, remote=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
access_key_id (str) – Access Key ID to be used when connecting to a remote object store.
secret_access_key (str) – Secret Access Key to be used when connecting to a remote object store.
remote (FixedReference) – Reference to the associated remote, which can either be a target or remote array. If it is an array, then the resource-type field will not be populated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_key_id': 'access_key_id', 'context': 'context', 'id': 'id', 'name': 'name', 'remote': 'remote', 'secret_access_key': 'secret_access_key'}
- required_args = {}
- swagger_types = {'access_key_id': 'str', 'context': 'Reference', 'id': 'str', 'name': 'str', 'remote': 'FixedReference', 'secret_access_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_remote_credentials_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_remote_credentials_post.ObjectStoreRemoteCredentialsPost(access_key_id=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, secret_access_key=None)
- Keyword Arguments
access_key_id (str) – Access Key ID to be used when connecting to a remote object store.
secret_access_key (str) – Secret Access Key to be used when connecting to a remote object store.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_key_id': 'access_key_id', 'secret_access_key': 'secret_access_key'}
- required_args = {}
- swagger_types = {'access_key_id': 'str', 'secret_access_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_remote_credentials_resp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_remote_credentials_resp.ObjectStoreRemoteCredentialsResp(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[ObjectStoreRemoteCredentials]) – A list of object store remote credentials.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ObjectStoreRemoteCredentials]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_role module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_role.ObjectStoreRole(name=None, id=None, context=None, trusted_entities=None, created=None, prn=None, account=None, max_session_duration=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, trusted_entities=None, created=None, prn=None, account=None, max_session_duration=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
trusted_entities (list[FixedReference]) – List of trusted entities
created (int) – Creation timestamp of the object.
prn (str) – Pure Resource Name of the role
account (FixedReference) – Reference of the associated account.
max_session_duration (int) – The maximum session duration for the role in milliseconds
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'account': 'account', 'context': 'context', 'created': 'created', 'id': 'id', 'max_session_duration': 'max_session_duration', 'name': 'name', 'prn': 'prn', 'trusted_entities': 'trusted_entities'}
- required_args = {}
- swagger_types = {'account': 'FixedReference', 'context': 'Reference', 'created': 'int', 'id': 'str', 'max_session_duration': 'int', 'name': 'str', 'prn': 'str', 'trusted_entities': 'list[FixedReference]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_role_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_role_get_response.ObjectStoreRoleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ObjectStoreRole]) – A list of object store roles.
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ObjectStoreRole]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_role_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_role_post.ObjectStoreRolePost(max_session_duration=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(max_session_duration=None)
- Keyword Arguments
max_session_duration (int) – Maximum session duration in milliseconds. If not provided when creating the role, defaults to 1h, minimum is 1h, maximum is 12h.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'max_session_duration': 'max_session_duration'}
- required_args = {}
- swagger_types = {'max_session_duration': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_role_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_role_response.ObjectStoreRoleResponse(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[ObjectStoreRole]) – A list of object store roles.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ObjectStoreRole]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_trust_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_trust_policy.ObjectStoreTrustPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, role=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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, role=None, rules=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
context (Reference) – 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.
role (FixedReference) – Object Store Role to which the Trust Policy applies.
rules (list[TrustPolicyRule]) – List of rules establishing the trust policy
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'role': 'role', 'rules': 'rules'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'role': 'FixedReference', 'rules': 'list[TrustPolicyRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_get_response.ObjectStoreTrustPolicyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ObjectStoreTrustPolicy]) –
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ObjectStoreTrustPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_iam module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_iam.ObjectStoreTrustPolicyIam
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__()
Keyword args:
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {}
- required_args = {}
- swagger_types = {}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_response.ObjectStoreTrustPolicyResponse(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[ObjectStoreTrustPolicy]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ObjectStoreTrustPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_rule_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_rule_get_response.ObjectStoreTrustPolicyRuleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[TrustPolicyRuleWithContext]) –
- __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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[TrustPolicyRuleWithContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_rule_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_trust_policy_rule_response.ObjectStoreTrustPolicyRuleResponse(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[TrustPolicyRuleWithContext]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[TrustPolicyRuleWithContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_user module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_user.ObjectStoreUser(name=None, id=None, context=None, created=None, access_keys=None, account=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, created=None, access_keys=None, account=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
created (int) – Creation timestamp of the object.
access_keys (list[FixedReference]) – References of the user’s access keys.
account (FixedReference) – Reference of the associated account.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'access_keys': 'access_keys', 'account': 'account', 'context': 'context', 'created': 'created', 'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'access_keys': 'list[FixedReference]', 'account': 'FixedReference', 'context': 'Reference', 'created': 'int', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_user_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_user_get_response.ObjectStoreUserGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ObjectStoreUser]) – A list of object store user 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ObjectStoreUser]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_user_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_user_response.ObjectStoreUserResponse(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[ObjectStoreUser]) – A list of object store user objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ObjectStoreUser]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_virtual_host module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_virtual_host.ObjectStoreVirtualHost(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__(name=None, id=None, context=None)
- Keyword Arguments
name (str) – A hostname by which the array can be addressed for virtual hosted-style S3 requests.
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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', 'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_virtual_host_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_virtual_host_get_response.ObjectStoreVirtualHostGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.
items (list[ObjectStoreVirtualHost]) – A list of object store virtual host 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ObjectStoreVirtualHost]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.object_store_virtual_host_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.object_store_virtual_host_response.ObjectStoreVirtualHostResponse(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[ObjectStoreVirtualHost]) – A list of object store virtual host objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ObjectStoreVirtualHost]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.oidc_sso module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.oidc_sso.OidcSso(name=None, id=None, idp=None, services=None, prn=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, idp=None, services=None, prn=None, enabled=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
idp (OidcSsoPostIdp) –
services (list[str]) – Services that the OIDC SSO authentication is used for. Valid values: object.
prn (str) – Pure Resource Name of the identity provider
enabled (bool) – If set to true, the OIDC SSO configuration is enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'id': 'id', 'idp': 'idp', 'name': 'name', 'prn': 'prn', 'services': 'services'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'id': 'str', 'idp': 'OidcSsoPostIdp', 'name': 'str', 'prn': 'str', 'services': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.oidc_sso_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.oidc_sso_get_response.OidcSsoGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[OidcSso]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[OidcSso]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.oidc_sso_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.oidc_sso_patch.OidcSsoPatch(idp=None, services=None, prn=None, enabled=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__(idp=None, services=None, prn=None, enabled=None, name=None)
- Keyword Arguments
idp (OidcSsoPostIdp) –
services (list[str]) – Services that the OIDC SSO authentication is used for. Valid values: object.
prn (str) – Pure Resource Name of the identity provider
enabled (bool) – If set to true, the OIDC SSO configuration is enabled.
name (str) – A new name for the provider
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'idp': 'idp', 'name': 'name', 'prn': 'prn', 'services': 'services'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'idp': 'OidcSsoPostIdp', 'name': 'str', 'prn': 'str', 'services': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.oidc_sso_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.oidc_sso_post.OidcSsoPost(idp=None, services=None, prn=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, services=None, prn=None, enabled=None)
- Keyword Arguments
idp (OidcSsoPostIdp) –
services (list[str]) – Services that the OIDC SSO authentication is used for. Valid values: object.
prn (str) – Pure Resource Name of the identity provider
enabled (bool) – If set to true, the OIDC SSO configuration is enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'idp': 'idp', 'prn': 'prn', 'services': 'services'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'idp': 'OidcSsoPostIdp', 'prn': 'str', 'services': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.oidc_sso_post_idp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.oidc_sso_post_idp.OidcSsoPostIdp(provider_url_ca_certificate_group=None, provider_url_ca_certificate=None, provider_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__(provider_url_ca_certificate_group=None, provider_url_ca_certificate=None, provider_url=None)
- Keyword Arguments
provider_url_ca_certificate_group (Reference) – A certificate group containing CA certificates that can be used to validate the authenticity of the configured Identity Provider server.
provider_url_ca_certificate (Reference) – CA certificate used to validate the authenticity of the configured Identity Provider server.
provider_url (str) – URL of the Identity Provider server
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'provider_url': 'provider_url', 'provider_url_ca_certificate': 'provider_url_ca_certificate', 'provider_url_ca_certificate_group': 'provider_url_ca_certificate_group'}
- required_args = {}
- swagger_types = {'provider_url': 'str', 'provider_url_ca_certificate': 'Reference', 'provider_url_ca_certificate_group': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.oidc_sso_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.oidc_sso_response.OidcSsoResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[OidcSso]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.page_info module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.page_info.PageInfo(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.password_policies_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.password_policies_get_response.PasswordPoliciesGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PasswordPolicy]) – 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[PasswordPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.password_policies_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.password_policies_response.PasswordPoliciesResponse(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[PasswordPolicy]) – 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'}
- required_args = {}
- swagger_types = {'items': 'list[PasswordPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.password_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.password_policy.PasswordPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, enforce_dictionary_check=None, lockout_duration=None, min_password_length=None, min_character_groups=None, max_login_attempts=None, enforce_username_check=None, min_characters_per_group=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, policy_type=None, location=None, is_local=None, enabled=None, enforce_dictionary_check=None, lockout_duration=None, min_password_length=None, min_character_groups=None, max_login_attempts=None, enforce_username_check=None, min_characters_per_group=None, password_history=None, min_password_age=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
enforce_dictionary_check (bool) – If true, test password against dictionary of known leaked passwords. Requires 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.
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. Only applies to usernames of 4 characters and longer.
min_characters_per_group (int) – The minimum number of characters per group to count the group as present.
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 with precision to 1 hour.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'enforce_dictionary_check': 'enforce_dictionary_check', 'enforce_username_check': 'enforce_username_check', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'lockout_duration': 'lockout_duration', 'max_login_attempts': 'max_login_attempts', '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'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'enforce_dictionary_check': 'bool', 'enforce_username_check': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'lockout_duration': 'int', 'max_login_attempts': '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.flashblade.FB_2_17.models.permission module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.permission.Permission(resource_type=None, action=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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=None, action=None)
- Keyword Arguments
resource_type (str) – The resource_type that this permission affects.
action (str) – The action that the user can perform on the resource_type. Typical values include get, patch, post, and delete. Values can also be finer grained.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'action': 'action', 'resource_type': 'resource_type'}
- required_args = {}
- swagger_types = {'action': 'str', 'resource_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy.Policy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=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, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=None, retention_lock=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
context (Reference) – 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.
rules (list[PolicyRule]) –
retention_lock (str) – If retention lock is locked, then the the policy can not be removed from the associated file systems and the rules may not be changed. Valid values are locked and unlocked. Contact Pure Technical Services to change locked to unlocked.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'retention_lock': 'retention_lock', 'rules': 'rules'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'retention_lock': 'str', 'rules': 'list[PolicyRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_base module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_base.PolicyBase(name=None, id=None, policy_type=None, location=None, is_local=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, policy_type=None, location=None, is_local=None, enabled=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. 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', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_base_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_base_context.PolicyBaseContext(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=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, policy_type=None, location=None, is_local=None, enabled=None, context=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
context (Reference) – 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', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_base_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_base_get_response.PolicyBaseGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PolicyBaseContext]) – A list of basic policy 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[PolicyBaseContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_base_renameable module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_base_renameable.PolicyBaseRenameable(name=None, id=None, policy_type=None, location=None, is_local=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, policy_type=None, location=None, is_local=None, enabled=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. 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', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_base_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_base_response.PolicyBaseResponse(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[PolicyBaseContext]) – A list of basic policy objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[PolicyBaseContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_file_system_snapshot module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_file_system_snapshot.PolicyFileSystemSnapshot(member=None, policy=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__(member=None, policy=None, context=None)
- Keyword Arguments
member (FixedReference) – Reference to the resource the policy is applied to.
policy (LocationReference) – Reference to the policy.
context (Reference) – 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', 'member': 'member', 'policy': 'policy'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'member': 'FixedReference', 'policy': 'LocationReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_file_system_snapshot_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_file_system_snapshot_get_response.PolicyFileSystemSnapshotGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PolicyFileSystemSnapshot]) – A list of members for policies.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[PolicyFileSystemSnapshot]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_file_system_snapshot_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_file_system_snapshot_response.PolicyFileSystemSnapshotResponse(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[PolicyFileSystemSnapshot]) – A list of members for policies.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[PolicyFileSystemSnapshot]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_get_response.PolicyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Policy]) – A list of policy 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[Policy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_member module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_member.PolicyMember(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 (FixedReference) – Reference to the resource the policy is applied to.
policy (FixedReference) – Reference to the policy.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'member': 'member', 'policy': 'policy'}
- required_args = {}
- swagger_types = {'member': 'FixedReference', 'policy': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_member_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_member_context.PolicyMemberContext(member=None, policy=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__(member=None, policy=None, context=None)
- Keyword Arguments
member (FixedReference) – Reference to the resource the policy is applied to.
policy (FixedReference) – Reference to the policy.
context (Reference) – 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', 'member': 'member', 'policy': 'policy'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'member': 'FixedReference', 'policy': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_member_context_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_member_context_get_response.PolicyMemberContextGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PolicyMemberContext]) – A list of members for policies.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[PolicyMemberContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_member_context_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_member_context_response.PolicyMemberContextResponse(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[PolicyMemberContext]) – A list of members for policies.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[PolicyMemberContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_member_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_member_get_response.PolicyMemberGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PolicyMember]) – A list of members for policies.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[PolicyMember]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_member_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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]) – A list of members for policies.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- 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.flashblade.FB_2_17.models.policy_member_with_remote module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_member_with_remote.PolicyMemberWithRemote(member=None, policy=None, context=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__(member=None, policy=None, context=None, link=None)
- Keyword Arguments
member (FixedReference) – Reference to the resource the policy is applied to.
policy (LocationReference) – Reference to the policy.
context (Reference) – 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.
link (MemberLink) – Only populated if the member is a file system replica link. Contains additional information about the link.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'link': 'link', 'member': 'member', 'policy': 'policy'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'link': 'MemberLink', 'member': 'FixedReference', 'policy': 'LocationReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_member_with_remote_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_member_with_remote_get_response.PolicyMemberWithRemoteGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PolicyMemberWithRemote]) – A list of members for policies.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[PolicyMemberWithRemote]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_member_with_remote_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_member_with_remote_response.PolicyMemberWithRemoteResponse(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[PolicyMemberWithRemote]) – A list of members for policies.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[PolicyMemberWithRemote]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_patch.PolicyPatch(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=None, retention_lock=None, add_rules=None, remove_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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=None, retention_lock=None, add_rules=None, remove_rules=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
context (Reference) – 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.
rules (list[PolicyRule]) –
retention_lock (str) – If retention lock is locked, then the the policy can not be removed from the associated file systems and the rules may not be changed. Valid values are locked and unlocked. Contact Pure Technical Services to change locked to unlocked.
add_rules (list[PolicyRule]) –
remove_rules (list[PolicyRule]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'add_rules': 'add_rules', 'context': 'context', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'remove_rules': 'remove_rules', 'retention_lock': 'retention_lock', 'rules': 'rules'}
- required_args = {}
- swagger_types = {'add_rules': 'list[PolicyRule]', 'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'remove_rules': 'list[PolicyRule]', 'retention_lock': 'str', 'rules': 'list[PolicyRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- 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.flashblade.FB_2_17.models.policy_rule module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_rule.PolicyRule(at=None, keep_for=None, time_zone=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, time_zone=None, every=None)
- Keyword Arguments
at (int) – Time during the day to take the snapshot (using array time zone), only valid if ‘every’ is in days.
keep_for (int) – The time to keep the snapshots for.
time_zone (str) – The time zone to use with the at time.
every (int) – How often to take snapshots.
- __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', 'time_zone': 'time_zone'}
- required_args = {}
- swagger_types = {'at': 'int', 'every': 'int', 'keep_for': 'int', 'time_zone': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_rule_index module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_rule_index.PolicyRuleIndex(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__(index=None)
- Keyword Arguments
index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'index': 'index'}
- required_args = {}
- swagger_types = {'index': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_rule_index_in_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_rule_index_in_policy.PolicyRuleIndexInPolicy(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__(index=None)
- Keyword Arguments
index (int) – The index within the policy. The index indicates the order the rules are evaluated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'index': 'index'}
- required_args = {}
- swagger_types = {'index': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_rule_object_access module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_rule_object_access.PolicyRuleObjectAccess(name=None, context=None, effect=None, resources=None, conditions=None, actions=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, context=None, effect=None, resources=None, conditions=None, actions=None, policy=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
context (Reference) – 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.
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. When deny, the rule disallows performing the given actions on the given resources, subject to the given condition. This takes precedence over any matching allow rules. Valid values include allow and deny.
resources (list[str]) – The list of resources which this rule applies to. Each resource can include a bucket component, optionally followed by an object component. The choice of which components a resource can include is dictated by which actions are included in the rule. For further details, see the Object Store Access Policy Actions section of the User Guide.
conditions (PolicyRuleObjectAccessCondition) – Conditions used to limit the scope which this rule applies to.
actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. Supported actions are returned by the /object-store-access-policy-actions endpoint.
policy (FixedReference) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actions': 'actions', 'conditions': 'conditions', 'context': 'context', 'effect': 'effect', 'name': 'name', 'policy': 'policy', 'resources': 'resources'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'conditions': 'PolicyRuleObjectAccessCondition', 'context': 'Reference', 'effect': 'str', 'name': 'str', 'policy': 'FixedReference', 'resources': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_rule_object_access_bulk_manage module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_rule_object_access_bulk_manage.PolicyRuleObjectAccessBulkManage(effect=None, resources=None, conditions=None, actions=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__(effect=None, resources=None, conditions=None, actions=None, name=None)
- Keyword Arguments
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. When deny, the rule disallows performing the given actions on the given resources, subject to the given condition. This takes precedence over any matching allow rules. Valid values include allow and deny.
resources (list[str]) – The list of resources which this rule applies to. Each resource can include a bucket component, optionally followed by an object component. The choice of which components a resource can include is dictated by which actions are included in the rule. For further details, see the Object Store Access Policy Actions section of the User Guide.
conditions (PolicyRuleObjectAccessCondition) – Conditions used to limit the scope which this rule applies to.
actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. Supported actions are returned by the /object-store-access-policy-actions endpoint.
name (str) – Name of the object (e.g., a file system or snapshot).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actions': 'actions', 'conditions': 'conditions', 'effect': 'effect', 'name': 'name', 'resources': 'resources'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'conditions': 'PolicyRuleObjectAccessCondition', 'effect': 'str', 'name': 'str', 'resources': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_rule_object_access_condition module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_rule_object_access_condition.PolicyRuleObjectAccessCondition(s3_delimiters=None, s3_prefixes=None, source_ips=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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_delimiters=None, s3_prefixes=None, source_ips=None)
- Keyword Arguments
s3_delimiters (list[str]) – If specified, groups result objects by the specified delimiter. Only top-level groupings will be returned. Can be used with the s3:ListBucket and s3:ListBucketVersions actions.
s3_prefixes (list[str]) – If specified, restricts access and results based on the prefix of the relevant objects. Can be used with the s3:ListBucket and s3:ListBucketVersions actions.
source_ips (list[str]) – If specified, the rule will apply only to requests matching at least one provided IP address or subnet. Each entry must be in standard CIDR format (including an IP address without an associated routing prefix). Can be used with any action.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'s3_delimiters': 's3_delimiters', 's3_prefixes': 's3_prefixes', 'source_ips': 'source_ips'}
- required_args = {}
- swagger_types = {'s3_delimiters': 'list[str]', 's3_prefixes': 'list[str]', 'source_ips': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.policy_rule_object_access_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.policy_rule_object_access_post.PolicyRuleObjectAccessPost(effect=None, resources=None, conditions=None, actions=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(effect=None, resources=None, conditions=None, actions=None)
- Keyword Arguments
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. When deny, the rule disallows performing the given actions on the given resources, subject to the given condition. This takes precedence over any matching allow rules. Valid values include allow and deny.
resources (list[str]) – The list of resources which this rule applies to. Each resource can include a bucket component, optionally followed by an object component. The choice of which components a resource can include is dictated by which actions are included in the rule. For further details, see the Object Store Access Policy Actions section of the User Guide.
conditions (PolicyRuleObjectAccessCondition) – Conditions used to limit the scope which this rule applies to.
actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. Supported actions are returned by the /object-store-access-policy-actions endpoint.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actions': 'actions', 'conditions': 'conditions', 'effect': 'effect', 'resources': 'resources'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'conditions': 'PolicyRuleObjectAccessCondition', 'effect': 'str', 'resources': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.public_access_config module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.public_access_config.PublicAccessConfig(block_public_access=None, block_new_public_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__(block_public_access=None, block_new_public_policies=None)
- Keyword Arguments
block_public_access (bool) – If set to true, access to a bucket with a public policy is restricted to only authenticated users within the account that bucket belongs to.
block_new_public_policies (bool) – If set to true, adding bucket policies that grant public access to a bucket is not allowed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'block_new_public_policies': 'block_new_public_policies', 'block_public_access': 'block_public_access'}
- required_args = {}
- swagger_types = {'block_new_public_policies': 'bool', 'block_public_access': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.public_key module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.public_key.PublicKey(name=None, id=None, public_key=None, algorithm=None, key_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, id=None, public_key=None, algorithm=None, key_size=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
public_key (str) – The text of the public key. May be PEM-formatted or OpenSSH-formatted at the time of input.
algorithm (str) – The cryptographic algorithm used by the key. Valid values include rsa, rsassa-pss, dsa, ec, and ed25519.
key_size (int) – The size of the public key in bits.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'algorithm': 'algorithm', 'id': 'id', 'key_size': 'key_size', 'name': 'name', 'public_key': 'public_key'}
- required_args = {}
- swagger_types = {'algorithm': 'str', 'id': 'str', 'key_size': 'int', 'name': 'str', 'public_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.public_key_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.public_key_get_response.PublicKeyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PublicKey]) – A list of public key objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[PublicKey]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.public_key_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.public_key_post.PublicKeyPost(public_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__(public_key=None)
- Keyword Arguments
public_key (str) – The text of the public key. May be PEM-formatted or OpenSSH-formatted at the time of input.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'public_key': 'public_key'}
- required_args = {}
- swagger_types = {'public_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.public_key_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.public_key_response.PublicKeyResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[PublicKey]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.public_key_use module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.public_key_use.PublicKeyUse(name=None, id=None, use=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, use=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
use (FixedReference) – A reference to an object using this public key.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'use': 'use'}
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'use': 'FixedReference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.public_key_use_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.public_key_use_get_response.PublicKeyUseGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PublicKeyUse]) – A list of public key use objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[PublicKeyUse]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.public_key_use_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.public_key_use_response.PublicKeyUseResponse(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[PublicKeyUse]) – A list of public key use objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[PublicKeyUse]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.qos_policies_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.qos_policies_get_response.QosPoliciesGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[QosPolicy]) – A list of QoS policy objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[QosPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.qos_policies_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.qos_policies_response.QosPoliciesResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[QosPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.qos_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.qos_policy.QosPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, max_total_bytes_per_sec=None, max_total_ops_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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, max_total_bytes_per_sec=None, max_total_ops_per_sec=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
max_total_bytes_per_sec (int) – The maximum allowed bytes/s totaled across all the clients. Throttling occurs when the total bandwidth exceeds this limit. Minimum limit is 1MB/s and maximum limit is 512GB/s. If not specified at creation time, defaults to null to indicate no limit.
max_total_ops_per_sec (int) – The maximum allowed operations/s totaled across all the clients. Throttling occurs when the total IOPs exceeds this limit. Minimum limit is 100 IOPs/s and maximum limit is 100M IOPs/s. If not specified at creation time, defaults to null to indicate no limit.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'max_total_bytes_per_sec': 'max_total_bytes_per_sec', 'max_total_ops_per_sec': 'max_total_ops_per_sec', 'name': 'name', 'policy_type': 'policy_type'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'max_total_bytes_per_sec': 'int', 'max_total_ops_per_sec': 'int', 'name': 'str', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.quota_setting module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.quota_setting.QuotaSetting(name=None, id=None, direct_notifications_enabled=None, contact=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, direct_notifications_enabled=None, contact=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
direct_notifications_enabled (bool) – Are notifications regarding space usage and quotas being sent directly to user and group emails?
contact (str) – The contact information that will be provided in any notifications sent directly to users and groups. This can be an email, a phone number, a name, or some other form of contact information.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'contact': 'contact', 'direct_notifications_enabled': 'direct_notifications_enabled', 'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'contact': 'str', 'direct_notifications_enabled': 'bool', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.quota_setting_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.quota_setting_get_response.QuotaSettingGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[QuotaSetting]) – A list of quota settings objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[QuotaSetting]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.quota_setting_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.quota_setting_response.QuotaSettingResponse(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[QuotaSetting]) – A list of quota settings objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[QuotaSetting]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.rapid_data_locking module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.rapid_data_locking.RapidDataLocking(kmip_server=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__(kmip_server=None, enabled=None)
- Keyword Arguments
kmip_server (Reference) – The KMIP server configuration associated with RDL.
enabled (bool) – True if the Rapid Data Locking feature is enabled.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'enabled': 'enabled', 'kmip_server': 'kmip_server'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'kmip_server': 'Reference'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.rapid_data_locking_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.rapid_data_locking_response.RapidDataLockingResponse(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[RapidDataLocking]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[RapidDataLocking]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.reference module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.reference.Reference(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) – A name chosen by the user. Can be changed. Must be locally unique.
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 file system would have a resource_type of file-systems.
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', 'name': 'name', 'resource_type': 'resource_type'}
- 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.flashblade.FB_2_17.models.reference_name_only module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.reference_name_only.ReferenceNameOnly(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) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- 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.flashblade.FB_2_17.models.reference_writable module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.reference_writable.ReferenceWritable(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) – A name chosen by the user. Can be changed. Must be locally unique.
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 file system would have a resource_type of file-systems.
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', 'name': 'name', 'resource_type': 'resource_type'}
- 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.flashblade.FB_2_17.models.relationship_performance_replication module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.relationship_performance_replication.RelationshipPerformanceReplication(id=None, context=None, periodic=None, continuous=None, time=None, aggregate=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, periodic=None, continuous=None, time=None, aggregate=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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.
periodic (ReplicationPerformance) – Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based.
continuous (ContinuousReplicationPerformance) – Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication.
time (int) – Sample time in milliseconds since UNIX epoch.
aggregate (ReplicationPerformance) – Total bytes transmitted or received per second for all types of replication.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'aggregate': 'aggregate', 'context': 'context', 'continuous': 'continuous', 'id': 'id', 'periodic': 'periodic', 'time': 'time'}
- required_args = {}
- swagger_types = {'aggregate': 'ReplicationPerformance', 'context': 'Reference', 'continuous': 'ContinuousReplicationPerformance', 'id': 'str', 'periodic': 'ReplicationPerformance', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.remote_array module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
fleet (FixedReferenceWithIsLocal) –
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'}
- required_args = {}
- swagger_types = {'fleet': 'FixedReferenceWithIsLocal', '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.flashblade.FB_2_17.models.remote_arrays_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.remote_arrays_response.RemoteArraysResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[RemoteArray]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.replica_link_built_in module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.replica_link_built_in.ReplicaLinkBuiltIn(id=None, lag=None, status_details=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__(id=None, lag=None, status_details=None, direction=None)
- Keyword Arguments
id (str) – A non-modifiable, globally unique ID chosen by the system.
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.
status_details (str) – Detailed information about the status of the replica link when it is unhealthy.
direction (Direction) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'direction': 'direction', 'id': 'id', 'lag': 'lag', 'status_details': 'status_details'}
- required_args = {}
- swagger_types = {'direction': 'Direction', 'id': 'str', 'lag': 'int', 'status_details': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.replication_performance module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.replication_performance.ReplicationPerformance(transmitted_bytes_per_sec=None, received_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__(transmitted_bytes_per_sec=None, received_bytes_per_sec=None)
- Keyword Arguments
transmitted_bytes_per_sec (float) – Total bytes transmitted per second.
received_bytes_per_sec (float) – Total bytes 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', 'transmitted_bytes_per_sec': 'transmitted_bytes_per_sec'}
- required_args = {}
- swagger_types = {'received_bytes_per_sec': 'float', 'transmitted_bytes_per_sec': 'float'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.resource module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 name chosen by the user. Can be changed. Must be locally unique.
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', 'name': 'name'}
- 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.flashblade.FB_2_17.models.resource_fixed_non_unique_name module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.resource_performance_replication module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.resource_performance_replication.ResourcePerformanceReplication(name=None, id=None, periodic=None, continuous=None, time=None, aggregate=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, periodic=None, continuous=None, time=None, aggregate=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
periodic (ReplicationPerformance) – Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based.
continuous (ContinuousReplicationPerformance) – Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication.
time (int) – Sample time in milliseconds since UNIX epoch.
aggregate (ReplicationPerformance) – Total bytes transmitted or received per second for all types of replication.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'aggregate': 'aggregate', 'continuous': 'continuous', 'id': 'id', 'name': 'name', 'periodic': 'periodic', 'time': 'time'}
- required_args = {}
- swagger_types = {'aggregate': 'ReplicationPerformance', 'continuous': 'ContinuousReplicationPerformance', 'id': 'str', 'name': 'str', 'periodic': 'ReplicationPerformance', 'time': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.resource_performance_replication_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.resource_performance_replication_get_response.ResourcePerformanceReplicationGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
total (list[ResourcePerformanceReplication]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
items (list[ResourcePerformanceReplication]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total': 'total', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[ResourcePerformanceReplication]', 'total': 'list[ResourcePerformanceReplication]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.role module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.role.Role(name=None, id=None, permissions=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, permissions=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
permissions (list[Permission]) – A list of permissions that the role can perform.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', 'permissions': 'permissions'}
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'permissions': 'list[Permission]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.role_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.role_get_response.RoleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Role]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Role]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.saml2_sso module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.saml2_sso.Saml2Sso(name=None, id=None, idp=None, binding=None, services=None, prn=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, binding=None, services=None, prn=None, sp=None, enabled=None, array_url=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
idp (Saml2SsoIdp) –
binding (str) – SAML2 binding to use for the request from Flashblade to the Identity Provider. Valid values: http-redirect, none. Defaults to http-redirect.
services (list[str]) – Services that the SAML2 SSO authentication is used for. Valid values: management, object. Defaults to management.
prn (str) – Pure Resource Name of the identity provider
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', 'binding': 'binding', 'enabled': 'enabled', 'id': 'id', 'idp': 'idp', 'name': 'name', 'prn': 'prn', 'services': 'services', 'sp': 'sp'}
- required_args = {}
- swagger_types = {'array_url': 'str', 'binding': 'str', 'enabled': 'bool', 'id': 'str', 'idp': 'Saml2SsoIdp', 'name': 'str', 'prn': 'str', 'services': 'list[str]', 'sp': 'Saml2SsoSp'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.saml2_sso_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.saml2_sso_get_response.Saml2SsoGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Saml2Sso]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.saml2_sso_idp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.saml2_sso_idp.Saml2SsoIdp(verification_certificate=None, sign_request_enabled=None, metadata_url=None, encrypt_assertion_enabled=None, metadata_url_ca_certificate=None, metadata_url_ca_certificate_group=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, metadata_url_ca_certificate=None, metadata_url_ca_certificate_group=None, entity_id=None, url=None)
- Keyword Arguments
verification_certificate (ReferenceWritable) – The certificate used by the service provider to verify the SAML response signature from the identity provider. The credential is managed by the certificates endpoint and purecert CLI commands.
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.
metadata_url_ca_certificate (ReferenceWritable) – CA certificate used to validate the authenticity of the configured Identity Provider server.
metadata_url_ca_certificate_group (ReferenceWritable) – A certificate group containing CA certificates that can be used to validate the authenticity of the configured Identity Provider server.
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', 'metadata_url_ca_certificate': 'metadata_url_ca_certificate', 'metadata_url_ca_certificate_group': 'metadata_url_ca_certificate_group', 'sign_request_enabled': 'sign_request_enabled', 'url': 'url', 'verification_certificate': 'verification_certificate'}
- required_args = {}
- swagger_types = {'encrypt_assertion_enabled': 'bool', 'entity_id': 'str', 'metadata_url': 'str', 'metadata_url_ca_certificate': 'ReferenceWritable', 'metadata_url_ca_certificate_group': 'ReferenceWritable', 'sign_request_enabled': 'bool', 'url': 'str', 'verification_certificate': 'ReferenceWritable'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.saml2_sso_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.saml2_sso_post.Saml2SsoPost(idp=None, binding=None, services=None, prn=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__(idp=None, binding=None, services=None, prn=None, sp=None, enabled=None, array_url=None)
- Keyword Arguments
idp (Saml2SsoIdp) –
binding (str) – SAML2 binding to use for the request from Flashblade to the Identity Provider. Valid values: http-redirect, none. Defaults to http-redirect.
services (list[str]) – Services that the SAML2 SSO authentication is used for. Valid values: management, object. Defaults to management.
prn (str) – Pure Resource Name of the identity provider
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', 'binding': 'binding', 'enabled': 'enabled', 'idp': 'idp', 'prn': 'prn', 'services': 'services', 'sp': 'sp'}
- required_args = {}
- swagger_types = {'array_url': 'str', 'binding': 'str', 'enabled': 'bool', 'idp': 'Saml2SsoIdp', 'prn': 'str', 'services': 'list[str]', 'sp': 'Saml2SsoSp'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.saml2_sso_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.saml2_sso_sp module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 (ReferenceWritable) – 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 (ReferenceWritable) – 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'}
- required_args = {}
- swagger_types = {'assertion_consumer_url': 'str', 'decryption_credential': 'ReferenceWritable', 'entity_id': 'str', 'metadata_url': 'str', 'signing_credential': 'ReferenceWritable'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.saml2_sso_sp_credential module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 (ReferenceWritable) – 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 (ReferenceWritable) – 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'}
- required_args = {}
- swagger_types = {'decryption_credential': 'ReferenceWritable', 'signing_credential': 'ReferenceWritable'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.server module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.server.Server(name=None, id=None, directory_services=None, dns=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, directory_services=None, dns=None, created=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
directory_services (list[Reference]) – The directory service config to be used by this server.
dns (list[Reference]) – The DNS config to be used by this server.
created (int) – Creation timestamp of the server.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'created': 'created', 'directory_services': 'directory_services', 'dns': 'dns', 'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'created': 'int', 'directory_services': 'list[Reference]', 'dns': 'list[Reference]', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.server_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.server_context.ServerContext(name=None, id=None, directory_services=None, dns=None, created=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, directory_services=None, dns=None, created=None, context=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
directory_services (list[Reference]) – The directory service config to be used by this server.
dns (list[Reference]) – The DNS config to be used by this server.
created (int) – Creation timestamp of the server.
context (Reference) – 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', 'created': 'created', 'directory_services': 'directory_services', 'dns': 'dns', 'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'created': 'int', 'directory_services': 'list[Reference]', 'dns': 'list[Reference]', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.server_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.server_get_response.ServerGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[ServerContext]) – A list of server 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[ServerContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.server_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.server_post.ServerPost(directory_services=None, dns=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The key is attribute name and the value is json key in definition.
- Type
dict
- __eq__(other)
Returns true if both objects are equal
- __init__(directory_services=None, dns=None)
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'directory_services': 'directory_services', 'dns': 'dns'}
- required_args = {}
- swagger_types = {'directory_services': 'list[Reference]', 'dns': 'list[Reference]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.server_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.server_response.ServerResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[Server]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.server_response_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.server_response_context.ServerResponseContext(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[ServerContext]) – A list of server objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[ServerContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.session module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.session.Session(name=None, id=None, start_time=None, identifying_details=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, identifying_details=None, method=None, event_count=None, end_time=None, user_interface=None, location=None, event=None, user=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
start_time (int) – Date and time the user logged in to the Purity//FB interface in milliseconds since UNIX epoch.
identifying_details (str) – Additional details, depending on the authentication method used, which are necessary to uniquely identify who authenticated as a user. null if no additional details are needed.
method (str) – Method by which the user attempted to log in. Valid values include API token, password, ssh certificate, and public key.
event_count (int) – Number of session events.
end_time (int) – Date and time the user logged out of the Purity//FB interface in milliseconds since UNIX epoch. Set to 0 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. Valid values include failed authentication, user session, login, logout, API token obtained, and request without session.
user (str) – Username of the Purity//FB 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', 'identifying_details': 'identifying_details', 'location': 'location', 'method': 'method', 'name': 'name', 'start_time': 'start_time', 'user': 'user', 'user_interface': 'user_interface'}
- required_args = {}
- swagger_types = {'end_time': 'int', 'event': 'str', 'event_count': 'int', 'id': 'str', 'identifying_details': '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.flashblade.FB_2_17.models.session_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.session_get_response.SessionGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Session]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb.Smb(continuous_availability_enabled=None, share_policy=None, client_policy=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__(continuous_availability_enabled=None, share_policy=None, client_policy=None, enabled=None)
- Keyword Arguments
continuous_availability_enabled (bool) – If set to true, the file system will be continuously available during disruptive scenarios such as network disruption, blades failover, etc. If not specified, defaults to true.
share_policy (ReferenceWritable) – Deprecated. See File System Exports for newer functionality. The value returned will be the policy of the File System Export for the default server, and SMB, with the export_name matching the file system name, if there is one and null otherwise. Modifying this field will still work. If the current value is null, then setting this field will attempt to create a File System Export with the policy and other default values. The export_name will be the same as the file system’s name. If the current value is not null, then setting this field will change the policy in the matching File System Export. The SMB Share policy for the file system. Setting a policy here grants access permissions (e.g. allow or deny Full Control, Change, and/or Read) to the file system via SMB on a per-user / per-group basis. If no policy is set here, no user or group will have access. Use “” to clear.
client_policy (ReferenceWritable) – Deprecated. See File System Exports for newer functionality. The value returned will be the client_policy of the File System Export for the default server, and SMB, with the export_name matching the file system name, if there is one and null otherwise. Modifying this field will still work. If the current value is null, then setting this field will attempt to create a File System Export with the client_policy and other default values. The export_name will be the same as the file system’s name. If the current value is not null, then setting this field will change the client_policy in the matching File System Export. The SMB Client policy for the file system. Setting a policy here grants access permissions (e.g. read-only or read-write) to the file system via SMB on a per-client basis. If no policy is set here, no client will have access. Use “” to clear.
enabled (bool) – If set to true, enables access to the file system over the SMB protocol. If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client_policy': 'client_policy', 'continuous_availability_enabled': 'continuous_availability_enabled', 'enabled': 'enabled', 'share_policy': 'share_policy'}
- required_args = {}
- swagger_types = {'client_policy': 'ReferenceWritable', 'continuous_availability_enabled': 'bool', 'enabled': 'bool', 'share_policy': 'ReferenceWritable'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy.SmbClientPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, context=None, access_based_enumeration_enabled=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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, context=None, access_based_enumeration_enabled=None, rules=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
version (str) – A hash of the other properties of this resource. This can be used when updating the resource to ensure there aren’t any updates since the resource was read.
context (Reference) – 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.
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.
rules (list[SmbClientPolicyRuleInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order.
- __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', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'rules': 'rules', 'version': 'version'}
- required_args = {}
- swagger_types = {'access_based_enumeration_enabled': 'bool', 'context': 'Reference', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'rules': 'list[SmbClientPolicyRuleInPolicy]', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_get_response.SmbClientPolicyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[SmbClientPolicy]) – A list of SMB Client policy 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[SmbClientPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_post.SmbClientPolicyPost(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, access_based_enumeration_enabled=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__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, access_based_enumeration_enabled=None, rules=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
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.
rules (list[SmbClientPolicyRulePostInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order.
- __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', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'name': 'name', 'policy_type': 'policy_type', 'rules': 'rules'}
- required_args = {}
- swagger_types = {'access_based_enumeration_enabled': 'bool', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'name': 'str', 'policy_type': 'str', 'rules': 'list[SmbClientPolicyRulePostInPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_response.SmbClientPolicyResponse(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[SmbClientPolicy]) – A list of SMB Client policy objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[SmbClientPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule.SmbClientPolicyRule(name=None, id=None, policy_version=None, encryption=None, client=None, permission=None, policy=None, index=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, policy_version=None, encryption=None, client=None, permission=None, policy=None, index=None, context=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.
encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*).
permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro.
policy (FixedReference) – The policy to which this rule belongs.
index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.
context (Reference) – 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 = {'client': 'client', 'context': 'context', 'encryption': 'encryption', 'id': 'id', 'index': 'index', 'name': 'name', 'permission': 'permission', 'policy': 'policy', 'policy_version': 'policy_version'}
- required_args = {}
- swagger_types = {'client': 'str', 'context': 'Reference', 'encryption': 'str', 'id': 'str', 'index': 'int', 'name': 'str', 'permission': 'str', 'policy': 'FixedReference', 'policy_version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_base module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_base.SmbClientPolicyRuleBase(name=None, id=None, policy_version=None, encryption=None, client=None, permission=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, policy_version=None, encryption=None, client=None, permission=None, policy=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.
encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*).
permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro.
policy (FixedReference) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'encryption': 'encryption', 'id': 'id', 'name': 'name', 'permission': 'permission', 'policy': 'policy', 'policy_version': 'policy_version'}
- required_args = {}
- swagger_types = {'client': 'str', 'encryption': 'str', 'id': 'str', 'name': 'str', 'permission': 'str', 'policy': 'FixedReference', 'policy_version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_get_response.SmbClientPolicyRuleGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[SmbClientPolicyRule]) –
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[SmbClientPolicyRule]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_in_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_in_policy.SmbClientPolicyRuleInPolicy(name=None, id=None, policy_version=None, encryption=None, client=None, permission=None, policy=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, id=None, policy_version=None, encryption=None, client=None, permission=None, policy=None, index=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.
encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*).
permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro.
policy (FixedReference) – The policy to which this rule belongs.
index (int) – The index within the policy. The index indicates the order the rules are evaluated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'encryption': 'encryption', 'id': 'id', 'index': 'index', 'name': 'name', 'permission': 'permission', 'policy': 'policy', 'policy_version': 'policy_version'}
- required_args = {}
- swagger_types = {'client': 'str', 'encryption': 'str', 'id': 'str', 'index': 'int', 'name': 'str', 'permission': 'str', 'policy': 'FixedReference', 'policy_version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_post.SmbClientPolicyRulePost(name=None, id=None, encryption=None, client=None, permission=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, id=None, encryption=None, client=None, permission=None, index=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional. If not specified, defaults to optional.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*). 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 ro if not specified.
index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'encryption': 'encryption', 'id': 'id', 'index': 'index', 'name': 'name', 'permission': 'permission'}
- required_args = {}
- swagger_types = {'client': 'str', 'encryption': 'str', 'id': 'str', 'index': 'int', 'name': 'str', 'permission': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_post_base module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_post_base.SmbClientPolicyRulePostBase(name=None, id=None, encryption=None, client=None, permission=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, encryption=None, client=None, permission=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional. If not specified, defaults to optional.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*). 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 ro if not specified.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'encryption': 'encryption', 'id': 'id', 'name': 'name', 'permission': 'permission'}
- required_args = {}
- swagger_types = {'client': 'str', 'encryption': 'str', 'id': 'str', 'name': 'str', 'permission': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_post_in_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_post_in_policy.SmbClientPolicyRulePostInPolicy(name=None, id=None, encryption=None, client=None, permission=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, id=None, encryption=None, client=None, permission=None, index=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional. If not specified, defaults to optional.
client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*). 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 ro if not specified.
index (int) – The index within the policy. The index indicates the order the rules are evaluated.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client': 'client', 'encryption': 'encryption', 'id': 'id', 'index': 'index', 'name': 'name', 'permission': 'permission'}
- required_args = {}
- swagger_types = {'client': 'str', 'encryption': 'str', 'id': 'str', 'index': 'int', 'name': 'str', 'permission': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_client_policy_rule_response.SmbClientPolicyRuleResponse(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[SmbClientPolicyRule]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[SmbClientPolicyRule]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smb_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smb_post.SmbPost(continuous_availability_enabled=None, share_policy=None, client_policy=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__(continuous_availability_enabled=None, share_policy=None, client_policy=None, enabled=None)
- Keyword Arguments
continuous_availability_enabled (bool) – If set to true, the file system will be continuously available during disruptive scenarios such as network disruption, blades failover, etc. If not specified, defaults to true.
share_policy (ReferenceWritable) – The SMB Share policy for the file system. Setting a policy here grants access permissions (e.g. allow or deny Full Control, Change, and/or Read) to the file system via SMB on a per-user / per-group basis. Defaults to a pre-defined full access policy if none is specified.
client_policy (ReferenceWritable) – The SMB Client policy for the file system. Setting a policy here grants access permissions (e.g. read-only or read-write) to the file system via SMB on a per-client basis. Defaults to a pre-defined full access policy if none is specified.
enabled (bool) – If set to true, enables access to the file system over the SMB protocol. If not specified, defaults to false.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'client_policy': 'client_policy', 'continuous_availability_enabled': 'continuous_availability_enabled', 'enabled': 'enabled', 'share_policy': 'share_policy'}
- required_args = {}
- swagger_types = {'client_policy': 'ReferenceWritable', 'continuous_availability_enabled': 'bool', 'enabled': 'bool', 'share_policy': 'ReferenceWritable'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smtp_server module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smtp_server.SmtpServer(name=None, id=None, relay_host=None, encryption_mode=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, id=None, relay_host=None, encryption_mode=None, sender_domain=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
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.
encryption_mode (str) – Enforces an encryption mode when sending alert email messages. Valid values include starttls. Use “” to clear.
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 = {'encryption_mode': 'encryption_mode', 'id': 'id', 'name': 'name', 'relay_host': 'relay_host', 'sender_domain': 'sender_domain'}
- required_args = {}
- swagger_types = {'encryption_mode': 'str', 'id': 'str', 'name': 'str', 'relay_host': 'str', 'sender_domain': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smtp_server_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.smtp_server_get_response.SmtpServerGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SmtpServer]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.smtp_server_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.snmp_agent module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.snmp_agent.SnmpAgent(name=None, id=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, id=None, engine_id=None, v2c=None, v3=None, version=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
engine_id (str) – An SNMP agent’s adminstration domain unique name.
v2c (SnmpV2c) –
v3 (SnmpV3) –
version (str) – Version of the SNMP protocol to be used by an SNMP manager in communications with Purity’s SNMP agent. 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', 'id': 'id', 'name': 'name', 'v2c': 'v2c', 'v3': 'v3', 'version': 'version'}
- required_args = {}
- swagger_types = {'engine_id': 'str', '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.flashblade.FB_2_17.models.snmp_agent_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.snmp_agent_get_response.SnmpAgentGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SnmpAgent]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.snmp_agent_mib module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.snmp_agent_mib_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.snmp_agent_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.snmp_manager module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.snmp_manager.SnmpManager(name=None, id=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, id=None, notification=None, v2c=None, host=None, v3=None, version=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
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 is to send trap messages when it generates alerts.
v3 (SnmpV3) –
version (str) – Version of the SNMP protocol to be used by Purity 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 = {'host': 'host', 'id': 'id', 'name': 'name', 'notification': 'notification', 'v2c': 'v2c', 'v3': 'v3', 'version': 'version'}
- required_args = {}
- swagger_types = {'host': 'str', 'id': '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.flashblade.FB_2_17.models.snmp_manager_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.snmp_manager_get_response.SnmpManagerGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SnmpManager]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.snmp_manager_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 is to send trap messages when it generates alerts.
v3 (SnmpV3Post) –
version (str) – Version of the SNMP protocol to be used by Purity 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 = {'host': 'host', 'notification': 'notification', 'v2c': 'v2c', 'v3': 'v3', 'version': 'version'}
- 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.flashblade.FB_2_17.models.snmp_manager_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.snmp_manager_test module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.snmp_manager_test.SnmpManagerTest(name=None, id=None, error=None, sent=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, error=None, sent=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
error (str) – Error message (if failed).
sent (bool) – Is the test trap or inform sent?
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'error': 'error', 'id': 'id', 'name': 'name', 'sent': 'sent'}
- required_args = {}
- swagger_types = {'error': 'str', 'id': 'str', 'name': 'str', 'sent': 'bool'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.snmp_v2c module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 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'}
- 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.flashblade.FB_2_17.models.snmp_v3 module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 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 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'}
- 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.flashblade.FB_2_17.models.snmp_v3_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 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 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'}
- 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.flashblade.FB_2_17.models.software_check module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.software_checks_checks module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.software_checks_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.software_checks_get_response.SoftwareChecksGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SoftwareCheck]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.software_checks_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.space module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.space.Space(snapshots=None, total_physical=None, available_provisioned=None, data_reduction=None, shared=None, available_ratio=None, destroyed=None, virtual=None, unique=None, destroyed_virtual=None, total_provisioned=None, total_used=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, total_physical=None, available_provisioned=None, data_reduction=None, shared=None, available_ratio=None, destroyed=None, virtual=None, unique=None, destroyed_virtual=None, total_provisioned=None, total_used=None)
- Keyword Arguments
snapshots (int) – Physical usage by snapshots, other than unique in bytes.
total_physical (int) – Deprecated. See total_used for the newer functionality. The total physical space consumed by the file system, measured in bytes.
available_provisioned (int) – The amount of space left that the current object can grow before writes are stopped due to a hard limit quota being hit. This is total_provisioned minus the virtual space used for file-systems and buckets. For array and object store accounts it is total_provisioned minus the virtual space used by non-destroyed file-systems and buckets.
data_reduction (float) – Reduction of data.
shared (int) – The space contributed by data that is not unique to a managed directory, or snapshot, measured in bytes.
available_ratio (float) – The ratio of the available space versus the total provisioned space.
destroyed (int) – Unique physical space (excluding snapshots) occupied by destroyed data within the child containers, in bytes. For buckets and filesystems, the destroyed space will be 0 as they cannot have child containers. For the whole array, the space will be the sum of all destroyed buckets and filesystems.
virtual (int) – The amount of logically written data, in bytes. Excludes destroyed data.
unique (int) – Unique physical space occupied by customer data, in bytes. Excludes snapshots, destroyed.
destroyed_virtual (int) – The amount of destroyed logically written data within the child containers, in bytes. For buckets and filesystems, the destroyed virtual space will be 0 as they cannot have child containers. For the whole array, the space will be the sum of all destroyed buckets and filesystems.
total_provisioned (int) – The effective provisioned size of the container, at which a hard limit will be applied. For a bucket with a quota_limit value and hard_limit_enabled set to true, this is its quota_limit value, unless the available space of the associated object store account, as defined by its quota_limit value, would prevent the bucket from reaching its own quota_limit value. In such a case, total_provisioned will reflect the smaller value. For a file system with a provisioned value and hard_limit_enabled set to true, this is the provisioned value of the file system. For an object store account with a quota_limit value and hard_limit_enabled set to true, this is the quota_limit value of the object store account. For the array, this is the sum of the file systems and accounts. Measured in bytes.
total_used (int) – The total space consumed by customer data, measured in bytes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'available_provisioned': 'available_provisioned', 'available_ratio': 'available_ratio', 'data_reduction': 'data_reduction', 'destroyed': 'destroyed', 'destroyed_virtual': 'destroyed_virtual', 'shared': 'shared', 'snapshots': 'snapshots', 'total_physical': 'total_physical', 'total_provisioned': 'total_provisioned', 'total_used': 'total_used', 'unique': 'unique', 'virtual': 'virtual'}
- required_args = {}
- swagger_types = {'available_provisioned': 'int', 'available_ratio': 'float', 'data_reduction': 'float', 'destroyed': 'int', 'destroyed_virtual': 'int', 'shared': 'int', 'snapshots': 'int', 'total_physical': 'int', 'total_provisioned': 'int', 'total_used': 'int', 'unique': 'int', 'virtual': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.start_end_time module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.storage_class_info module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.storage_class_info.StorageClassInfo(name=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, status_details=None, status=None)
- Keyword Arguments
name (str) –
status_details (str) – Additional details about the status of the transition. If there is no transition ongoing, this field will be null.
status (str) – The status of the transition from the policy to the requested policy. If there is an ongoing transition, the status will be one of In-Progress or Queued. If there is no transition ongoing, this field will be null.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'status': 'status', 'status_details': 'status_details'}
- required_args = {}
- swagger_types = {'name': 'str', 'status': 'str', 'status_details': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.storage_class_space module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.storage_class_space.StorageClassSpace(name=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, time=None, space=None, capacity=None)
- Keyword Arguments
name (str) –
time (int) – Sample time in milliseconds since UNIX epoch.
space (Space) –
capacity (int) – Usable capacity in bytes.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'capacity': 'capacity', 'name': 'name', 'space': 'space', 'time': 'time'}
- required_args = {}
- swagger_types = {'capacity': 'int', '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.flashblade.FB_2_17.models.subnet module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.subnet.Subnet(name=None, id=None, link_aggregation_group=None, interfaces=None, vlan=None, prefix=None, services=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, id=None, link_aggregation_group=None, interfaces=None, vlan=None, prefix=None, services=None, enabled=None, gateway=None, mtu=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
link_aggregation_group (Reference) – Reference to the associated LAG.
interfaces (list[FixedReference]) – List of network interfaces associated with this subnet.
vlan (int) – VLAN ID.
prefix (str) – The IPv4 or IPv6 address to be associated with the specified subnet.
services (list[str]) – The services provided by this subnet, as inherited from all of its interfaces.
enabled (bool) – Indicates if subnet is enabled (true) or disabled (false). 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', 'id': 'id', 'interfaces': 'interfaces', 'link_aggregation_group': 'link_aggregation_group', 'mtu': 'mtu', 'name': 'name', 'prefix': 'prefix', 'services': 'services', 'vlan': 'vlan'}
- required_args = {}
- swagger_types = {'enabled': 'bool', 'gateway': 'str', 'id': 'str', 'interfaces': 'list[FixedReference]', 'link_aggregation_group': 'Reference', '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.flashblade.FB_2_17.models.subnet_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.subnet_get_response.SubnetGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[Subnet]) – A list of subnet objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Subnet]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.subnet_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.support module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.support.Support(name=None, id=None, proxy=None, phonehome_enabled=None, remote_assist_paths=None, remote_assist_status=None, remote_assist_duration=None, remote_assist_opened=None, remote_assist_active=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__(name=None, id=None, proxy=None, phonehome_enabled=None, remote_assist_paths=None, remote_assist_status=None, remote_assist_duration=None, remote_assist_opened=None, remote_assist_active=None, remote_assist_expires=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
proxy (str) –
phonehome_enabled (bool) –
remote_assist_paths (list[SupportRemoteAssistPaths]) –
remote_assist_status (str) – The status of the remote-assist sessions. Valid values are connected, partially_connected, reconnecting, and disconnected.
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_opened (str) – The time when the session opened.
remote_assist_active (bool) – The switch to open all remote-assist sessions.
remote_assist_expires (str) – The time when the session expires.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name', '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'}
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'phonehome_enabled': 'bool', 'proxy': 'str', 'remote_assist_active': 'bool', 'remote_assist_duration': 'int', 'remote_assist_expires': 'str', 'remote_assist_opened': 'str', '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.flashblade.FB_2_17.models.support_diagnostics module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.support_diagnostics.SupportDiagnostics(name=None, id=None, start_time=None, index=None, task_id=None, analysis_period=None, version=None, severity_count=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, index=None, task_id=None, analysis_period=None, version=None, severity_count=None, status=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
start_time (int) – Start time in milliseconds since the UNIX epoch.
index (int) – The unique index of the task.
task_id (str) – A globally unique, system-generated ID. The ID cannot be modified.
analysis_period (StartEndTime) –
version (str) – Version of diagnostics tool.
severity_count (list[SupportDiagnosticsSeverityCount]) – List of severity counts.
status (str) – Status of the diagnostics. A status of running indicates that the diagnostics is still running. A status of completed indicates that the diagnostics has completed. A status of failed indicates that the diagnostics has failed.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'analysis_period': 'analysis_period', 'id': 'id', 'index': 'index', 'name': 'name', 'severity_count': 'severity_count', 'start_time': 'start_time', 'status': 'status', 'task_id': 'task_id', 'version': 'version'}
- required_args = {}
- swagger_types = {'analysis_period': 'StartEndTime', 'id': 'str', 'index': 'int', 'name': 'str', 'severity_count': 'list[SupportDiagnosticsSeverityCount]', 'start_time': 'int', 'status': 'str', 'task_id': 'str', 'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.support_diagnostics_details module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.support_diagnostics_details.SupportDiagnosticsDetails(name=None, id=None, severity=None, index=None, task_id=None, test_name=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__(name=None, id=None, severity=None, index=None, task_id=None, test_name=None, result_details=None, test_type=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
severity (str) – Severity level of the test. Valid values include info, warning, critical.
index (float) – The unique index of the test. It will be of the format A.B where A is the task index and B is the test index.
task_id (str) – The task ID of the diagnostics for which this refers to.
test_name (str) – Name of the test that was performed.
result_details (str) – More details related to the test. This field can provide remediation information as well.
test_type (str) – Category to which the test belongs to.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'index': 'index', 'name': 'name', 'result_details': 'result_details', 'severity': 'severity', 'task_id': 'task_id', 'test_name': 'test_name', 'test_type': 'test_type'}
- required_args = {}
- swagger_types = {'id': 'str', 'index': 'float', 'name': 'str', 'result_details': 'str', 'severity': 'str', 'task_id': 'str', 'test_name': 'str', 'test_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.support_diagnostics_details_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.support_diagnostics_details_get_response.SupportDiagnosticsDetailsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SupportDiagnosticsDetails]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.support_diagnostics_details_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.support_diagnostics_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.support_diagnostics_get_response.SupportDiagnosticsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[SupportDiagnostics]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SupportDiagnostics]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.support_diagnostics_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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[SupportDiagnostics]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[SupportDiagnostics]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.support_diagnostics_severity_count module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.support_diagnostics_severity_count.SupportDiagnosticsSeverityCount(severity=None, 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__(severity=None, count=None)
- Keyword Arguments
severity (str) – Severity level of the test. Valid values include info, warning, critical.
count (int) – Count of the corresponding severity.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'count': 'count', 'severity': 'severity'}
- required_args = {}
- swagger_types = {'count': 'int', 'severity': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.support_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.support_get_response.SupportGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[Support]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.support_remote_assist_paths module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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 FM.
status (str) – The status of the remote-assist session on the local FM. Valid values are reconnecting, connected, disconnected, and unknown.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'component_name': 'component_name', 'status': 'status'}
- 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.flashblade.FB_2_17.models.support_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.syslog_server module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.syslog_server.SyslogServer(uri=None, services=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__(uri=None, services=None, name=None, id=None)
- Keyword Arguments
uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.
services (list[str]) – Valid values are data-audit and management. If not specified, defaults to management.
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
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', 'name': 'name', 'services': 'services', 'uri': 'uri'}
- required_args = {}
- swagger_types = {'id': 'str', 'name': 'str', 'services': 'list[str]', 'uri': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.syslog_server_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.syslog_server_context.SyslogServerContext(uri=None, services=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__(uri=None, services=None, name=None, id=None, context=None)
- Keyword Arguments
uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.
services (list[str]) – Valid values are data-audit and management. If not specified, defaults to management.
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
context (Reference) – 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', 'id': 'id', 'name': 'name', 'services': 'services', 'uri': 'uri'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'id': 'str', 'name': 'str', 'services': 'list[str]', 'uri': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.syslog_server_context_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.syslog_server_context_response.SyslogServerContextResponse(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[SyslogServerContext]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[SyslogServerContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.syslog_server_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.syslog_server_get_response.SyslogServerGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[SyslogServerContext]) –
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[SyslogServerContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.syslog_server_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.syslog_server_patch.SyslogServerPatch(uri=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__(uri=None, services=None)
- Keyword Arguments
uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.
services (list[str]) – Valid values are data-audit and management.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'services': 'services', 'uri': 'uri'}
- required_args = {}
- swagger_types = {'services': 'list[str]', 'uri': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.syslog_server_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.syslog_server_post.SyslogServerPost(uri=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__(uri=None, services=None)
- Keyword Arguments
uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.
services (list[str]) – Valid values are data-audit and management. If not specified, defaults to management.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'services': 'services', 'uri': 'uri'}
- required_args = {}
- swagger_types = {'services': 'list[str]', 'uri': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.syslog_server_post_or_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.syslog_server_post_or_patch.SyslogServerPostOrPatch(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__(uri=None)
- Keyword Arguments
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 = {'uri': 'uri'}
- required_args = {}
- swagger_types = {'uri': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.syslog_server_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.syslog_server_settings module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.syslog_server_settings.SyslogServerSettings(name=None, id=None, ca_certificate=None, ca_certificate_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, id=None, ca_certificate=None, ca_certificate_group=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
ca_certificate (object) –
ca_certificate_group (object) –
- __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', 'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'ca_certificate': 'object', 'ca_certificate_group': 'object', 'id': 'str', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.syslog_server_settings_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.syslog_server_settings_get_response.SyslogServerSettingsGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[SyslogServerSettings]) –
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[SyslogServerSettings]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.syslog_server_settings_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.target module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.target.Target(name=None, id=None, address=None, ca_certificate_group=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, address=None, ca_certificate_group=None, status_details=None, status=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
address (str) – IP address or FQDN of the target system.
ca_certificate_group (FixedReference) – The group of CA certificates that can be used, in addition to well-known Certificate Authority certificates, in order to establish a secure connection to the target system. Defaults to a reference to the _default_replication_certs group.
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 and connecting. connected - The connection is OK. connecting - No connection exists and the array is trying to reconnect to the target.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'address': 'address', 'ca_certificate_group': 'ca_certificate_group', 'id': 'id', 'name': 'name', 'status': 'status', 'status_details': 'status_details'}
- required_args = {}
- swagger_types = {'address': 'str', 'ca_certificate_group': 'FixedReference', 'id': 'str', 'name': 'str', 'status': 'str', 'status_details': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.target_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.target_get_response.TargetGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[TargetWithContext]) – A list of target 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[TargetWithContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.target_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.target_post.TargetPost(address=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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)
- Keyword Arguments
address (str) – IP address or FQDN of the target system.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'address': 'address'}
- required_args = {}
- swagger_types = {'address': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.target_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.target_response.TargetResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[Target]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.target_response_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.target_response_context.TargetResponseContext(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[TargetWithContext]) – A list of target objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[TargetWithContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.target_with_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.target_with_context.TargetWithContext(name=None, id=None, address=None, ca_certificate_group=None, status_details=None, status=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, address=None, ca_certificate_group=None, status_details=None, status=None, context=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
address (str) – IP address or FQDN of the target system.
ca_certificate_group (FixedReference) – The group of CA certificates that can be used, in addition to well-known Certificate Authority certificates, in order to establish a secure connection to the target system. Defaults to a reference to the _default_replication_certs group.
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 and connecting. connected - The connection is OK. connecting - No connection exists and the array is trying to reconnect to the target.
context (Reference) – 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 = {'address': 'address', 'ca_certificate_group': 'ca_certificate_group', 'context': 'context', 'id': 'id', 'name': 'name', 'status': 'status', 'status_details': 'status_details'}
- required_args = {}
- swagger_types = {'address': 'str', 'ca_certificate_group': 'FixedReference', 'context': 'Reference', 'id': 'str', 'name': 'str', 'status': 'str', 'status_details': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.test_result module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.test_result.TestResult(resource=None, 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__(resource=None, success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None)
- Keyword Arguments
resource (FixedReference) – A reference to the object being tested.
success (bool) – Returns a value of true if the specified test succeeded. Returns a value of false if the specified test 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) – Is the service enabled or not?
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.
- __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', 'resource': 'resource', 'result_details': 'result_details', 'success': 'success', 'test_type': 'test_type'}
- required_args = {}
- swagger_types = {'component_address': 'str', 'component_name': 'str', '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.flashblade.FB_2_17.models.test_result_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.test_result_get_response.TestResultGetResponse(items=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, total_item_count=None)
- Keyword Arguments
items (list[TestResult]) –
total_item_count (int) – Total number of items after applying filter params.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'items': 'list[TestResult]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.test_result_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.throttle module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.time_window module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.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'}
- 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.flashblade.FB_2_17.models.time_zone module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.time_zone.TimeZone(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) – Name of the object (e.g., a file system or snapshot).
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- 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.flashblade.FB_2_17.models.tls_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.tls_policy.TlsPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, enabled_tls_ciphers=None, appliance_certificate=None, min_tls_version=None, disabled_tls_ciphers=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, policy_type=None, location=None, is_local=None, enabled=None, enabled_tls_ciphers=None, appliance_certificate=None, min_tls_version=None, disabled_tls_ciphers=None)
- Keyword Arguments
name (str) – A name chosen by the user. Can be changed. Must be locally unique.
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
enabled_tls_ciphers (list[str]) – If specified, enables only the specified TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, the enabled ciphers must always contain at least one cipher for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on ciphers that are removed. If set to default, then the enabled ciphers may be automatically adjusted upon upgrade to newer software in order to align with the best known practices at the time of software release.
appliance_certificate (ReferenceWritable) – A reference to a certificate that will be presented as the server certificate in TLS negotiations with any clients that connect to appliance network addresses to which this policy applies.
min_tls_version (str) – The minimum TLS version that will be allowed for inbound connections on IPs to which this policy applies. Changing this setting can disrupt connections for any clients relying on older TLS versions that are disabled. If set to default, then the lowest TLS version permitted may be automatically raised upon upgrade to newer software in order to align with the best known practices at the time of software release. Configuring an explicit, low value can prevent upgrades to newer software versions that no longer support older TLS versions. Valid values include default, TLSv1.1, TLSv1.0, TLSv1.2, and TLSv1.3.
disabled_tls_ciphers (list[str]) – If specified, disables the specific TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, disabled ciphers must still result in at least one cipher being available for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on disabled ciphers.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'appliance_certificate': 'appliance_certificate', 'disabled_tls_ciphers': 'disabled_tls_ciphers', 'enabled': 'enabled', 'enabled_tls_ciphers': 'enabled_tls_ciphers', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'min_tls_version': 'min_tls_version', 'name': 'name', 'policy_type': 'policy_type'}
- required_args = {}
- swagger_types = {'appliance_certificate': 'ReferenceWritable', 'disabled_tls_ciphers': 'list[str]', 'enabled': 'bool', 'enabled_tls_ciphers': 'list[str]', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'min_tls_version': 'str', 'name': 'str', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.tls_policy_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.tls_policy_get_response.TlsPolicyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[TlsPolicy]) – A list of TLS policy objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[TlsPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.tls_policy_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.tls_policy_post.TlsPolicyPost(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, enabled_tls_ciphers=None, appliance_certificate=None, min_tls_version=None, disabled_tls_ciphers=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, policy_type=None, location=None, is_local=None, enabled=None, enabled_tls_ciphers=None, appliance_certificate=None, min_tls_version=None, disabled_tls_ciphers=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
enabled_tls_ciphers (list[str]) – If specified, enables only the specified TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, the enabled ciphers must always contain at least one cipher for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on ciphers that are removed. If set to default, then the enabled ciphers may be automatically adjusted upon upgrade to newer software in order to align with the best known practices at the time of software release.
appliance_certificate (ReferenceWritable) – A reference to a certificate that will be presented as the server certificate in TLS negotiations with any clients that connect to appliance network addresses to which this policy applies.
min_tls_version (str) – The minimum TLS version that will be allowed for inbound connections on IPs to which this policy applies. Changing this setting can disrupt connections for any clients relying on older TLS versions that are disabled. If set to default, then the lowest TLS version permitted may be automatically raised upon upgrade to newer software in order to align with the best known practices at the time of software release. Configuring an explicit, low value can prevent upgrades to newer software versions that no longer support older TLS versions. Valid values include default, TLSv1.1, TLSv1.0, TLSv1.2, and TLSv1.3.
disabled_tls_ciphers (list[str]) – If specified, disables the specific TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, disabled ciphers must still result in at least one cipher being available for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on disabled ciphers.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'appliance_certificate': 'appliance_certificate', 'disabled_tls_ciphers': 'disabled_tls_ciphers', 'enabled': 'enabled', 'enabled_tls_ciphers': 'enabled_tls_ciphers', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'min_tls_version': 'min_tls_version', 'name': 'name', 'policy_type': 'policy_type'}
- required_args = {}
- swagger_types = {'appliance_certificate': 'ReferenceWritable', 'disabled_tls_ciphers': 'list[str]', 'enabled': 'bool', 'enabled_tls_ciphers': 'list[str]', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'min_tls_version': 'str', 'name': 'str', 'policy_type': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.tls_policy_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.tls_policy_response.TlsPolicyResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[TlsPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.trust_policy_rule module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.trust_policy_rule.TrustPolicyRule(name=None, index=None, effect=None, principals=None, conditions=None, actions=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, index=None, effect=None, principals=None, conditions=None, actions=None, policy=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
index (int) – Index of the object in the containing array.
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. Valid values include allow.
principals (list[ReferenceWritable]) – List of Identity Providers
conditions (list[TrustPolicyRuleCondition]) – Conditions used to limit the scope which this rule applies to.
actions (list[str]) – The list of role-assumption actions granted by this rule to the respective role. Currently we support sts:AssumeRoleWithSAML and sts:AssumeRoleWithWebIdentity actions.
policy (FixedReference) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actions': 'actions', 'conditions': 'conditions', 'effect': 'effect', 'index': 'index', 'name': 'name', 'policy': 'policy', 'principals': 'principals'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'conditions': 'list[TrustPolicyRuleCondition]', 'effect': 'str', 'index': 'int', 'name': 'str', 'policy': 'FixedReference', 'principals': 'list[ReferenceWritable]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.trust_policy_rule_condition module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.trust_policy_rule_condition.TrustPolicyRuleCondition(values=None, key=None, 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__(values=None, key=None, operator=None)
- Keyword Arguments
values (list[str]) – Values to be compared with the values in the role assuming request context identified by the key. If multiple values are specified, it’s sufficient if just one matches.
key (str) – Key from the context of the role assuming request that will have its value compared based on the operator specified in this condition to the values provided in this condition.
operator (str) – Operator specifying the comparison to be done between the values from the request context and the values provided in this condition. Valid values: StringEquals.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'key': 'key', 'operator': 'operator', 'values': 'values'}
- required_args = {}
- swagger_types = {'key': 'str', 'operator': 'str', 'values': 'list[str]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.trust_policy_rule_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.trust_policy_rule_post.TrustPolicyRulePost(effect=None, principals=None, conditions=None, actions=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__(effect=None, principals=None, conditions=None, actions=None, policy=None)
- Keyword Arguments
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. Valid values include allow.
principals (list[ReferenceWritable]) – List of Identity Providers
conditions (list[TrustPolicyRuleCondition]) – Conditions used to limit the scope which this rule applies to.
actions (list[str]) – The list of role-assumption actions granted by this rule to the respective role. Currently we support sts:AssumeRoleWithSAML and sts:AssumeRoleWithWebIdentity actions.
policy (FixedReference) – The policy to which this rule belongs.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'actions': 'actions', 'conditions': 'conditions', 'effect': 'effect', 'policy': 'policy', 'principals': 'principals'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'conditions': 'list[TrustPolicyRuleCondition]', 'effect': 'str', 'policy': 'FixedReference', 'principals': 'list[ReferenceWritable]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.trust_policy_rule_with_context module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.trust_policy_rule_with_context.TrustPolicyRuleWithContext(name=None, index=None, effect=None, principals=None, conditions=None, actions=None, policy=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, index=None, effect=None, principals=None, conditions=None, actions=None, policy=None, context=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
index (int) – Index of the object in the containing array.
effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. Valid values include allow.
principals (list[ReferenceWritable]) – List of Identity Providers
conditions (list[TrustPolicyRuleCondition]) – Conditions used to limit the scope which this rule applies to.
actions (list[str]) – The list of role-assumption actions granted by this rule to the respective role. Currently we support sts:AssumeRoleWithSAML and sts:AssumeRoleWithWebIdentity actions.
policy (FixedReference) – The policy to which this rule belongs.
context (Reference) – 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 = {'actions': 'actions', 'conditions': 'conditions', 'context': 'context', 'effect': 'effect', 'index': 'index', 'name': 'name', 'policy': 'policy', 'principals': 'principals'}
- required_args = {}
- swagger_types = {'actions': 'list[str]', 'conditions': 'list[TrustPolicyRuleCondition]', 'context': 'Reference', 'effect': 'str', 'index': 'int', 'name': 'str', 'policy': 'FixedReference', 'principals': 'list[ReferenceWritable]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.user module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.user.User(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 user name that represents the user’s identity, and which resolves to the user’s id in a configured directory service.
id (int) – The numeric user id that represents the user’s identity in a POSIX system.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'id': 'id', 'name': 'name'}
- required_args = {}
- swagger_types = {'id': 'int', 'name': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.user_no_id module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.user_no_id.UserNoId(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 user name that represents the user’s identity, and which resolves to the user’s id in a configured directory service.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name'}
- 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.flashblade.FB_2_17.models.user_quota module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.user_quota.UserQuota(name=None, context=None, file_system=None, quota=None, usage=None, user=None, file_system_default_quota=None)
Bases:
object- swagger_types
The key is attribute name and the value is attribute type.
- Type
dict
- attribute_map
The 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, file_system=None, quota=None, usage=None, user=None, file_system_default_quota=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
context (Reference) – 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.
file_system (FixedReference) –
quota (int) – The limit of the quota (in bytes) for the specified user, cannot be 0. If specified, this value will override the file system’s default user quota.
usage (int) – The usage of the file system (in bytes) by the specified user.
user (User) – The user on which this quota is enforced.
file_system_default_quota (int) – File system’s default user quota (in bytes). If it is 0, it means there is no default quota. This will be the effective user quota if the user doesn’t have an individual quota. This default quota is set through the file-systems endpoint.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'context': 'context', 'file_system': 'file_system', 'file_system_default_quota': 'file_system_default_quota', 'name': 'name', 'quota': 'quota', 'usage': 'usage', 'user': 'user'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'file_system': 'FixedReference', 'file_system_default_quota': 'int', 'name': 'str', 'quota': 'int', 'usage': 'int', 'user': 'User'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.user_quota_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.user_quota_get_response.UserQuotaGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[UserQuota]) – A list of quota 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[UserQuota]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.user_quota_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.user_quota_patch.UserQuotaPatch(quota, 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__(quota, name=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
quota (int, required) – The limit of the quota (in bytes) for the specified user, cannot be 0. If specified, this value will override the file system’s default user quota.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'quota': 'quota'}
- required_args = {'quota'}
- swagger_types = {'name': 'str', 'quota': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.user_quota_post module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.user_quota_post.UserQuotaPost(quota, 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__(quota, name=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
quota (int, required) – The limit of the quota (in bytes) for the specified user, cannot be 0. If specified, this value will override the file system’s default user quota.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'name': 'name', 'quota': 'quota'}
- required_args = {'quota'}
- swagger_types = {'name': 'str', 'quota': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.user_quota_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.user_quota_response.UserQuotaResponse(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'}
- required_args = {}
- swagger_types = {'items': 'list[UserQuota]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.verification_key module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.verification_key.VerificationKey(key_id=None, name=None, verification_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__(key_id=None, name=None, verification_key=None)
- Keyword Arguments
key_id (int) – The key id of the verification key.
name (str) – Name of the verification key. Possible values include access.
verification_key (str) – The text of the verification key.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'key_id': 'key_id', 'name': 'name', 'verification_key': 'verification_key'}
- required_args = {}
- swagger_types = {'key_id': 'int', 'name': 'str', 'verification_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.verification_key_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.verification_key_get_response.VerificationKeyGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[VerificationKey]) – A list of verification key objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'items': 'list[VerificationKey]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.verification_key_patch module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.verification_key_patch.VerificationKeyPatch(signed_verification_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__(signed_verification_key=None)
- Keyword Arguments
signed_verification_key (str) – The text of the signed verification key.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'signed_verification_key': 'signed_verification_key'}
- required_args = {}
- swagger_types = {'signed_verification_key': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.verification_key_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.verification_key_response.VerificationKeyResponse(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[VerificationKey]) – A list of verification key objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[VerificationKey]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.version module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.version.Version(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 (str) – A hash of the other properties of this resource. This can be used when updating the resource to ensure there aren’t any updates since the resource was read.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'version': 'version'}
- required_args = {}
- swagger_types = {'version': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.worm_data_policies_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.worm_data_policies_get_response.WormDataPoliciesGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[WormDataPolicy]) – A list of worm data policy 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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[WormDataPolicy]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.worm_data_policies_members_get_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.worm_data_policies_members_get_response.WormDataPoliciesMembersGetResponse(continuation_token=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, 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).
total_item_count (int) – Total number of items after applying filter params.
items (list[PolicyMemberContext]) – A list of members for worm data policies.
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', 'total_item_count': 'total_item_count'}
- required_args = {}
- swagger_types = {'continuation_token': 'str', 'errors': 'list[ErrorContextResponseErrors]', 'items': 'list[PolicyMemberContext]', 'total_item_count': 'int'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.worm_data_policies_members_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.worm_data_policies_members_response.WormDataPoliciesMembersResponse(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[PolicyMemberContext]) – A list of members for worm data policies.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[PolicyMemberContext]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.worm_data_policies_response module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.worm_data_policies_response.WormDataPoliciesResponse(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[WormDataPolicy]) – A list of worm data policy objects.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'items': 'items'}
- required_args = {}
- swagger_types = {'items': 'list[WormDataPolicy]'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.worm_data_policy module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.worm_data_policy.WormDataPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, mode=None, default_retention=None, max_retention=None, min_retention=None, retention_lock=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, policy_type=None, location=None, is_local=None, enabled=None, mode=None, default_retention=None, max_retention=None, min_retention=None, retention_lock=None, context=None)
- Keyword Arguments
name (str) – Name of the object (e.g., a file system or snapshot).
id (str) – A non-modifiable, globally unique ID chosen by the system.
policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.
location (FixedReference) – Reference to the array where the policy is defined.
is_local (bool) – Whether the policy is defined on the local array.
enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.
mode (str) – The type of the retention lock. Valid values is compliance.
default_retention (int) – Default retention period, in milliseconds. If the access time is not specified when committing a file, then the default retention period is applied.
max_retention (int) – Maximum retention period, in milliseconds.
min_retention (int) – Minimum retention period, in milliseconds.
retention_lock (str) – If set to locked, then the value of retention attributes or policy attributes are not allowed to change. If set to unlocked, then the value of the retention attributes and policy attributes are allowed to change. Valid values are unlocked and locked. It is always allowed to change from unlocked to locked. Contact Pure Technical Services to change from locked to unlocked.
context (Reference) – 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', 'default_retention': 'default_retention', 'enabled': 'enabled', 'id': 'id', 'is_local': 'is_local', 'location': 'location', 'max_retention': 'max_retention', 'min_retention': 'min_retention', 'mode': 'mode', 'name': 'name', 'policy_type': 'policy_type', 'retention_lock': 'retention_lock'}
- required_args = {}
- swagger_types = {'context': 'Reference', 'default_retention': 'int', 'enabled': 'bool', 'id': 'str', 'is_local': 'bool', 'location': 'FixedReference', 'max_retention': 'int', 'min_retention': 'int', 'mode': 'str', 'name': 'str', 'policy_type': 'str', 'retention_lock': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
pypureclient.flashblade.FB_2_17.models.worm_data_policy_retention_config module
FlashBlade REST API
A lightweight client for FlashBlade REST API 2.17, developed by Pure Storage, Inc. (http://www.purestorage.com/).
OpenAPI spec version: 2.17
Generated by: https://github.com/swagger-api/swagger-codegen.git
- class pypureclient.flashblade.FB_2_17.models.worm_data_policy_retention_config.WormDataPolicyRetentionConfig(mode=None, default_retention=None, max_retention=None, min_retention=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__(mode=None, default_retention=None, max_retention=None, min_retention=None, retention_lock=None)
- Keyword Arguments
mode (str) – The type of the retention lock. Valid values is compliance.
default_retention (int) – Default retention period, in milliseconds. If the access time is not specified when committing a file, then the default retention period is applied.
max_retention (int) – Maximum retention period, in milliseconds.
min_retention (int) – Minimum retention period, in milliseconds.
retention_lock (str) – If set to locked, then the value of retention attributes or policy attributes are not allowed to change. If set to unlocked, then the value of the retention attributes and policy attributes are allowed to change. Valid values are unlocked and locked. It is always allowed to change from unlocked to locked. Contact Pure Technical Services to change from locked to unlocked.
- __ne__(other)
Returns true if both objects are not equal
- __repr__()
For print and pprint
- attribute_map = {'default_retention': 'default_retention', 'max_retention': 'max_retention', 'min_retention': 'min_retention', 'mode': 'mode', 'retention_lock': 'retention_lock'}
- required_args = {}
- swagger_types = {'default_retention': 'int', 'max_retention': 'int', 'min_retention': 'int', 'mode': 'str', 'retention_lock': 'str'}
- to_dict()
Returns the model properties as a dict
- to_str()
Returns the string representation of the model
Module contents
- class pypureclient.flashblade.FB_2_17.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.flashblade.FB_2_17.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.flashblade.FB_2_17.models.quoteStrings(s)