FlashBlade Reference

Client

FlashBlade REST Client Factory Method

pypureclient.flashblade.client.Client(target, version='2.0', id_token=None, private_key_file=None, private_key_password=None, username=None, client_id=None, key_id=None, issuer=None, api_token=None, retries=5, timeout=15.0, ssl_cert=None, user_agent=None)

Initialize a FlashBlade Client.

Keyword Arguments:
 
  • target (str, required) – The target array’s IP or hostname.
  • version (str, optional) – REST API version to use. Defaults to the most recent version.
  • id_token (str, optional) – The security token that represents the identity of the party on behalf of whom the request is being made, issued by an enabled API client on the array. Overrides given private key.
  • private_key_file (str, optional) – The path of the private key to use. Defaults to None.
  • private_key_password (str, optional) – The password of the private key. Defaults to None.
  • username (str, optional) – Username of the user the token should be issued for. This must be a valid user in the system.
  • client_id (str, optional) – ID of API client that issued the identity token.
  • key_id (str, optional) – Key ID of API client that issued the identity token.
  • issuer (str, optional) – API client’s trusted identity issuer on the array.
  • api_token (str, optional) – API token for the user.
  • retries (int, optional) – The number of times to retry an API call if it fails for a non-blocking reason. Defaults to 5.
  • timeout (float or (float, float), optional) – The timeout duration in seconds, either in total time or (connect and read) times. Defaults to 15.0 total.
  • ssl_cert (str, optional) – SSL certificate to use. Defaults to None.
  • user_agent (str, optional) – User-Agent request header to use.
Raises:

PureError – If it could not create an ID or access token

Importable as

from pypureclient.flashblade import Client

FlashBlade REST 2.0 Client

class pypureclient.flashblade.FB_2_0.client.Client(target, id_token=None, private_key_file=None, private_key_password=None, username=None, client_id=None, key_id=None, issuer=None, api_token=None, retries=5, timeout=15.0, ssl_cert=None, user_agent=None)

Properties

Property

class pypureclient.flashblade.Property(value)

A Property object models a property of a resource and allows for easy compounding, sorting, and filtering with them. It is converted to a string when calling any API and can also be replaced by a string.

__add__(other)

The + operator. Create a subproperty.

Parameters:other (Property) – The Property to be the subproperty of the given Property.
Returns:Property
Raises:PureError – If other is not of the proper type.
__eq__(other)

The == operator. Create a Filter that checks for equality.

Parameters:other (str, int, bool) – The value to compare to.
Returns:Filter
Raises:PureError – If other is not of the proper type.
__ge__(other)

The >= operator. Create a Filter that checks for greater than or equal.

Parameters:other (str, int) – The value to compare to.
Returns:Filter
Raises:PureError – If other is not of the proper type.
__getitem__(index)

The [] operator. Create a list Property with the given index.

Parameters:index (str) – The list index to use.
Returns:Property
Raises:PureError – If index is not “all” or “any”.
__gt__(other)

The > operator. Create a Filter that checks for greater than.

Parameters:other (str, int) – The value to compare to.
Returns:Filter
Raises:PureError – If other is not of the proper type.
__init__(value)

Initialize a Property.

Parameters:value (str) – The name of the property.
__le__(other)

The <= operator. Create a Filter that checks for less than or equal.

Parameters:other (str, int) – The value to compare to.
Returns:Filter
Raises:PureError – If other is not of the proper type.
__lt__(other)

The < operator. Create a Filter that checks for less than.

Parameters:other (str, int) – The value to compare to.
Returns:Filter
Raises:PureError – If other is not of the proper type.
__ne__(other)

The != operator. Create a Filter that checks for inequality.

Parameters:other (str, int, bool) – The value to compare to.
Returns:Filter
Raises:PureError – If other is not of the proper type.
__repr__()

Return the string value of the Property.

Returns:str
all()

Create a list Property indexed by “all”.

Returns:Property
any()

Create a list Property indexed by “any”.

Returns:Property
ascending()

Create a Property that can be sorted in ascending order.

Returns:Property
descending()

Create a property that can be sorted in descending order.

Returns:Property
exists()

Create a Filter that checks for existance of the given Property.

Returns:Filter
subproperty(other)

Create a subproperty.

Parameters:other (Property) – The Property to be the subproperty of the given Property.
Returns:Property
Raises:PureError – If other is not of the proper type.

Filter

class pypureclient.flashblade.Filter(operation, operand1, operand2=None)

A Filter object models a filter string by keeping track of operations between Properties, values, and other Filters. It is converted to a string when calling any API and can also be replaced by a string.

__and__(other)

The & operator. Create a Filter that is the AND of two Filters.

Parameters:other (Filter) – The Filter to AND.
Returns:Filter
Raises:PureError – If other is not of the proper type.
__init__(operation, operand1, operand2=None)

Initialize a Filter. Should not be used directly. Instead, use the static methods to create Filters.

Parameters:
  • operation (_Operation) – The operation.
  • operand1 (any) – The first operand.
  • operand2 (any, optional) – The second operand, if the operation is binary. Defaults to None.
__invert__()

The ~ operator. Create a Filter that is the inverse of another Filter.

Returns:Filter
__or__(other)

The | operator. Create a Filter that is the OR of two Filters.

Parameters:other (Filter) – The Filter to OR.
Returns:Filter
Raises:PureError – If other is not of the proper type.
__repr__()

Return the string value of the Filter.

Returns:str
static and_(operand1, operand2)

Create a Filter that is the AND of two Filters.

Parameters:
  • operand1 (Filter) – The first Filter.
  • operand2 (Filter) – The second Filter.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static contains(operand1, operand2)

Create a Filter that checks for substring containment.

Parameters:
  • operand1 (Property, str) – The Property to check.
  • operand2 (str) – The value to check for.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static eq(operand1, operand2)

Create a Filter that checks for equality.

Parameters:
  • operand1 (Property, str) – The Property to compare.
  • operand2 (str, int, bool) – The value to compare to.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static exists(operand1)

Create a Filter that checks for existance of a Property.

Parameters:operand1 (Property, str) – The Property to check for.
Returns:Filter
Raises:PureError – If the operand is not of the proper type.
static ge(operand1, operand2)

Create a Filter that checks for greater than or equal.

Parameters:
  • operand1 (Property, str) – The Property to compare.
  • operand2 (str, int) – The value to compare to.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static gt(operand1, operand2)

Create a Filter that checks for greater than.

Parameters:
  • operand1 (Property, str) – The Property to compare.
  • operand2 (str, int) – The value to compare to.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static in_(operand1, operand2)

Create a Filter that checks if a Property is in a list of values.

Parameters:
  • operand1 (Property, str) – The Property to check.
  • operand2 (list[str], list[int]) – The list of values.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static le(operand1, operand2)

Create a Filter that checks for less than or equal.

Parameters:
  • operand1 (Property, str) – The Property to compare.
  • operand2 (str, int) – The value to compare to.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static lt(operand1, operand2)

Create a Filter that checks for less than.

Parameters:
  • operand1 (Property, str) – The Property to compare.
  • operand2 (str, int) – The value to compare to.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static ne(operand1, operand2)

Create a Filter that checks for inequality.

Parameters:
  • operand1 (Property, str) – The Property to compare.
  • operand2 (str, int, bool) – The value to compare to.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static not_(operand1)

Create a Filter that is the inverse of another Filter.

Parameters:operand1 (Filter) – The Filter to invert.
Returns:Filter
Raises:PureError – If the operand is not of the proper type.
static or_(operand1, operand2)

Create a Filter that is the OR of two Filters.

Parameters:
  • operand1 (Filter) – The first Filter.
  • operand2 (Filter) – The second Filter.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

static tags(operand1, operand2)

Create a Filter that checks for a key-value tag.

Parameters:
  • operand1 (str) – The key of the tag.
  • operand2 (str) – The value of the tag.
Returns:

Filter

Raises:

PureError – If either operand is not of the proper type.

Responses

ResponseHeaders

class pypureclient.flashblade.ResponseHeaders(x_request_id, x_ratelimit_limit_second, x_ratelimit_limit_minute, x_ratelimit_remaining_second, x_ratelimit_remaining_minute)

An object that includes headers from the server response.

__init__(x_request_id, x_ratelimit_limit_second, x_ratelimit_limit_minute, x_ratelimit_remaining_second, x_ratelimit_remaining_minute)

Initialize a ResponseHeaders.

Parameters:
  • x_request_id (str) – The X-Request-ID from the client or generated by the server.
  • x_ratelimit_limit_second (int) – The number of requests available per second.
  • x_ratelimit_limit_minute (int) – The number of requests available per minute.
  • x_ratelimit_remaining_second (int) – The number of requests remaining in that second.
  • x_ratelimit_remaining_minute (int) – The number of requests remaining in that minute.
__repr__()

Return a pretty formatted string of the object.

Returns:str
to_dict()

Return a dictionary of the class attributes.

Returns:dict

ValidResponse

class pypureclient.flashblade.ValidResponse(status_code, continuation_token, total_item_count, items, headers, total=None, more_items_remaining=None)

A response that indicates the request was successful and has the returned data.

__init__(status_code, continuation_token, total_item_count, items, headers, total=None, more_items_remaining=None)

Initialize a ValidResponse.

Parameters:
  • status_code (int) – The HTTP status code.
  • continuation_token (str) – An opaque token to iterate over a collection of resources. May be None.
  • total_item_count (int) – The total number of items available in the collection.
  • items (ItemIterator) – An iterator over the items in the collection.
  • headers (dict) – Response headers from the server.
__repr__()

Return a pretty formatted string of the object. Does not convert the items to a list of items by using the iterator.

Returns:str
to_dict()

Return a dictionary of the class attributes. It will convert the items to a list of items by exhausting the iterator. If any items were previously iterated, they will be missed.

Returns:dict

ApiError

class pypureclient.flashblade.ApiError(context, message)

An object that models the error response from the server.

__init__(context, message)

Initialize an ApiError.

Parameters:
  • context (str) – The context in which the error occurred.
  • message (str) – The error message.
__repr__()

Return a pretty formatted string of the object.

Returns:str
to_dict()

Return a dictionary of the class attributes.

Returns:dict

ErrorResponse

class pypureclient.flashblade.ErrorResponse(status_code, errors, headers)

A response that indicates there was an error with the request and has the list of errors.

__init__(status_code, errors, headers)

Initialize an ErrorResponse.

Parameters:
  • status_code (int) – The HTTP status code.
  • errors (list[ApiError]) – The list of errors encountered.
  • headers (dict) – Response headers from the server.
__repr__()

Return a pretty formatted string of the object.

Returns:str
to_dict()

Return a dictionary of the class attributes.

Returns:dict

Models

ActiveDirectory

class pypureclient.flashblade.ActiveDirectory(name=None, id=None, computer_name=None, directory_servers=None, domain=None, encryption_types=None, join_ou=None, kerberos_servers=None, service_principal_names=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, computer_name=None, directory_servers=None, domain=None, encryption_types=None, join_ou=None, kerberos_servers=None, service_principal_names=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.
  • 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.
  • 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.
  • domain (str) – The Active Directory domain to join.
  • encryption_types (list[str]) – The encryption types that are supported for use by clients for Kerberos authentication.
  • join_ou (str) – The relative distinguished name of the organizational unit in which the computer account was created when joining the domain.
  • 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.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ActiveDirectoryPatch

class pypureclient.flashblade.ActiveDirectoryPatch(directory_servers=None, encryption_types=None, fqdns=None, join_ou=None, kerberos_servers=None, service_principal_names=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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_servers=None, encryption_types=None, fqdns=None, join_ou=None, kerberos_servers=None, service_principal_names=None)
Keyword Arguments:
 
  • 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.
  • 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.
  • join_ou (str) – The relative distinguished name of the organizational unit in which the computer account should be created when joining the domain.
  • 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.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ActiveDirectoryPost

class pypureclient.flashblade.ActiveDirectoryPost(domain, password, user, computer_name=None, directory_servers=None, encryption_types=None, fqdns=None, join_ou=None, kerberos_servers=None, service_principal_names=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(domain, password, user, computer_name=None, directory_servers=None, encryption_types=None, fqdns=None, join_ou=None, kerberos_servers=None, service_principal_names=None)
Keyword Arguments:
 
  • 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.
  • 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.
  • domain (str, required) – The Active Directory domain to join.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Admin

class pypureclient.flashblade.Admin(name=None, id=None, api_token=None, is_local=None, public_key=None, role=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, api_token=None, is_local=None, public_key=None, role=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.
  • api_token (ApiToken) –
  • is_local (bool) – Returns a value of true if the user is local to the machine, otherwise false.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AdminApiToken

class pypureclient.flashblade.AdminApiToken(admin=None, api_token=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(admin=None, api_token=None)
Keyword Arguments:
 
  • admin (Reference) – A reference to the admin to whom this token belongs.
  • api_token (ApiToken) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AdminCache

class pypureclient.flashblade.AdminCache(name=None, id=None, role=None, time=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AdminPatch

class pypureclient.flashblade.AdminPatch(old_password=None, password=None, public_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(old_password=None, password=None, public_key=None)
Keyword Arguments:
 
  • old_password (str) – Old user password.
  • password (str) – New user password.
  • public_key (str) – Public key for SSH access. Supported key types are Ed25519 and RSA.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Alert

class pypureclient.flashblade.Alert(name=None, id=None, action=None, code=None, component_name=None, component_type=None, created=None, description=None, flagged=None, index=None, knowledge_base_url=None, notified=None, severity=None, state=None, summary=None, updated=None, variables=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, action=None, code=None, component_name=None, component_type=None, created=None, description=None, flagged=None, index=None, knowledge_base_url=None, notified=None, severity=None, state=None, summary=None, updated=None, variables=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.
  • action (str) – The action of the alert.
  • code (int) – Alert code.
  • component_name (str) – The component name of the alert.
  • component_type (str) – The component type of the alert.
  • created (int) – The creation timestamp of the alert.
  • description (str) – The description of the alert.
  • flagged (bool) – Flagged state of the alert.
  • index (int) – The unique index of the alert.
  • knowledge_base_url (str) – URL of the relevant Knowledge Base page.
  • notified (int) – The last notification timestamp of the alert.
  • severity (str) – Severity of the alert. Valid values are info, warning, and critical.
  • state (str) – The current state of the alert. Valid values are open, closing, closed, and waiting to downgrade.
  • summary (str) – The summary of the alert.
  • updated (int) – The last updated timestamp of the alert.
  • variables (dict(str, str)) – Key-value pairs of additional information of the alert.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AlertWatcher

class pypureclient.flashblade.AlertWatcher(name=None, id=None, enabled=None, minimum_notification_severity=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, enabled=None, minimum_notification_severity=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.
  • enabled (bool) – Is email notification enabled? If not specified, defaults to true.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AlertWatcherPost

class pypureclient.flashblade.AlertWatcherPost(minimum_notification_severity=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ApiClient

class pypureclient.flashblade.ApiClient(name=None, id=None, access_token_ttl_in_ms=None, enabled=None, issuer=None, key_id=None, max_role=None, public_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, access_token_ttl_in_ms=None, enabled=None, issuer=None, key_id=None, max_role=None, public_key=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.
  • access_token_ttl_in_ms (int) – The TTL (Time To Live) duration for which the exchanged access token is valid. Measured in milliseconds.
  • 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.
  • 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.
  • 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.
  • public_key (str) – The API client’s PEM formatted (Base64 encoded) RSA public key.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ApiClientsPost

class pypureclient.flashblade.ApiClientsPost(max_role, public_key, access_token_ttl_in_ms=None, issuer=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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_role, public_key, access_token_ttl_in_ms=None, issuer=None)
Keyword Arguments:
 
  • 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.
  • 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.
  • max_role (Reference, 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.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ApiToken

class pypureclient.flashblade.ApiToken(created_at=None, expires_at=None, token=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(created_at=None, expires_at=None, token=None)
Keyword Arguments:
 
  • created_at (int) – Creation time in milliseconds since the UNIX epoch.
  • expires_at (int) – Expiration time in milliseconds since the UNIX epoch.
  • token (str) – An Admin API token. A newly-created token is visible as the result of the POST operation which created it. An existing token is visible when expose_api_token is true and it is being requested by the user to whom it belongs. In all other cases, the token will be masked.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ApiVersion

class pypureclient.flashblade.ApiVersion(versions=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Array

class pypureclient.flashblade.Array(name=None, id=None, as_of=None, banner=None, idle_timeout=None, ntp_servers=None, os=None, revision=None, time_zone=None, version=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, as_of=None, banner=None, idle_timeout=None, ntp_servers=None, os=None, revision=None, time_zone=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.
  • as_of (int) – Array time in milliseconds since UNIX epoch.
  • banner (str) – A string to be shown when logging in to the array.
  • idle_timeout (int) – Idle timeout in milliseconds. Valid values are in the range of 300000 and 10800000. Setting this value to 0 disables timeouts.
  • ntp_servers (list[str]) –
  • os (str) – Valid values are Purity//FA and Purity//FB.
  • revision (str) –
  • 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.
  • version (str) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayConnection

class pypureclient.flashblade.ArrayConnection(id=None, ca_certificate_group=None, encrypted=None, management_address=None, remote=None, replication_addresses=None, status=None, version=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, ca_certificate_group=None, encrypted=None, management_address=None, remote=None, replication_addresses=None, status=None, version=None)
Keyword Arguments:
 
  • id (str) – A non-modifiable, globally unique ID chosen by the 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 array. Defaults to a reference to the _default_replication_certs group if secure_connection is true, or null otherwise.
  • 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.
  • management_address (str) – Management address of the target array. Settable on POST only.
  • remote (FixedReferenceNoResourceType) – The remote array.
  • 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.
  • status (str) – Status of the connection. Valid values are 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.
  • version (str) – The version of the target array.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayConnectionKey

class pypureclient.flashblade.ArrayConnectionKey(connection_key=None, created=None, expires=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(connection_key=None, created=None, expires=None)
Keyword Arguments:
 
  • connection_key (str) – Connection-key, used on another array to connect to this array. After creation, listing will only show ****.
  • created (int) – Creation time in milliseconds since UNIX epoch.
  • expires (int) – Expiration time in milliseconds since UNIX epoch.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayConnectionPath

class pypureclient.flashblade.ArrayConnectionPath(id=None, destination=None, remote=None, source=None, status=None, status_details=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, destination=None, remote=None, source=None, status=None, status_details=None)
Keyword Arguments:
 
  • id (str) – A non-modifiable, globally unique ID chosen by the system.
  • destination (str) – IP address with the port of the target array.
  • remote (FixedReferenceNoResourceType) – The remote array.
  • source (str) – IP address of the source array.
  • 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.
  • status_details (str) – Additional information describing any issues encountered when connecting, or null if the status is connected.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayConnectionPost

class pypureclient.flashblade.ArrayConnectionPost(id=None, ca_certificate_group=None, encrypted=None, management_address=None, remote=None, replication_addresses=None, status=None, version=None, connection_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, ca_certificate_group=None, encrypted=None, management_address=None, remote=None, replication_addresses=None, status=None, version=None, connection_key=None)
Keyword Arguments:
 
  • id (str) – A non-modifiable, globally unique ID chosen by the 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 array. Defaults to a reference to the _default_replication_certs group if secure_connection is true, or null otherwise.
  • 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.
  • management_address (str) – Management address of the target array. Settable on POST only.
  • remote (FixedReferenceNoResourceType) – The remote array.
  • 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.
  • status (str) – Status of the connection. Valid values are 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.
  • version (str) – The version of the target array.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayHttpSpecificPerformance

class pypureclient.flashblade.ArrayHttpSpecificPerformance(name=None, id=None, others_per_sec=None, read_dirs_per_sec=None, read_files_per_sec=None, write_dirs_per_sec=None, write_files_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_dir_op=None, usec_per_read_file_op=None, usec_per_write_dir_op=None, usec_per_write_file_op=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, others_per_sec=None, read_dirs_per_sec=None, read_files_per_sec=None, write_dirs_per_sec=None, write_files_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_dir_op=None, usec_per_read_file_op=None, usec_per_write_dir_op=None, usec_per_write_file_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.
  • others_per_sec (float) – Other operations processed per second.
  • read_dirs_per_sec (float) – Read directory requests processed per second.
  • read_files_per_sec (float) – Read file requests processed per second.
  • write_dirs_per_sec (float) – Write directory requests processed per second.
  • write_files_per_sec (float) – Write file requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
  • usec_per_read_dir_op (float) – Average time, measured in microseconds, it takes the array to process a read directory request.
  • usec_per_read_file_op (float) – Average time, measured in microseconds, it takes the array to process a read file request.
  • usec_per_write_dir_op (float) – Average time, measured in microseconds, it takes the array to process a write directory request.
  • usec_per_write_file_op (float) – Average time, measured in microseconds, it takes the array to process a write file request.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayHttpSpecificPerformanceGet

class pypureclient.flashblade.ArrayHttpSpecificPerformanceGet(continuation_token=None, total_item_count=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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[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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayNfsSpecificPerformance

class pypureclient.flashblade.ArrayNfsSpecificPerformance(name=None, id=None, accesses_per_sec=None, aggregate_file_metadata_creates_per_sec=None, aggregate_file_metadata_modifies_per_sec=None, aggregate_file_metadata_reads_per_sec=None, aggregate_other_per_sec=None, aggregate_share_metadata_reads_per_sec=None, aggregate_usec_per_file_metadata_create_op=None, aggregate_usec_per_file_metadata_modify_op=None, aggregate_usec_per_file_metadata_read_op=None, aggregate_usec_per_other_op=None, aggregate_usec_per_share_metadata_read_op=None, creates_per_sec=None, fsinfos_per_sec=None, fsstats_per_sec=None, getattrs_per_sec=None, links_per_sec=None, lookups_per_sec=None, mkdirs_per_sec=None, pathconfs_per_sec=None, reads_per_sec=None, readdirs_per_sec=None, readdirpluses_per_sec=None, readlinks_per_sec=None, removes_per_sec=None, renames_per_sec=None, rmdirs_per_sec=None, setattrs_per_sec=None, symlinks_per_sec=None, time=None, writes_per_sec=None, usec_per_access_op=None, usec_per_create_op=None, usec_per_fsinfo_op=None, usec_per_fsstat_op=None, usec_per_getattr_op=None, usec_per_link_op=None, usec_per_lookup_op=None, usec_per_mkdir_op=None, usec_per_pathconf_op=None, usec_per_read_op=None, usec_per_readdir_op=None, usec_per_readdirplus_op=None, usec_per_readlink_op=None, usec_per_remove_op=None, usec_per_rename_op=None, usec_per_rmdir_op=None, usec_per_setattr_op=None, usec_per_symlink_op=None, usec_per_write_op=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, accesses_per_sec=None, aggregate_file_metadata_creates_per_sec=None, aggregate_file_metadata_modifies_per_sec=None, aggregate_file_metadata_reads_per_sec=None, aggregate_other_per_sec=None, aggregate_share_metadata_reads_per_sec=None, aggregate_usec_per_file_metadata_create_op=None, aggregate_usec_per_file_metadata_modify_op=None, aggregate_usec_per_file_metadata_read_op=None, aggregate_usec_per_other_op=None, aggregate_usec_per_share_metadata_read_op=None, creates_per_sec=None, fsinfos_per_sec=None, fsstats_per_sec=None, getattrs_per_sec=None, links_per_sec=None, lookups_per_sec=None, mkdirs_per_sec=None, pathconfs_per_sec=None, reads_per_sec=None, readdirs_per_sec=None, readdirpluses_per_sec=None, readlinks_per_sec=None, removes_per_sec=None, renames_per_sec=None, rmdirs_per_sec=None, setattrs_per_sec=None, symlinks_per_sec=None, time=None, writes_per_sec=None, usec_per_access_op=None, usec_per_create_op=None, usec_per_fsinfo_op=None, usec_per_fsstat_op=None, usec_per_getattr_op=None, usec_per_link_op=None, usec_per_lookup_op=None, usec_per_mkdir_op=None, usec_per_pathconf_op=None, usec_per_read_op=None, usec_per_readdir_op=None, usec_per_readdirplus_op=None, usec_per_readlink_op=None, usec_per_remove_op=None, usec_per_rename_op=None, usec_per_rmdir_op=None, usec_per_setattr_op=None, usec_per_symlink_op=None, usec_per_write_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.
  • accesses_per_sec (float) – ACCESS requests processed per second.
  • 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_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.
  • 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.
  • 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.
  • aggregate_share_metadata_reads_per_sec (float) – Sum of share-level read-like metadata requests per second. Includes ACCESS, FSINFO, and FSSTAT.
  • 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.
  • 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.
  • 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_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.
  • 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.
  • creates_per_sec (float) – CREATE requests processed per second.
  • fsinfos_per_sec (float) – FSINFO requests processed per second.
  • fsstats_per_sec (float) – FSSTAT requests processed per second.
  • getattrs_per_sec (float) – GETATTR requests processed per second.
  • links_per_sec (float) – LINK requests processed per second.
  • lookups_per_sec (float) – LOOKUP requests processed per second.
  • mkdirs_per_sec (float) – MKDIR requests processed per second.
  • pathconfs_per_sec (float) – PATHCONF requests processed per second.
  • reads_per_sec (float) – READ requests processed per second.
  • readdirs_per_sec (float) – READDIR requests processed per second.
  • readdirpluses_per_sec (float) – READDIRPLUS requests processed per second.
  • readlinks_per_sec (float) – READLINK requests processed per second.
  • removes_per_sec (float) – REMOVE requests processed per second.
  • renames_per_sec (float) – RENAME requests processed per second.
  • rmdirs_per_sec (float) – RMDIR requests processed per second.
  • setattrs_per_sec (float) – SETATTR requests processed per second.
  • symlinks_per_sec (float) – SYMLINK requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • writes_per_sec (float) – WRITE 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_create_op (float) – Average time, measured in microseconds, it takes the array to process a CREATE request.
  • usec_per_fsinfo_op (float) – Average time, measured in microseconds, it takes the array to process an FSINFO request.
  • usec_per_fsstat_op (float) – Average time, measured in microseconds, it takes the array to process an FSSTAT request.
  • usec_per_getattr_op (float) – Average time, measured in microseconds, it takes the array to process a GETATTR request.
  • usec_per_link_op (float) – Average time, measured in microseconds, it takes the array to process a LINK request.
  • usec_per_lookup_op (float) – Average time, measured in microseconds, it takes the array to process a LOOKUP request.
  • usec_per_mkdir_op (float) – Average time, measured in microseconds, it takes the array to process a MKDIR request.
  • usec_per_pathconf_op (float) – Average time, measured in microseconds, it takes the array to process a PATHCONF request.
  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a READ request.
  • usec_per_readdir_op (float) – Average time, measured in microseconds, it takes the array to process a READDIR request.
  • usec_per_readdirplus_op (float) – Average time, measured in microseconds, it takes the array to process a READDIRPLUS request.
  • usec_per_readlink_op (float) – Average time, measured in microseconds, it takes the array to process a READLINK request.
  • usec_per_remove_op (float) – Average time, measured in microseconds, it takes the array to process a REMOVE request.
  • usec_per_rename_op (float) – Average time, measured in microseconds, it takes the array to process a RENAME request.
  • usec_per_rmdir_op (float) – Average time, measured in microseconds, it takes the array to process an RMDIR request.
  • usec_per_setattr_op (float) – Average time, measured in microseconds, it takes the array to process a SETATTR request.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayNfsSpecificPerformanceGet

class pypureclient.flashblade.ArrayNfsSpecificPerformanceGet(continuation_token=None, total_item_count=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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[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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayPerformance

class pypureclient.flashblade.ArrayPerformance(name=None, id=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_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.
  • 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.
  • bytes_per_write (float) – Average write size in bytes per write operation.
  • others_per_sec (float) – Other operations processed per second.
  • read_bytes_per_sec (float) – Bytes read per second.
  • reads_per_sec (float) – Read requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.
  • write_bytes_per_sec (float) – Bytes written per second.
  • writes_per_sec (float) – Write requests processed per second.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayPerformanceReplicationGetResp

class pypureclient.flashblade.ArrayPerformanceReplicationGetResp(continuation_token=None, total_item_count=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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[RelationshipPerformanceReplication]) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayS3SpecificPerformance

class pypureclient.flashblade.ArrayS3SpecificPerformance(name=None, id=None, others_per_sec=None, read_buckets_per_sec=None, read_objects_per_sec=None, write_buckets_per_sec=None, write_objects_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, usec_per_write_bucket_op=None, usec_per_write_object_op=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, others_per_sec=None, read_buckets_per_sec=None, read_objects_per_sec=None, write_buckets_per_sec=None, write_objects_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, usec_per_write_bucket_op=None, usec_per_write_object_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.
  • others_per_sec (float) – Other operations processed per second.
  • read_buckets_per_sec (float) – Read buckets requests processed per second.
  • read_objects_per_sec (float) – Read object requests processed per second.
  • write_buckets_per_sec (float) – Write buckets requests processed per second.
  • write_objects_per_sec (float) – Write object requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
  • 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.
  • usec_per_write_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a write bucket request.
  • usec_per_write_object_op (float) – Average time, measured in microseconds, it takes the array to process a write object request.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayS3SpecificPerformanceGetResp

class pypureclient.flashblade.ArrayS3SpecificPerformanceGetResp(continuation_token=None, total_item_count=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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[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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArraySpace

class pypureclient.flashblade.ArraySpace(name=None, id=None, capacity=None, parity=None, space=None, time=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, capacity=None, parity=None, space=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.
  • capacity (int) – Usable capacity in bytes.
  • 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.
  • space (Space) –
  • time (int) – Sample time in milliseconds since UNIX epoch.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Audit

class pypureclient.flashblade.Audit(name=None, id=None, arguments=None, command=None, ip_address=None, subcommand=None, time=None, user=None, user_agent=None, user_interface=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, arguments=None, command=None, ip_address=None, subcommand=None, time=None, user=None, user_agent=None, user_interface=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.
  • arguments (str) –
  • command (str) –
  • ip_address (str) –
  • subcommand (str) –
  • time (int) –
  • user (str) –
  • user_agent (str) –
  • user_interface (str) – The user interface through which the user session event was performed. Valid values are CLI, GUI, and REST.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Blade

class pypureclient.flashblade.Blade(name=None, id=None, details=None, progress=None, raw_capacity=None, status=None, target=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, details=None, progress=None, raw_capacity=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.
  • details (str) –
  • progress (float) –
  • raw_capacity (int) –
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Bucket

class pypureclient.flashblade.Bucket(name=None, id=None, account=None, created=None, destroyed=None, object_count=None, space=None, time_remaining=None, versioning=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, account=None, created=None, destroyed=None, object_count=None, space=None, time_remaining=None, versioning=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.
  • account (FixedReference) –
  • created (int) – Creation timestamp of the object.
  • destroyed (bool) – Is the bucket destroyed?
  • object_count (int) – The count of objects within the bucket.
  • space (Space) – The space specification of the file system.
  • time_remaining (int) – Time in milliseconds before the bucket is eradicated. null if not destroyed.
  • versioning (str) – The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketPerformance

class pypureclient.flashblade.BucketPerformance(name=None, id=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_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.
  • 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.
  • bytes_per_write (float) – Average write size in bytes per write operation.
  • others_per_sec (float) – Other operations processed per second.
  • read_bytes_per_sec (float) – Bytes read per second.
  • reads_per_sec (float) – Read requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.
  • write_bytes_per_sec (float) – Bytes written per second.
  • writes_per_sec (float) – Write requests processed per second.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketPost

class pypureclient.flashblade.BucketPost(account=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(account=None)
Keyword Arguments:
 account (Reference) – The account name for bucket creation.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketReplicaLinkPost

class pypureclient.flashblade.BucketReplicaLinkPost(paused=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(paused=None)
Keyword Arguments:
 paused (bool) – Create link in the paused state? Defaults to false.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketS3SpecificPerformance

class pypureclient.flashblade.BucketS3SpecificPerformance(name=None, id=None, others_per_sec=None, read_buckets_per_sec=None, read_objects_per_sec=None, write_buckets_per_sec=None, write_objects_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, usec_per_write_bucket_op=None, usec_per_write_object_op=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, others_per_sec=None, read_buckets_per_sec=None, read_objects_per_sec=None, write_buckets_per_sec=None, write_objects_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, usec_per_write_bucket_op=None, usec_per_write_object_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.
  • others_per_sec (float) – Other operations processed per second.
  • read_buckets_per_sec (float) – Read buckets requests processed per second.
  • read_objects_per_sec (float) – Read object requests processed per second.
  • write_buckets_per_sec (float) – Write buckets requests processed per second.
  • write_objects_per_sec (float) – Write object requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
  • 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.
  • usec_per_write_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a write bucket request.
  • usec_per_write_object_op (float) – Average time, measured in microseconds, it takes the array to process a write object request.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketS3SpecificPerformanceGetResp

class pypureclient.flashblade.BucketS3SpecificPerformanceGetResp(continuation_token=None, total_item_count=None, items=None, total=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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, 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[BucketS3SpecificPerformance]) – A list of S3 specific bucket performance metrics objects.
  • total (list[BucketS3SpecificPerformance]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BuiltIn

class pypureclient.flashblade.BuiltIn(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BuiltInNoId

class pypureclient.flashblade.BuiltInNoId(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BuiltInRelationship

class pypureclient.flashblade.BuiltInRelationship(id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Certificate

class pypureclient.flashblade.Certificate(name=None, id=None, certificate=None, certificate_type=None, common_name=None, country=None, email=None, intermediate_certificate=None, issued_by=None, issued_to=None, key_size=None, locality=None, organization=None, organizational_unit=None, state=None, status=None, subject_alternative_names=None, valid_from=None, valid_to=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, certificate_type=None, common_name=None, country=None, email=None, intermediate_certificate=None, issued_by=None, issued_to=None, key_size=None, locality=None, organization=None, organizational_unit=None, state=None, status=None, subject_alternative_names=None, valid_from=None, valid_to=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.
  • 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.
  • country (str) – The country field listed in the certificate.
  • email (str) – The email field listed in the certificate.
  • intermediate_certificate (str) – Intermediate certificate chains.
  • issued_by (str) – Who issued this certificate.
  • issued_to (str) – Who this certificate was issued to.
  • key_size (int) – The size of the private key for this certificate in bits.
  • locality (str) – The locality field listed in the certificate.
  • organization (str) – The organization field listed in the certificate.
  • organizational_unit (str) – The organizational unit field listed in the certificate.
  • state (str) – The state/province field listed in the certificate.
  • status (str) – The type of certificate. Valid values are self-signed and imported.
  • subject_alternative_names (list[str]) – The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs.
  • valid_from (str) – The start date of when this certificate is valid.
  • valid_to (str) – The end date of when this certificate is valid.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateCertificateGroupGetResp

class pypureclient.flashblade.CertificateCertificateGroupGetResp(continuation_token=None, total_item_count=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateGroup

class pypureclient.flashblade.CertificateGroup(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateGroupCertificateGetResp

class pypureclient.flashblade.CertificateGroupCertificateGetResp(continuation_token=None, total_item_count=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateGroupUse

class pypureclient.flashblade.CertificateGroupUse(name=None, id=None, use=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificatePatch

class pypureclient.flashblade.CertificatePatch(name=None, id=None, certificate=None, intermediate_certificate=None, passphrase=None, private_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, intermediate_certificate=None, passphrase=None, private_key=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.
  • intermediate_certificate (str) – Intermediate certificate chains.
  • passphrase (str) – The passphrase used to encrypt private_key.
  • private_key (str) – The private key used to sign the certificate.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificatePost

class pypureclient.flashblade.CertificatePost(name=None, certificate=None, certificate_type=None, common_name=None, country=None, email=None, intermediate_certificate=None, issued_by=None, issued_to=None, key_size=None, locality=None, organization=None, organizational_unit=None, state=None, status=None, valid_from=None, valid_to=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, certificate=None, certificate_type=None, common_name=None, country=None, email=None, intermediate_certificate=None, issued_by=None, issued_to=None, key_size=None, locality=None, organization=None, organizational_unit=None, state=None, status=None, valid_from=None, valid_to=None)
Keyword Arguments:
 
  • name (str) – Name of the object (e.g., a file system or snapshot).
  • certificate (str) – The text of 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.
  • country (str) – The country field listed in the certificate.
  • email (str) – The email field listed in the certificate.
  • intermediate_certificate (str) – Intermediate certificate chains.
  • issued_by (str) – Who issued this certificate.
  • issued_to (str) – Who this certificate was issued to.
  • key_size (int) – The size of the private key for this certificate in bits.
  • locality (str) – The locality field listed in the certificate.
  • organization (str) – The organization field listed in the certificate.
  • organizational_unit (str) – The organizational unit field listed in the certificate.
  • state (str) – The state/province field listed in the certificate.
  • status (str) – The type of certificate. Valid values are self-signed and imported.
  • valid_from (str) – The start date of when this certificate is valid.
  • valid_to (str) – The end date of when this certificate is valid.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateUse

class pypureclient.flashblade.CertificateUse(name=None, id=None, group=None, use=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, group=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.
  • 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.
  • use (FixedReferenceWithRemote) – A reference to an object using this certificate.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ClientPerformance

class pypureclient.flashblade.ClientPerformance(name=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_per_sec=None)
Keyword Arguments:
 
  • name (str) – Name of the object (e.g., a file system or snapshot).
  • bytes_per_op (int) – Average operation size (read bytes+write bytes/read ops+write ops).
  • bytes_per_read (int) – Average read size in bytes per read operation.
  • bytes_per_write (int) – Average write size in bytes per write operation.
  • others_per_sec (int) – Other operations processed per second.
  • read_bytes_per_sec (int) – Bytes read per second.
  • reads_per_sec (int) – Read requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • usec_per_other_op (int) – Average time, measured in microseconds, it takes the client to process other operations.
  • usec_per_read_op (int) – Average time, measured in microseconds, it takes the client to process a read request.
  • usec_per_write_op (int) – Average time, measured in microseconds, it takes the client to process a write request.
  • write_bytes_per_sec (int) – Bytes written per second.
  • writes_per_sec (int) – Write requests processed per second.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Direction

class pypureclient.flashblade.Direction
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryService

class pypureclient.flashblade.DirectoryService(name=None, id=None, base_dn=None, bind_password=None, bind_user=None, ca_certificate=None, ca_certificate_group=None, enabled=None, management=None, nfs=None, services=None, smb=None, uris=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, base_dn=None, bind_password=None, bind_user=None, ca_certificate=None, ca_certificate_group=None, enabled=None, management=None, nfs=None, services=None, smb=None, uris=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.
  • base_dn (str) – Base of the Distinguished Name (DN) of the directory service groups.
  • bind_password (str) – Obfuscated password used to query the directory.
  • bind_user (str) – Username used to query the directory.
  • ca_certificate (Reference) – CA certificate used to validate the authenticity of the configured servers.
  • ca_certificate_group (Reference) – A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers.
  • enabled (bool) – Is the directory service enabled or not?
  • management (DirectoryServiceManagement) –
  • nfs (DirectoryServiceNfs) –
  • services (list[str]) – Services that the directory service configuration is used for.
  • smb (DirectoryServiceSmb) –
  • uris (list[str]) – List of URIs for the configured directory servers.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryServiceManagement

class pypureclient.flashblade.DirectoryServiceManagement(user_login_attribute=None, user_object_class=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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. Defaults to sAMAccountName for Active Directory servers, or uid for all other directory server types.
  • 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 server’s group type, or person for all other directory servers.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryServiceNfs

class pypureclient.flashblade.DirectoryServiceNfs(nis_domains=None, nis_servers=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryServiceRole

class pypureclient.flashblade.DirectoryServiceRole(group=None, group_base=None, id=None, role=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(group=None, group_base=None, id=None, role=None)
Keyword Arguments:
 
  • group (str) – Common Name (CN) of the directory service group containing users with authority level of the specified role name.
  • group_base (str) – Specifies where the configured group is located in the directory tree.
  • id (str) – A non-modifiable, globally unique ID chosen by the system.
  • role (Reference) – A reference to the role; can be any role that exists on the system.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryServiceSmb

class pypureclient.flashblade.DirectoryServiceSmb(join_ou=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Dns

class pypureclient.flashblade.Dns(name=None, id=None, domain=None, nameservers=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, domain=None, nameservers=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.
  • domain (str) – Domain suffix to be appended by the Array when performing DNS lookups.
  • nameservers (list[str]) – List of DNS server IP addresses.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Eula

class pypureclient.flashblade.Eula(agreement=None, signature=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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) – End User Agreement text.
  • signature (EulaSignature) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

EulaSignature

class pypureclient.flashblade.EulaSignature(name=None, title=None, company=None, accepted=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, title=None, company=None, accepted=None)
Keyword Arguments:
 
  • name (str) – Name of the person who accepted the End User Agreement.
  • title (str) – Title of the person who accepted the End User Agreement.
  • company (str) – Company of the person who accepted the End User Agreement.
  • accepted (int) – Accepted time in milliseconds since the UNIX epoch.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystem

class pypureclient.flashblade.FileSystem(name=None, id=None, created=None, default_group_quota=None, default_user_quota=None, destroyed=None, fast_remove_directory_enabled=None, hard_limit_enabled=None, http=None, multi_protocol=None, nfs=None, promotion_status=None, provisioned=None, requested_promotion_state=None, smb=None, snapshot_directory_enabled=None, source=None, space=None, time_remaining=None, writable=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, created=None, default_group_quota=None, default_user_quota=None, destroyed=None, fast_remove_directory_enabled=None, hard_limit_enabled=None, http=None, multi_protocol=None, nfs=None, promotion_status=None, provisioned=None, requested_promotion_state=None, smb=None, snapshot_directory_enabled=None, source=None, space=None, time_remaining=None, writable=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.
  • created (int) – Creation timestamp of the file system.
  • default_group_quota (int) – The default space quota for a group writing to this file system.
  • default_user_quota (int) – The default space quota for a user writing to this file system.
  • 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.
  • 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.
  • hard_limit_enabled (bool) – If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota.
  • http (Http) – HTTP configuration.
  • multi_protocol (MultiProtocol) – Multi-protocol configuration.
  • nfs (Nfs) – NFS configuration.
  • 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.
  • 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.
  • smb (Smb) – SMB configuration.
  • 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.
  • source (LocationReference) – A reference to the source file system.
  • space (Space) – The space usage of the file system.
  • time_remaining (int) – Time in milliseconds before the file system is eradicated. null if not destroyed.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemGroupPerformance

class pypureclient.flashblade.FileSystemGroupPerformance(name=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, file_system=None, group=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, file_system=None, group=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_per_sec=None)
Keyword Arguments:
 
  • name (str) – Name of the object (e.g., a file system or snapshot).
  • 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.
  • bytes_per_write (float) – Average write size in bytes per write operation.
  • file_system (FixedReference) – The file system on which the performance was measured.
  • group (Group) – The group whose performance is represented.
  • others_per_sec (float) – Other operations processed per second.
  • read_bytes_per_sec (float) – Bytes read per second.
  • reads_per_sec (float) – Read requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.
  • write_bytes_per_sec (float) – Bytes written per second.
  • writes_per_sec (float) – Write requests processed per second.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemPatch

class pypureclient.flashblade.FileSystemPatch(name=None, id=None, created=None, default_group_quota=None, default_user_quota=None, destroyed=None, fast_remove_directory_enabled=None, hard_limit_enabled=None, http=None, multi_protocol=None, nfs=None, promotion_status=None, provisioned=None, requested_promotion_state=None, smb=None, snapshot_directory_enabled=None, source=None, space=None, time_remaining=None, writable=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, created=None, default_group_quota=None, default_user_quota=None, destroyed=None, fast_remove_directory_enabled=None, hard_limit_enabled=None, http=None, multi_protocol=None, nfs=None, promotion_status=None, provisioned=None, requested_promotion_state=None, smb=None, snapshot_directory_enabled=None, source=None, space=None, time_remaining=None, writable=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.
  • created (int) – Creation timestamp of the file system.
  • default_group_quota (int) – The default space quota for a group writing to this file system.
  • default_user_quota (int) – The default space quota for a user writing to this file system.
  • 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.
  • 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.
  • hard_limit_enabled (bool) – If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota.
  • http (Http) – HTTP configuration.
  • multi_protocol (MultiProtocol) – Multi-protocol configuration.
  • nfs (NfsPatch) – NFS configuration.
  • 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.
  • 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.
  • smb (Smb) – SMB configuration.
  • 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.
  • source (LocationReference) – A reference to the source file system.
  • space (Space) – The space usage of the file system.
  • time_remaining (int) – Time in milliseconds before the file system is eradicated. null if not destroyed.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemPerformance

class pypureclient.flashblade.FileSystemPerformance(name=None, id=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, write_bytes_per_sec=None, writes_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.
  • 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.
  • bytes_per_write (float) – Average write size in bytes per write operation.
  • others_per_sec (float) – Other operations processed per second.
  • read_bytes_per_sec (float) – Bytes read per second.
  • reads_per_sec (float) – Read requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.
  • write_bytes_per_sec (float) – Bytes written per second.
  • writes_per_sec (float) – Write requests processed per second.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemPost

class pypureclient.flashblade.FileSystemPost(default_group_quota=None, default_user_quota=None, fast_remove_directory_enabled=None, hard_limit_enabled=None, http=None, multi_protocol=None, nfs=None, provisioned=None, requested_promotion_state=None, smb=None, snapshot_directory_enabled=None, source=None, writable=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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_group_quota=None, default_user_quota=None, fast_remove_directory_enabled=None, hard_limit_enabled=None, http=None, multi_protocol=None, nfs=None, provisioned=None, requested_promotion_state=None, smb=None, snapshot_directory_enabled=None, source=None, writable=None)
Keyword Arguments:
 
  • default_group_quota (int) – The default space quota for a group writing to this file system.
  • default_user_quota (int) – The default space quota for a user writing to this 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. If not specified, defaults to 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. If not specified, defaults to false.
  • http (Http) – HTTP configuration.
  • multi_protocol (MultiProtocolPost) – Multi-protocol configuration.
  • nfs (Nfs) – NFS configuration.
  • 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.
  • smb (Smb) – SMB configuration.
  • 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.
  • source (Reference) – The source snapshot whose data is copied to the file system specified.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemSnapshot

class pypureclient.flashblade.FileSystemSnapshot(name=None, id=None, copyable=None, created=None, destroyed=None, owner=None, owner_destroyed=None, policy=None, source=None, suffix=None, time_remaining=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, copyable=None, created=None, destroyed=None, owner=None, owner_destroyed=None, policy=None, source=None, suffix=None, time_remaining=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.
  • copyable (bool) – Can this snapshot be used as a source for copy operations?
  • created (int) – Creation timestamp of the object.
  • destroyed (bool) – Is the file system snapshot destroyed? If not specified, defaults to false.
  • owner (Reference) – A reference to the file system that owns this snapshot. If the owner is destroyed, this will be destroyed.
  • owner_destroyed (bool) – Is the owning file system destroyed?
  • policy (LocationReference) – A reference to the associated policy.
  • source (LocationReference) – 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.
  • time_remaining (int) – Time in milliseconds before the file system snapshot is eradicated. null if not destroyed.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemSnapshotPost

class pypureclient.flashblade.FileSystemSnapshotPost(suffix=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemSnapshotTransfer

class pypureclient.flashblade.FileSystemSnapshotTransfer(name=None, id=None, completed=None, data_transferred=None, direction=None, progress=None, remote=None, remote_snapshot=None, started=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, completed=None, data_transferred=None, direction=None, progress=None, remote=None, remote_snapshot=None, started=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.
  • completed (int) – A timestamp at which the replication of the snapshot completed.
  • data_transferred (int) – The amount of data transferred to the target, in bytes.
  • direction (Direction) –
  • progress (float) – A percentage that indicates how much progress has been made on the transfer.
  • remote (FixedReferenceNoResourceType) – The array where the remote file system snapshot is located.
  • remote_snapshot (FixedReferenceNoResourceType) – A reference to the associated remote file system snapshot.
  • started (int) – A timestamp at which the replication of the snapshot started.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemUserPerformance

class pypureclient.flashblade.FileSystemUserPerformance(name=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, file_system=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, user=None, write_bytes_per_sec=None, writes_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, bytes_per_op=None, bytes_per_read=None, bytes_per_write=None, file_system=None, others_per_sec=None, read_bytes_per_sec=None, reads_per_sec=None, time=None, usec_per_other_op=None, usec_per_read_op=None, usec_per_write_op=None, user=None, write_bytes_per_sec=None, writes_per_sec=None)
Keyword Arguments:
 
  • name (str) – Name of the object (e.g., a file system or snapshot).
  • 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.
  • bytes_per_write (float) – Average write size in bytes per write operation.
  • file_system (FixedReference) – The file system on which the performance was measured.
  • others_per_sec (float) – Other operations processed per second.
  • read_bytes_per_sec (float) – Bytes read per second.
  • reads_per_sec (float) – Read requests processed per second.
  • time (int) – Sample time in milliseconds since UNIX epoch.
  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.
  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.
  • 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.
  • write_bytes_per_sec (float) – Bytes written per second.
  • writes_per_sec (float) – Write requests processed per second.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReference

class pypureclient.flashblade.FixedReference(name=None, resource_type=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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 (ResourceType) –
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceNameOnly

class pypureclient.flashblade.FixedReferenceNameOnly(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceNoResourceType

class pypureclient.flashblade.FixedReferenceNoResourceType(id=None, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, name=None)
Keyword Arguments:
 
  • id (str) – A non-modifiable, globally unique ID chosen by the system.
  • name (str) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceWithRemote

class pypureclient.flashblade.FixedReferenceWithRemote(name=None, resource_type=None, id=None, remote=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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 (ResourceType) –
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Group

class pypureclient.flashblade.Group(id=None, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, name=None)
Keyword Arguments:
 
  • id (int) – The numeric group id that represents the group’s identity in a POSIX system.
  • name (str) – The group name that represents the group’s identity, and which resolves to the group’s id in a configured directory service.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

GroupQuota

class pypureclient.flashblade.GroupQuota(name=None, file_system=None, file_system_default_quota=None, group=None, quota=None, usage=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, file_system=None, file_system_default_quota=None, group=None, quota=None, usage=None)
Keyword Arguments:
 
  • name (str) – Name of the object (e.g., a file system or snapshot).
  • file_system (FixedReference) –
  • 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.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Hardware

class pypureclient.flashblade.Hardware(name=None, id=None, details=None, identify_enabled=None, index=None, model=None, serial=None, slot=None, speed=None, status=None, temperature=None, type=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, details=None, identify_enabled=None, index=None, model=None, serial=None, slot=None, speed=None, status=None, temperature=None, 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.
  • details (str) – Details about the status of the component if not healthy.
  • identify_enabled (bool) – State of an LED used to visually identify the component.
  • index (int) – Number that identifies the relative position of a hardware component within the array.
  • model (str) – Model number of the hardware component.
  • serial (str) – Serial number of the hardware component.
  • slot (int) – Slot number occupied by the PCI Express card that hosts the component.
  • speed (int) – The maximum speed (in b/s) at which the component is capable of operating.
  • status (str) – Component status. Valid values are critical, healthy, identifying, unhealthy, unknown, and unused.
  • temperature (int) – Temperature (in degrees celsius) reported by the component.
  • type (str) – Type of hardware component. Valid values are ch, eth, fan, fb, fm, pwr, and xfm.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

HardwareConnector

class pypureclient.flashblade.HardwareConnector(name=None, id=None, connector_type=None, lane_speed=None, port_count=None, transceiver_type=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, connector_type=None, lane_speed=None, port_count=None, transceiver_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.
  • connector_type (str) – Form-factor of the interface. Valid values include QSFP and RJ-45.
  • lane_speed (int) – Configured speed of each lane in the connector in bits-per-second.
  • port_count (int) – Configured number of ports in the connector (1/4 for QSFP).
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Http

class pypureclient.flashblade.Http(enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Keytab

class pypureclient.flashblade.Keytab(name=None, id=None, encryption_type=None, fqdn=None, kvno=None, prefix=None, principal=None, realm=None, source=None, suffix=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, fqdn=None, kvno=None, prefix=None, principal=None, realm=None, source=None, suffix=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.
  • fqdn (str) – The fully qualified domain name to which the keytab was issued.
  • kvno (int) – The key version number of the key used to generate the keytab.
  • 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.
  • principal (str) – The service name for which the keytab was issued.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

KeytabFileBase64

class pypureclient.flashblade.KeytabFileBase64
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

KeytabFileBinary

class pypureclient.flashblade.KeytabFileBinary
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

KeytabPost

class pypureclient.flashblade.KeytabPost(source=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LifecycleRule

class pypureclient.flashblade.LifecycleRule(name=None, id=None, bucket=None, enabled=None, keep_previous_version_for=None, prefix=None, rule_id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, bucket=None, enabled=None, keep_previous_version_for=None, prefix=None, rule_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.
  • bucket (FixedReference) – The bucket which this lifecycle rule is targeting.
  • enabled (bool) – If set to true, this rule will be enabled.
  • 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.
  • prefix (str) – Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.
  • rule_id (str) – Unique identifier for the rule. Can have a maximum length of 255 characters.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LifecycleRulePost

class pypureclient.flashblade.LifecycleRulePost(bucket=None, keep_previous_version_for=None, prefix=None, rule_id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(bucket=None, keep_previous_version_for=None, prefix=None, rule_id=None)
Keyword Arguments:
 
  • bucket (Reference) – The bucket name for lifecycle rule creation.
  • 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.
  • prefix (str) – Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LinkAggregationGroup

class pypureclient.flashblade.LinkAggregationGroup(name=None, id=None, lag_speed=None, mac_address=None, ports=None, port_speed=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, mac_address=None, ports=None, port_speed=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.
  • mac_address (str) – Unique MAC address assigned to the LAG.
  • ports (list[FixedReference]) – Ports associated with the LAG.
  • port_speed (int) – Configured speed of each port in the LAG in bits-per-second.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Linkaggregationgroup

class pypureclient.flashblade.Linkaggregationgroup(ports=None, add_ports=None, remove_ports=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(ports=None, add_ports=None, remove_ports=None)
Keyword Arguments:
 
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LocationReference

class pypureclient.flashblade.LocationReference(name=None, resource_type=None, id=None, display_name=None, is_local=None, location=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, display_name=None, is_local=None, location=None)
Keyword Arguments:
 
  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.
  • resource_type (ResourceType) –
  • id (str) – A non-modifiable, globally unique ID chosen by the system.
  • 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?
  • location (Reference) – A reference to the location where the object is defined.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Login

class pypureclient.flashblade.Login(username=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Member

class pypureclient.flashblade.Member(group=None, member=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(group=None, member=None)
Keyword Arguments:
 
  • group (Reference) – A reference to a group object that has the referenced member object as a member.
  • member (Reference) – A reference to an object that is a member of the referenced group.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MultiProtocol

class pypureclient.flashblade.MultiProtocol(access_control_style=None, safeguard_acls=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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_control_style=None, safeguard_acls=None)
Keyword Arguments:
 
  • 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.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MultiProtocolPost

class pypureclient.flashblade.MultiProtocolPost(access_control_style=None, safeguard_acls=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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_control_style=None, safeguard_acls=None)
Keyword Arguments:
 
  • 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.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterface

class pypureclient.flashblade.NetworkInterface(name=None, id=None, address=None, enabled=None, gateway=None, mtu=None, netmask=None, services=None, subnet=None, type=None, vlan=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, enabled=None, gateway=None, mtu=None, netmask=None, services=None, subnet=None, type=None, vlan=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.
  • address (str) – The IPv4 or IPv6 address to be associated with the specified network interface.
  • 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.
  • netmask (str) – Derived from subnet.prefix.
  • services (list[str]) – Services and protocols that are enabled on the interface.
  • subnet (object) –
  • type (str) – The only valid value is vip.
  • vlan (int) – Derived from subnet.vlan.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterfacePatch

class pypureclient.flashblade.NetworkInterfacePatch(address=None, services=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, services=None)
Keyword Arguments:
 
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Nfs

class pypureclient.flashblade.Nfs(v3_enabled=None, v4_1_enabled=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(v3_enabled=None, v4_1_enabled=None, rules=None)
Keyword Arguments:
 
  • v3_enabled (bool) – If set to true, the NFSv3 protocol will be enabled.
  • v4_1_enabled (bool) – If set to true, the NFSv4.1 protocol will be enabled.
  • rules (str) – The NFS export rules for the file system. 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)), or netgroup (@groupname(options)). Possible export options include rw, ro, root_squash, no_root_squash, all_squash, no_all_squash, fileid_32bit, and no_fileid_32bit. If not specified, defaults to *(rw,no_root_squash).
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NfsPatch

class pypureclient.flashblade.NfsPatch(v3_enabled=None, v4_1_enabled=None, rules=None, add_rules=None, remove_rules=None, after=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(v3_enabled=None, v4_1_enabled=None, rules=None, add_rules=None, remove_rules=None, after=None)
Keyword Arguments:
 
  • v3_enabled (bool) – If set to true, the NFSv3 protocol will be enabled.
  • v4_1_enabled (bool) – If set to true, the NFSv4.1 protocol will be enabled.
  • rules (str) – The NFS export rules for the file system. 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)), or netgroup (@groupname(options)). Possible export options include rw, ro, root_squash, no_root_squash, all_squash, no_all_squash, fileid_32bit, and no_fileid_32bit. If not specified, defaults to *(rw,no_root_squash).
  • add_rules (str) – The rules which will be added to the existing NFS export rules for the file system.
  • 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.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccessKey

class pypureclient.flashblade.ObjectStoreAccessKey(name=None, created=None, enabled=None, secret_access_key=None, user=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, created=None, enabled=None, secret_access_key=None, user=None)
Keyword Arguments:
 
  • name (str) – Name of the object (e.g., a file system or snapshot).
  • created (int) – Creation timestamp of the object.
  • enabled (bool) – Is the access key enabled? If not specified, defaults to false.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccessKeyPost

class pypureclient.flashblade.ObjectStoreAccessKeyPost(user=None, secret_access_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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=None, secret_access_key=None)
Keyword Arguments:
 
  • user (object) –
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccessPolicy

class pypureclient.flashblade.ObjectStoreAccessPolicy(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccount

class pypureclient.flashblade.ObjectStoreAccount(name=None, id=None, created=None, object_count=None, space=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, 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.
  • created (int) – Creation timestamp of the object.
  • object_count (int) – The count of objects within the account.
  • space (Space) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRemoteCredentialGetResp

class pypureclient.flashblade.ObjectStoreRemoteCredentialGetResp(continuation_token=None, total_item_count=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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[ObjectStoreRemoteCredentials]) – A list of object store remote credentials.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRemoteCredentials

class pypureclient.flashblade.ObjectStoreRemoteCredentials(name=None, id=None, access_key_id=None, remote=None, secret_access_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, access_key_id=None, remote=None, secret_access_key=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.
  • access_key_id (str) – Access Key ID 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.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRemoteCredentialsPost

class pypureclient.flashblade.ObjectStoreRemoteCredentialsPost(access_key_id=None, secret_access_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRemoteCredentialsResp

class pypureclient.flashblade.ObjectStoreRemoteCredentialsResp(items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreUser

class pypureclient.flashblade.ObjectStoreUser(name=None, id=None, access_keys=None, account=None, created=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, access_keys=None, account=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.
  • access_keys (list[FixedReference]) – References of the user’s access keys.
  • account (FixedReference) – Reference of the associated account.
  • created (int) – Creation timestamp of the object.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreVirtualHost

class pypureclient.flashblade.ObjectStoreVirtualHost(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PageInfo

class pypureclient.flashblade.PageInfo(continuation_token=None, total_item_count=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Permission

class pypureclient.flashblade.Permission(action=None, resource_type=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(action=None, resource_type=None)
Keyword Arguments:
 
  • 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.
  • resource_type (str) – The resource_type that this permission affects.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Policy

class pypureclient.flashblade.Policy(name=None, id=None, enabled=None, is_local=None, location=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, enabled=None, is_local=None, location=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.
  • enabled (bool) – Indicates if policy is enabled (true) or disabled (false). If not specified, defaults to true.
  • is_local (bool) – Whether the policy is defined on the local array.
  • location (FixedReference) – Reference to the array where the policy is defined.
  • rules (list[PolicyRule]) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyFileSystem

PolicyFileSystemSnapshot

class pypureclient.flashblade.PolicyFileSystemSnapshot(member=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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:
 
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyMember

class pypureclient.flashblade.PolicyMember(member=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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:
 
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyMemberWithRemote

class pypureclient.flashblade.PolicyMemberWithRemote(member=None, policy=None, link=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, link=None)
Keyword Arguments:
 
  • member (FixedReference) – Reference to the resource the policy is applied to.
  • policy (LocationReference) – Reference to the policy.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyPatch

class pypureclient.flashblade.PolicyPatch(name=None, id=None, enabled=None, is_local=None, location=None, rules=None, add_rules=None, remove_rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, enabled=None, is_local=None, location=None, rules=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.
  • enabled (bool) – Indicates if policy is enabled (true) or disabled (false). If not specified, defaults to true.
  • is_local (bool) – Whether the policy is defined on the local array.
  • location (FixedReference) – Reference to the array where the policy is defined.
  • rules (list[PolicyRule]) –
  • add_rules (list[PolicyRule]) –
  • remove_rules (list[PolicyRule]) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRule

class pypureclient.flashblade.PolicyRule(at=None, every=None, keep_for=None, time_zone=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, every=None, keep_for=None, time_zone=None)
Keyword Arguments:
 
  • at (int) – Time during the day to take the snapshot (using array time zone), only valid if ‘every’ is in days.
  • every (int) – How often to take snapshots.
  • keep_for (int) – The time to keep the snapshots for.
  • time_zone (str) – The time zone to use with the at time.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

QuotaSetting

class pypureclient.flashblade.QuotaSetting(name=None, id=None, contact=None, direct_notifications_enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, contact=None, direct_notifications_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.
  • 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.
  • direct_notifications_enabled (bool) – Are notifications regarding space usage and quotas being sent directly to user and group emails?
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Reference

class pypureclient.flashblade.Reference(name=None, resource_type=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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 (ResourceType) –
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

RelationshipPerformanceReplication

class pypureclient.flashblade.RelationshipPerformanceReplication(id=None, periodic=None, remote=None, time=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, remote=None, time=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.
  • remote (FixedReferenceNoResourceType) – Reference to a remote array.
  • time (int) – Sample time in milliseconds since UNIX epoch.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

RelationshipPerformanceReplicationGetResp

class pypureclient.flashblade.RelationshipPerformanceReplicationGetResp(continuation_token=None, total_item_count=None, items=None, total=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute 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, 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[RelationshipPerformanceReplication]) –
  • total (list[RelationshipPerformanceReplication]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ReplicaLinkBuiltIn

class pypureclient.flashblade.ReplicaLinkBuiltIn(id=None, direction=None, lag=None, status_details=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, direction=None, lag=None, status_details=None)
Keyword Arguments:
 
  • id (str) – A non-modifiable, globally unique ID chosen by the system.
  • direction (Direction) –
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ReplicationPerformance

class pypureclient.flashblade.ReplicationPerformance(transmitted_bytes_per_sec=None, received_bytes_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Resource

class pypureclient.flashblade.Resource(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ResourcePerformanceReplication

class pypureclient.flashblade.ResourcePerformanceReplication(name=None, id=None, periodic=None, time=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, 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.
  • periodic (ReplicationPerformance) – Total bytes transmitted or received per second for periodic replication.
  • time (int) – Sample time in milliseconds since UNIX epoch.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ResourceType

class pypureclient.flashblade.ResourceType
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Role

class pypureclient.flashblade.Role(name=None, id=None, permissions=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SMTP

class pypureclient.flashblade.SMTP(name=None, id=None, relay_host=None, sender_domain=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, 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.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Smb

class pypureclient.flashblade.Smb(enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(enabled=None)
Keyword Arguments:
 enabled (bool) – If set to true, enables 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmtpServer

class pypureclient.flashblade.SmtpServer(name=None, id=None, relay_host=None, sender_domain=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, 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.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpAgent

class pypureclient.flashblade.SnmpAgent(name=None, id=None, engine_id=None, version=None, v2c=None, v3=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, version=None, v2c=None, v3=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.
  • 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.
  • v2c (SnmpV2c) –
  • v3 (SnmpV3) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpAgentMib

class pypureclient.flashblade.SnmpAgentMib(mib=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpManager

class pypureclient.flashblade.SnmpManager(name=None, id=None, host=None, notification=None, version=None, v2c=None, v3=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, host=None, notification=None, version=None, v2c=None, v3=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.
  • 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.
  • notification (str) – The type of notification the agent will send. Valid values are inform and trap.
  • version (str) – Version of the SNMP protocol to be used by Purity in communications with the specified manager. Valid values are v2c and v3.
  • v2c (SnmpV2c) –
  • v3 (SnmpV3) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpManagerPost

class pypureclient.flashblade.SnmpManagerPost(host=None, notification=None, version=None, v2c=None, v3=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(host=None, notification=None, version=None, v2c=None, v3=None)
Keyword Arguments:
 
  • 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.
  • notification (str) – The type of notification the agent will send. Valid values are inform and trap.
  • version (str) – Version of the SNMP protocol to be used by Purity in communications with the specified manager. Valid values are v2c and v3.
  • v2c (SnmpV2c) –
  • v3 (SnmpV3Post) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpManagerTest

class pypureclient.flashblade.SnmpManagerTest(name=None, id=None, sent=None, error=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, sent=None, error=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.
  • sent (bool) – Is the test trap or inform sent?
  • error (str) – Error message (if failed).
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpV2c

class pypureclient.flashblade.SnmpV2c(community=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpV3

class pypureclient.flashblade.SnmpV3(auth_passphrase=None, auth_protocol=None, privacy_passphrase=None, privacy_protocol=None, user=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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_passphrase=None, auth_protocol=None, privacy_passphrase=None, privacy_protocol=None, user=None)
Keyword Arguments:
 
  • auth_passphrase (str) – Passphrase used by Purity to authenticate the array with the specified managers.
  • auth_protocol (str) – Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.
  • privacy_passphrase (str) – Passphrase used to encrypt SNMP messages.
  • privacy_protocol (str) – Encryption protocol for SNMP messages. Valid values are AES and DES.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Space

class pypureclient.flashblade.Space(data_reduction=None, snapshots=None, total_physical=None, unique=None, virtual=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(data_reduction=None, snapshots=None, total_physical=None, unique=None, virtual=None)
Keyword Arguments:
 
  • data_reduction (float) – Reduction of data.
  • snapshots (int) – Physical usage by snapshots, other than unique in bytes.
  • total_physical (int) – Total physical usage (including snapshots) in bytes.
  • unique (int) – Unique physical space occupied by customer data, in bytes. Excludes shared space, snapshots, and metadata.
  • virtual (int) – Virtual space, in bytes.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Subnet

class pypureclient.flashblade.Subnet(name=None, id=None, enabled=None, gateway=None, interfaces=None, link_aggregation_group=None, mtu=None, prefix=None, services=None, vlan=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, enabled=None, gateway=None, interfaces=None, link_aggregation_group=None, mtu=None, prefix=None, services=None, vlan=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.
  • 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.
  • interfaces (list[FixedReference]) – List of network interfaces associated with this subnet.
  • link_aggregation_group (Reference) – Reference to the associated LAG.
  • 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.
  • 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.
  • vlan (int) – VLAN ID.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Support

class pypureclient.flashblade.Support(name=None, id=None, phonehome_enabled=None, proxy=None, remote_assist_active=None, remote_assist_opened=None, remote_assist_expires=None, remote_assist_status=None, remote_assist_paths=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, phonehome_enabled=None, proxy=None, remote_assist_active=None, remote_assist_opened=None, remote_assist_expires=None, remote_assist_status=None, remote_assist_paths=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.
  • phonehome_enabled (bool) –
  • proxy (str) –
  • remote_assist_active (bool) – The switch to open all remote-assist sessions.
  • remote_assist_opened (str) – The time when the session opened.
  • remote_assist_expires (str) – The time when the session expires.
  • remote_assist_status (str) – The status of the remote-assist sessions. Valid values are connected, partially_connected, reconnecting, and disconnected.
  • remote_assist_paths (list[SupportRemoteAssistPaths]) –
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SupportRemoteAssistPaths

class pypureclient.flashblade.SupportRemoteAssistPaths(component_name=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SyslogServer

class pypureclient.flashblade.SyslogServer(name=None, id=None, uri=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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, uri=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.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SyslogServerPostOrPatch

class pypureclient.flashblade.SyslogServerPostOrPatch(uri=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SyslogServerSettings

class pypureclient.flashblade.SyslogServerSettings(name=None, id=None, ca_certificate=None, ca_certificate_group=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Target

class pypureclient.flashblade.Target(name=None, id=None, address=None, ca_certificate_group=None, status=None, status_details=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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=None, status_details=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 (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.
  • status_details (str) – Additional information describing any issues encountered when connecting, or null if the status is connected.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TargetPost

class pypureclient.flashblade.TargetPost(address=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TestResult

class pypureclient.flashblade.TestResult(component_address=None, component_name=None, description=None, destination=None, enabled=None, resource=None, result_details=None, success=None, test_type=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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_address=None, component_name=None, description=None, destination=None, enabled=None, resource=None, result_details=None, success=None, test_type=None)
Keyword Arguments:
 
  • component_address (str) – Address of the component running the test.
  • component_name (str) – Name of the component running the test.
  • description (str) – What the test is doing.
  • destination (str) – The URI of the target server being tested.
  • enabled (bool) – Is the service enabled or not?
  • resource (FixedReference) – A reference to the object being tested.
  • result_details (str) – Additional information about the test result.
  • success (bool) – Returns a value of true if the specified test succeeded. Returns a value of false if the specified test failed.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Throttle

TimeWindow

TimeZone

class pypureclient.flashblade.TimeZone(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

User

class pypureclient.flashblade.User(id=None, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The 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, name=None)
Keyword Arguments:
 
  • id (int) – The numeric user id that represents the user’s identity in a POSIX system.
  • 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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

UserQuota

class pypureclient.flashblade.UserQuota(name=None, file_system=None, file_system_default_quota=None, quota=None, usage=None, user=None)
swagger_types

The key is attribute name and the value is attribute type.

Type:dict
attribute_map

The key is attribute name and the value is json key in definition.

Type:dict
__eq__(other)

Returns true if both objects are equal

__init__(name=None, file_system=None, file_system_default_quota=None, quota=None, usage=None, user=None)
Keyword Arguments:
 
  • name (str) – Name of the object (e.g., a file system or snapshot).
  • file_system (FixedReference) –
  • 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.
  • 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.
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Examples

Instantiating a Client

All of the examples on this page assume that you have instantiated a client object in this way and also have these imports. Different methods of authentication are discussed in Quick Start.

import pypureclient
from pypureclient import flashblade

try:
    # login to the array with your API_TOKEN
    client = flashblade.Client(target='10.255.9.28', api_token=API_TOKEN)
except pypureclient.exceptions.PureError as e:
    print("Exception when logging in to the array: %s\n" % e)

Common Fields

ids, names

Instead of getting all things, you can just get values for specific items.

# list a subset of admin accounts by name with api token exposed
res = client.get_admins(names=['pureuser'], expose_api_token=True)

If you know the id of the object (pureuser in this case) you can use ids instead of names

# list a subset of admin accounts by id
res = client.get_admins(ids=['10314f42-020d-7080-8013-000ddt400090'])

There are a number of other fields that follow the same logic such as bucket_names and bucket_ids. The usage will be the same and in these cases the object is clearly referenced by the field name.

filter

Check Quick Start for more information

sort

You can sort on a given field. By default it is in increasing order.

# list filesystems and sort by provisioned
res = client.get_file_systems(sort="provisioned")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

If you would like descending order, insert a - after the field.

# list filesystems and sort by provisioned
res = client.get_file_systems(sort="provisioned-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

For nested fields, use a .

# list and sort by name in descendant order
res = client.get_file_systems_policies(sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

offset, limit, continuation_token

Use offset to ignore the first couple items from the collection.

res = client.get_file_systems(offset=3)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Use limit to limit the number of results.

# list first five filesystems and sort by provisioned in descendant order
res = client.get_file_systems(limit=5, sort="provisioned-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

You can see that res will contain a continuation_token field. You can use this to print out the rest of the results.

# list all remaining file systems using continuation token from above
res = client.get_file_systems(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

total_only

If you don’t want the individual results, you can use total_only.

# total instantaneous performance across 2 targets
res = client.get_targets_performance_replication(names=['s3target1', 's3target2'],
                                                 total_only=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Active Directory

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_active_directory

# Delete active directory account
client.delete_active_directory(names=["test-config"])

# Do a local-only delete of an active directory account
client.delete_active_directory(names=["test-config"], local_only=True)

# Other valid fields: ids
# See section "Common Fields" for examples

get_active_directory

# List active directory accounts
res = client.get_active_directory()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

patch_active_directory

from pypureclient.flashblade import ActiveDirectoryPatch

# Change existing Active Directory account LDAP and kerberos servers, encryption types, and
# service principal names.
# Can alternatively supply fqdns instead of service_principal_names
ad_config = ActiveDirectoryPatch(directory_servers=["ldap.my-corporation.com"],
                                 kerberos_servers=["kdc.my-corporation.com"],
                                 encryption_types=["aes256-cts-hmac-sha1-96"],
                                 service_principal_names=["nfs/vip2.my-array.my-corporation.com"])
res = client.patch_active_directory(names=["test-config"], active_directory=ad_config)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Move existing Active Directory account to a different Join OU
ad_config = ActiveDirectoryPatch(join_ou="OU=FakeOU")
res = client.patch_active_directory(names=["test-config"], active_directory=ad_config)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: ids
# See section "Common Fields" for examples

post_active_directory

from pypureclient.flashblade import ActiveDirectoryPost

# Create new Active Directory account with specified LDAP and kerberos servers, computer name
# and specified encryption types, fqdns, and join_ou.
# Can alternatively supply service_principal_names instead of fqdns.
ad_config = ActiveDirectoryPost(computer_name="FLASHBLADE01",
                                directory_servers=["ldap.my-corporation.com"],
                                kerberos_servers=["kdc.my-corporation.com"],
                                domain="my-corporation.com",
                                encryption_types=["aes128-cts-hmac-sha1-96"],
                                fqdns=["vip1.my-array.my-corporation.com"],
                                join_ou="CN=FakeOU",
                                user="Administrator",
                                password="Password")

res = client.post_active_directory(names=["test-config"], active_directory=ad_config)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Join AD domain using an existing computer account
existing_ad_config = ActiveDirectoryPost(computer_name="FLASHBLADE01",
                                         domain="my-corporation.com",
                                         user="Administrator",
                                         password="Password")
res = client.post_active_directory(names=["test-config"], active_directory=existing_ad_config,
                                   join_existing_account=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_active_directory_test

# Test active directory accounts
res = client.get_active_directory_test()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, ids, limit, names, sort
# See section "Common Fields" for examples

Administrators

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_admins_api_tokens

# Delete api token for admin1
client.delete_admins_api_tokens(admin_names=["admin1"])

# Other valid fields: admin_ids
# See section "Common Fields" for examples

get_admins_api_tokens

# Get api tokens with current user's exposed
res = client.get_admins_api_tokens(expose_api_token=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: admin_ids, admin_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_admins_api_tokens

# Create api token for admin1 for 1 hour (timeout in ms)
res = client.post_admins_api_tokens(admin_names=["admin1"], timeout=1*60*60*1000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: admin_ids
# See section "Common Fields" for examples

delete_admins_cache

# delete an admin cache entry
client.delete_admins_cache(names=['adminuser'])

# delete all admin cache entries
client.delete_admins_cache()

# Other valid fields: ids
# See section "Common Fields" for examples

get_admins_cache

# list admin cache entry
res = client.get_admins_cache(names=['adminuser'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# refresh admin cache entry for user with id '10314f42-020d-7080-8013-000ddt400090'
res = client.get_admins_cache(ids=['10314f42-020d-7080-8013-000ddt400090'],
                              refresh=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

get_admins

# list all admin accounts (given sufficient permissions)
res = client.get_admins()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a subset of admin accounts by name with api token exposed
res = client.get_admins(names=['pureuser'], expose_api_token=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a subset of admin accounts by id
res = client.get_admins(ids=['10314f42-020d-7080-8013-000ddt400090'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

patch_admins

from pypureclient.flashblade import AdminPatch

# change password
myAdmin = AdminPatch(old_password='thisWASanOLDpasSwOrD', password='FAKEnewpaSsword')
res = client.patch_admins(names=['pureuser'], admin=myAdmin)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Set a public key for login via SSH
myAdmin = AdminPatch(public_key='ssh-rsa EXAMPLEzaC1yc2EAAAADAQABAAABAQDN1fshdvABLD/f2mkAUqkcUMKPsS+Os3omYFwe3G2Adxc'
                           'enBY+kLmbPXjiC9t4UDob3RiYu6HkDC2xvu8yLhlQTtsjCac2BkePJa/OTxttwY5G6OyYqWjmSmX9D6GZ13'
                           'CRr/rSxjXYo/2GE/0xyv27/Z+ikxjs6rzXXOhdxJ6hY1jD1D8+fHVxhr8+n6Zbod8and0rlgmarfRoRYlLh'
                           'GoRSCxNyOi6bG5ugrlIEXi8JZr8CpztGp/8WTa82XCSClFJPteC/5vLvwPGxwOraZ/BJngBPbmeeloN5lBl'
                           'W0KAndRqwNZcDBt8JnGioPd0Kv+SNufwR4nHCv8NgEXAMPLE')
res = client.patch_admins(names=['pureuser'], admin=myAdmin)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

Alert Watchers

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_alert_watchers

# delete an alert watcher with a given email address. this address will no longer receive
# any emails about any alerts, new or updated, from the system
client.delete_alert_watchers(names=['moved_teams@mydomain.com'])

# Other valid fields: ids
# See section "Common Fields" for examples

get_alert_watchers

# list alert watchers with email address matching the below wildcard patterns. the first
# pattern includes all emails with "on_call" in them, and second pattern includes all
# emails ending with "@example.com"
res = client.get_alert_watchers(
    names=['*on_call*', '*@example.com'], sort='name-')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset
# See section "Common Fields" for examples

patch_alert_watchers

from pypureclient.flashblade import AlertWatcher

# An example of how to disable an alert watcher, so they stop receiving all emails about
# alerts
watcher_settings = AlertWatcher(enabled=False)
res = client.patch_alert_watchers(
    names=['person_on_vacation@mydomain.com'], alert_watcher=watcher_settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# An example of how to set an alert watcher to only receive emails about alerts of severity
# 'critical'. This can be useful if there's an email alias tied directly into an on-call
# paging system or if there's an email alias of people who should be contacted about issues
# that need to be escalated quickly
watcher_settings = AlertWatcher(minimum_notification_severity='critical')
res = client.patch_alert_watchers(
    names=['storage_admins_on_call@mydomain.com'], alert_watcher=watcher_settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: ids
# See section "Common Fields" for examples

post_alert_watchers

from pypureclient.flashblade import AlertWatcherPost

# create an alert watcher with a given email address such that they'll receive emails
# about all system alerts
res = client.post_alert_watchers(names=['i_get_everything@example.com'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create an alert watcher with a given email address such that they'll only receive emails
# about alerts of severity 'warning' and above
watcher_create_settings = AlertWatcherPost(minimum_notification_severity='warning')
res = client.post_alert_watchers(names=['rack_monitor@example.com'],
                                 alert_watcher=watcher_create_settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_alert_watchers_test

# test alert watchers with given email addresses
res = client.get_alert_watchers_test(
    names=['test1@example.com', 'test2@example.com'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, ids, sort
# See section "Common Fields" for examples

Alerts

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_alerts

res = client.get_alerts()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list alerts and sort by severity
res = client.get_alerts(sort='severity')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, ids, names, offset
# See section "Common Fields" for examples

patch_alerts

from pypureclient.flashblade import Alert

# unflag an alert with the given id
alert_settings = Alert(flagged=False)
res = client.patch_alerts(
    names=['1'], alerts_settings=alert_settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

API Clients

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_api_clients

# delete the API client with name 'my_api_client'
client.delete_api_clients(names=['my_api_client'])

get_api_clients

# List all configured api clients.
res = client.get_api_clients()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List first two api clients beginning with 'my_oauth'. Use default sorting.
res = client.get_api_clients(limit=2, names=["my_oauth"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List the first api client when sorting by name.
res = client.get_api_clients(limit=1, sort="name")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List an api client by id.
res = client.get_api_clients(ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List all api_clients servers that are enabled.
res = client.get_api_clients(filter='enabled=\"True\"')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, offset
# See section "Common Fields" for examples

patch_api_clients

from pypureclient.flashblade import ApiClient

CLIENT_NAME = 'my_api_client'

# Enable the api client.
attr = ApiClient(enabled=True)
res = client.patch_api_clients(api_clients=attr, names=[CLIENT_NAME])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

post_api_clients

from pypureclient.flashblade import ApiClientsPost

CLIENT_NAME = 'my_api_client'
CLIENT_TTL_IN_MS = 1000 * 60 * 60       # 1 hour in milliseconds
CLIENT_PUB_KEY = ("\n"
                  "-----BEGIN PUBLIC KEY-----\n"
                  "MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0\n"
                  "eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR\n"
                  "gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O\n"
                  "nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum\n"
                  "2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q\n"
                  "sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr\n"
                  "1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1\n"
                  "64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R\n"
                  "1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6\n"
                  "SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+\n"
                  "D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd\n"
                  "FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ==\n"
                  "-----END PUBLIC KEY-----\n")

# Create a new api client with a max_role of storage_admin who has permissions to
# perform storage related operations such as administering volumes, hosts and host groups.
# Note that this created api client will have the lesser of the permissions granted by max_role
# in the api_client and the max role of the associated oauth login.
# The public_key will be the key provided by your oauth login provider.
attr = ApiClientsPost(max_role={'name': 'storage_admin'},
                      public_key=CLIENT_PUB_KEY,
                      issuer=CLIENT_NAME,
                      access_token_ttl_in_ms=CLIENT_TTL_IN_MS)
res = client.post_api_clients(names=[CLIENT_NAME], api_client=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Array Connections

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_array_connections_connection_key

# list all connection keys
res = client.get_array_connections_connection_key()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

post_array_connections_connection_key

# post to the array-connections/connection-key endpoint to get a connection key
res = client.post_array_connections_connection_key()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

delete_array_connections

# delete the array connection with the name 'otherarray'
client.delete_array_connections(remote_names=['otherarray'])

# delete the array connection with id '10314f42-020d-7080-8013-000ddt400090'
client.delete_array_connections(remote_ids=['10314f42-020d-7080-8013-000ddt400090'])

# Other valid fields: ids
# See section "Common Fields" for examples

get_array_connections

# list all array connections
res = client.get_array_connections()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all array connections with remote name "otherarray"
res = client.get_array_connections(remote_names=["otherarray"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all array connections with remote id '10314f42-020d-7080-8013-000ddt400090'
res = client.get_array_connections(remote_ids=['10314f42-020d-7080-8013-000ddt400090'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five array connections and sort by source in descendant order
res = client.get_array_connections(limit=5, sort="version-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining array connections
res = client.get_array_connections(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter to see only array connections on a specified version
res = client.get_array_connections(filter='version=\'3.*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, offset
# See section "Common Fields" for examples

patch_array_connections

from pypureclient.flashblade import ArrayConnection

# Update the management and replication addresses of an array connection
new_attr = ArrayConnection(management_address="10.202.101.70",
                           replication_addresses=["10.202.101.71", "10.202.101.72"])
# update the array connection named otherarray
res = client.patch_array_connections(remote_names=["otherarray"], array_connection=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# update the array connection with id '10314f42-020d-7080-8013-000ddt400090'
res = client.patch_array_connections(ids=['10314f42-020d-7080-8013-000ddt400090'],
                                     array_connection=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: remote_ids
# See section "Common Fields" for examples

get_array_connections_path

# list all array connection paths
res = client.get_array_connections_path()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five array connection paths using default sort
res = client.get_array_connections_path(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five array connection paths and sort by source in descendant order
res = client.get_array_connections_path(limit=5, sort="source-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining array connection paths
res = client.get_array_connections_path(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter to see only array connection paths from a specified source ip
res = client.get_array_connections_path(filter='source=\'10.202.101.70\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, remote_ids, remote_names, offset
# See section "Common Fields" for examples

get_array_connections_performance_replication

# list instantaneous replication performance for all array connections
res = client.get_array_connections_performance_replication()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous file-replication performance for all array connections
res = client.get_array_connections_performance_replication(type='file-system')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous file-replication performance for array connection with id '10314f42-020d-7080-8013-000ddt400090'
res = client.get_array_connections_performance_replication(ids=['10314f42-020d-7080-8013-000ddt400090'],
                                                           type='file-system')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical object-replication performance for all array connections between some
# start time and end time
res = client.get_array_connections_performance_replication(
    start_time=START_TIME,
    end_time=END_TIME,
    type='object-store',
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical object-replication performance for array connection 'remote_array' between some
# start time and end time
res = client.get_array_connections_performance_replication(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000,
    type='object-store',
    names=['remote_array'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, remote_ids, remote_names,
#                     sort, total_only
# See section "Common Fields" for examples

post_array_connections

from pypureclient.flashblade import ArrayConnectionPost

# connect to an array with specified hostname, using a provided connection key
hostname = "https://my.array.com"
connection_key = "6207d123-d123-0b5c-5fa1-95fabc5c7123"
myAC = ArrayConnectionPost(management_address=hostname, connection_key=connection_key)
# post the array connection object on the array we're connection from
res = client.post_array_connections(array_connection=myAC)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# connect to an array by ip address and specifying replication addresses, using a provided connection key
mgmt_addr = "10.202.101.78"
repl_addr = ["10.202.101.70"]
connection_key = "6207d123-d123-0b5c-5fa1-95fabc5c7123"
myAC = ArrayConnectionPost(management_address=mgmt_addr, replication_addresses=repl_addr, connection_key=connection_key)
# post the array connection object on the array we're connection from
res = client.post_array_connections(array_connection=myAC)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Arrays

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_arrays_eula

res = client.get_arrays_eula()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

patch_arrays_eula

from pypureclient.flashblade import Eula, EulaSignature

# Update the Eula signature
signature = EulaSignature(name="example name", title="example", company="one company")
eula_body = Eula(signature=signature)
res = client.patch_arrays_eula(eula=eula_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_arrays

res = client.get_arrays()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

get_arrays_http_specific_performance

res = client.get_arrays_http_specific_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list historical http performance
res = client.get_arrays_http_specific_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    r