openapi: 3.0.1 info: title: FlashArray REST Active Directory Array Connections API version: '2.52' description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries. ' servers: - url: / tags: - name: Array Connections description: 'Manages connections between arrays. ' paths: /api/2.52/array-connections: get: tags: - Array Connections summary: Pure Storage List the Connected Arrays description: 'Displays a list of connected arrays. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Remote_ids' - $ref: '#/components/parameters/Remote_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionGetResponse' post: tags: - Array Connections summary: Pure Storage Create an Array Connection description: 'Creates a connection between this array and the specified array. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPost' required: true x-codegen-request-body-name: array-connection responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionResponse' x-codegen-request-body-name: array-connection delete: tags: - Array Connections summary: Pure Storage Delete an Array Connection description: 'Deletes the connection between this array and the specified array. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Array Connections summary: Pure Storage Modify an Array Connection description: 'Modifies attributes for an array connection. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Refresh' - $ref: '#/components/parameters/Renew_encryption_key' requestBody: content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPatch' required: false x-codegen-request-body-name: array-connection responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionResponse' x-codegen-request-body-name: array-connection /api/2.52/array-connections/connection-key: get: tags: - Array Connections summary: Pure Storage List Connection Key description: Displays the connection key for the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Encrypted' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionKeyGetResponse' /api/2.52/array-connections/path: get: tags: - Array Connections summary: Pure Storage List Connection Path description: 'Displays the connection path from the array to which the connection was made. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Remote_ids' - $ref: '#/components/parameters/Remote_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPathGetResponse' '207': description: 'Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPathGetResponse' /api/2.26/array-connections: get: tags: - Array Connections summary: Pure Storage GET Array-connections description: List connected arrays for replication. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Remote_ids' - $ref: '#/components/parameters/Remote_names' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionGetResponse' post: tags: - Array Connections summary: Pure Storage POST Array-connections description: Create a connection to an array for replication and configure network settings. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPost_2' required: true x-codegen-request-body-name: array-connection responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionResponse' x-codegen-request-body-name: array-connection delete: tags: - Array Connections summary: Pure Storage DELETE Array-connections description: Delete a connection to an array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Remote_ids_deprecated' - $ref: '#/components/parameters/Remote_names_deprecated' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Array Connections summary: Pure Storage PATCH Array-connections description: Modify the configuration of a connected array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Remote_ids_deprecated' - $ref: '#/components/parameters/Remote_names_deprecated' requestBody: content: application/json: schema: $ref: '#/components/schemas/ArrayConnection_2' required: true x-codegen-request-body-name: array-connection responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionResponse' x-codegen-request-body-name: array-connection /api/2.26/array-connections/connection-key: get: tags: - Array Connections summary: Pure Storage GET Array-connections/connection-key description: List connection keys used to authenticate the connection from one array to another. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionKeyGetResponse_2' post: tags: - Array Connections summary: Pure Storage POST Array-connections/connection-key description: Create an array connection key allowing one array to connect to another for replication. parameters: - $ref: '#/components/parameters/XRequestId' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionKeyResponse' /api/2.26/array-connections/path: get: tags: - Array Connections summary: Pure Storage GET Array-connections/path description: List network path details of connected arrays. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Remote_ids' - $ref: '#/components/parameters/Remote_names' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPathGetResponse_2' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ArrayConnectionPathGetResponse_2' /api/2.26/array-connections/performance/replication: get: tags: - Array Connections summary: Pure Storage GET Array-connections/performance/replication description: List performance metrics of file systems or objects being replicated from one array to another. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Remote_ids' - $ref: '#/components/parameters/Remote_names' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Start_time' - $ref: '#/components/parameters/Total_only' - $ref: '#/components/parameters/Type_for_performance' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConnectionRelationshipPerformanceReplicationGetResp' components: schemas: _fixedReferenceNoResourceType: type: object properties: id: description: 'A non-modifiable, globally unique ID chosen by the system. ' type: string readOnly: true name: type: string readOnly: true x-readOnly: true ArrayConnectionPath_2: allOf: - $ref: '#/components/schemas/_builtInRelationship' - $ref: '#/components/schemas/_context_2' - description: 'Path from a source array to a destination array. `id` is the `id` of the array connection. ' type: object properties: destination: description: 'IP address with the port of the target array. ' type: string readOnly: true example: 10.202.101.70:443 remote: description: 'The remote array. ' title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' source: description: 'IP address of the source array. ' type: string readOnly: true example: 10.202.101.70 status: description: '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. ' type: string readOnly: true status_details: description: 'Additional information describing any issues encountered when connecting, or `null` if the `status` is `connected`. ' type: string readOnly: true type: description: 'The type of path. Valid values include `async-replication` and `fleet-management`. ' type: string ArrayConnection: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - description: 'Connection to a target array. The `name` and `id` values refer to the name and ID of the target array. ' type: object properties: encryption: description: 'If `encrypted`, all traffic over this array connection will be encrypted. If `unencrypted`, all traffic over this array connection will be unencrypted. ' type: string example: encrypted encryption_mode: description: 'Cryptographic protocol, trust model, and encryption algorithm information. Will be `null` if `encrypted` is `false`. ' type: string example: TLS-PSK-AES-256 management_address: description: 'Management IP address or FQDN of the target array. ' type: string example: 10.202.101.78 os: description: 'The operating system of the connected array. ' type: string readOnly: true remote: description: 'The remote array. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' replication_addresses: description: 'IP addresses of the target arrays when `replication_transport` is `ip`. WWNs of the target arrays when `replication_transport` is `fc`. ' type: array items: type: string example: 10.202.101.70 replication_transport: description: 'The protocol used to transport data between the local array and the remote array. Valid values are `ip` and `fc`. The default value is `ip`. ' type: string example: ip status: description: 'Status of the connection. Valid values include `connected`, `connecting`, `partially_connected`, and `unbalanced`. A status of `connected` indicates that arrays are communicating. A status of `connecting` indicates that the array is trying to establish a connection. A status of `partially_connected` indicates that some replication addresses are communicating but others are not. A status of `unbalanced` indicates that the arrays are communicating, but the set of paths is either not redundant or not symmetrical. ' type: string throttle: $ref: '#/components/schemas/_throttle' type: description: 'The type of connection. Valid values include `async-replication`, `sync-replication`, and `fleet-management`. ' type: string version: description: The Purity version on the target array. type: string example: 5.0.0 ArrayConnectionKeyGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/ArrayConnectionKeyResponse' _errorContextResponseErrors: type: object properties: context: description: 'Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be `null` for more general errors. ' type: string location_context: description: 'Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be `null` for more general errors, or if no explicit `context` parameter was provided with the request. ' title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' message: description: A description of the error which occurred. type: string example: Resource does not exist. ArrayConnectionPathResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayConnectionPath' _throttle_deprecated: type: object properties: default_limit: description: 'Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs. ' type: integer format: int64 example: 1073741824 window: description: Deprecated. The time during which the `window_limit` threshold is in effect. title: Time_window allOf: - $ref: '#/components/schemas/_time_window' window_limit: description: 'Deprecated. Maximum bandwidth threshold for outbound traffic during the specified `window_limit` time range in bytes. Once exceeded, bandwidth throttling occurs. ' type: integer format: int64 example: 2097152 _errorContextResponse: type: object properties: errors: description: The list of errors encountered when attempting to perform an operation. type: array readOnly: true items: $ref: '#/components/schemas/_errorcontextresponseErrors' ArrayConnectionKey: type: object properties: connection_key: description: 'Connection-key used on another array to connect to this array. ' type: string readOnly: true example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 _replication_performance: type: object properties: received_bytes_per_sec: description: Total bytes received per second. type: number format: double minimum: 0 readOnly: true transmitted_bytes_per_sec: description: Total bytes transmitted per second. type: number format: double minimum: 0 readOnly: true x-readOnly: true ArrayConnectionKeyResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayConnectionKey_2' ArrayConnectionPathGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayConnectionPathResponse' - $ref: '#/components/schemas/_errorContextResponse' _continuousReplicationPerformance: allOf: - $ref: '#/components/schemas/_replication_performance' - type: object properties: object_backlog: description: 'The total number of pending object operations and their size that are currently in the backlog. ' title: ObjectBacklog allOf: - $ref: '#/components/schemas/_objectBacklog' x-readOnly: true ArrayConnectionPost_2: allOf: - $ref: '#/components/schemas/ArrayConnection_2' - type: object properties: connection_key: description: 'The connection key of the target array. Settable on POST only. ' type: string example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 encrypted: description: '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`. ' type: boolean throttle: $ref: '#/components/schemas/_throttle_2' _reference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string x-aliases: - _referenceWithoutType ConnectionRelationshipPerformanceReplication: allOf: - $ref: '#/components/schemas/_builtInRelationship' - type: object properties: aggregate: description: 'Total bytes transmitted or received per second for all types of replication. ' title: Replication_performance allOf: - $ref: '#/components/schemas/_replication_performance' continuous: description: 'Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication. ' title: ContinuousReplicationPerformance allOf: - $ref: '#/components/schemas/_continuousReplicationPerformance' periodic: description: 'Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based. ' title: Replication_performance allOf: - $ref: '#/components/schemas/_replication_performance' remote: description: Reference to a remote array. title: FixedReferenceNoResourceType allOf: - $ref: '#/components/schemas/_fixedReferenceNoResourceType' time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true _builtInRelationship: type: object properties: id: description: 'A non-modifiable, globally unique ID chosen by the system. ' type: string readOnly: true _fixedReferenceWithoutType: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true _errorcontextresponseErrors: type: object properties: context: description: 'Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be `null` for more general errors. ' type: string location_context: description: 'Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be `null` for more general errors, or if no explicit `context` parameter was provided with the request. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' message: description: A description of the error which occurred. type: string example: Resource does not exist. x-aliases: - _errorContextResponseErrors ArrayConnectionPath: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_context' - description: 'Path from the local array to a remote array. The `name` parameter indicates the name of the remote array. ' type: object properties: encryption: description: 'If `encrypted`, all traffic over this array connection will be encrypted. If `unencrypted`, all traffic over this array connection will be unencrypted. ' type: string example: encrypted encryption_mode: description: 'Cryptographic protocol, trust model, and encryption algorithm information. Will be `null` if `encrypted` is `false`. ' type: string example: TLS-PSK-AES-256 id: description: 'A globally unique, system-generated ID of an array connection. ' type: string readOnly: true local_address: description: 'IP address or WWN of the local port. ' type: string example: 10.202.101.70 local_port: description: 'The local port of the path. ' type: string example: ct0.eth0 remote: description: 'The remote array. ' title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' remote_address: description: 'IP address or WWN of the remote port. ' type: string example: 10.202.101.78 remote_port: description: 'The remote port of the path. ' type: string example: ct1.eth0 replication_transport: description: 'The protocol used to transport data between the local array and the remote array. Valid values are `ip` and `fc`. ' type: string status: description: 'Status of the connection. Valid values are `connected`, `connecting`, and `quarantined`. A status of `connected` indicates that the arrays are communicating. A status of `connecting` indicates that the array is trying to establish a connection. A status of `quarantined` indicates that the path is unstable and has been temporarily embargoed for synchronous replication connections. ' type: string readOnly: true status_details: description: 'Additional information describing any issues encountered when connecting, or `null` if the `status` is `connected`. ' type: string readOnly: true type: description: 'The type of path. Valid values include `async-replication`, `sync-replication`, and `fleet-management`. ' type: string _errorContextResponse_2: type: object properties: errors: description: The list of errors encountered when attempting to perform an operation. type: array readOnly: true items: $ref: '#/components/schemas/_errorContextResponseErrors' _throttle_2: description: 'The bandwidth throttling for an array connection or target. ' type: object properties: default_limit: description: 'Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs. ' type: integer format: int64 example: 1073741824 window: description: The time during which the window_limit threshold is in effect. title: Time_window allOf: - $ref: '#/components/schemas/_time_window' window_limit: description: 'Maximum bandwidth threshold for outbound traffic during the specified `window_limit` time range in bytes. Once exceeded, bandwidth throttling occurs. ' type: integer format: int64 example: 2097152 _referenceWithType: allOf: - $ref: '#/components/schemas/_reference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and `policies/snapshot`, etc. ' type: string x-aliases: - _reference _fixedReferenceWithType: allOf: - $ref: '#/components/schemas/_fixedReference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true x-aliases: - _fixedReference ArrayConnectionKeyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayConnectionKey' _builtIn: description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can''t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs). ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string readOnly: true name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string readOnly: true ArrayConnection_2: allOf: - $ref: '#/components/schemas/_builtInRelationship' - $ref: '#/components/schemas/_context_2' - description: 'Connection to a target array. ' type: object properties: ca_certificate_group: description: '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. ' title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' encrypted: description: '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`. ' type: boolean management_address: description: 'Management address of the target array. Settable on POST only. ' type: string example: 10.202.101.78 os: description: 'The operating system of the connected array. ' type: string readOnly: true remote: description: 'The remote array. ' title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' replication_addresses: description: '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. ' type: array items: type: string example: 10.202.101.70 status: description: 'Status of the connection. Valid values include `connected`, `partially_connected`, `connecting`, and `incompatible`. `connected` - The connection is OK. `partially_connected` - Some replication addresses are working, but others are not. `connecting` - No connection exists and the array is trying to reconnect. `incompatible` - The target array is not compatible. ' type: string readOnly: true throttle: $ref: '#/components/schemas/_throttle_2' type: description: 'The type of connection. Valid values include `async-replication` and `fleet-management`. ' type: string readOnly: true version: description: The version of the target array. type: string readOnly: true example: 2.3.0 _time_window: type: object properties: end: description: The window end time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., `28800000`, which is equal to 8:00 AM). type: integer format: int64 example: 46800000 start: description: The window start time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., `18000000`, which is equal to 5:00 AM). type: integer format: int64 example: 3600000 ArrayConnectionResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayConnection' _context_2: type: object properties: context: description: 'The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet or to the fleet itself. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' readOnly: true title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' ArrayConnectionPathGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: items: type: array items: $ref: '#/components/schemas/ArrayConnectionPath_2' _context: type: object properties: context: description: 'The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet or to the fleet itself. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' ConnectionRelationshipPerformanceReplicationGetResp: allOf: - $ref: '#/components/schemas/PageInfo_2' - type: object properties: items: type: array items: $ref: '#/components/schemas/ConnectionRelationshipPerformanceReplication' total: description: 'Total of all records after filtering. If `total_only` query param is `true`, then no items will be returned. ' type: array items: $ref: '#/components/schemas/ConnectionRelationshipPerformanceReplication' ArrayConnectionGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/ArrayConnectionResponse' - $ref: '#/components/schemas/_errorContextResponse' ArrayConnectionPost: type: object properties: connection_key: description: 'The connection key of the target array. ' type: string example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 encryption: description: 'If `encrypted`, all traffic over this array connection will be encrypted. If `unencrypted`, all traffic over this array connection will be unencrypted. Defaults to `unencrypted`. ' type: string example: encrypted management_address: description: 'Management IP address of the target array. ' type: string example: 10.202.101.78 replication_addresses: description: 'IP addresses and FQDNs of the target arrays. Configurable only when `replication_transport` is set to `ip`. If not configured, will be set to all the replication addresses available on the target array at the time of the POST. ' type: array items: type: string example: 10.202.101.70 replication_transport: description: 'The protocol used to transport data between the local array and the remote array. Valid values are `ip` and `fc`. The default is `ip`. ' type: string example: ip type: description: 'The type of replication. Valid values are `async-replication` and `sync-replication`. ' type: string example: async-replication _fixedReference_2: allOf: - $ref: '#/components/schemas/_fixedReferenceWithoutType' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true _objectBacklog: type: object properties: bytes_count: description: 'The size of the objects in bytes that need to be replicated. This does not include the size of custom metadata. ' type: integer format: int64 readOnly: true delete_ops_count: description: 'The number of DELETE operations that need to be replicated. ' type: integer format: int64 readOnly: true other_ops_count: description: 'The number of other operations that need to be replicated. ' type: integer format: int64 readOnly: true put_ops_count: description: 'The number of PUT operations that need to be replicated. ' type: integer format: int64 readOnly: true PageInfo_2: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the `continuation_token` to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The `continuation_token` is generated if the `limit` is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string total_item_count: description: Total number of items after applying `filter` params. type: integer format: int32 _fixedReference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true x-aliases: - _fixedReferenceWithoutType ArrayConnectionKey_2: type: object properties: connection_key: description: 'Connection-key, used on another array to connect to this array. After creation, listing will only show ****. ' type: string readOnly: true example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 created: description: Creation time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true expires: description: Expiration time in milliseconds since UNIX epoch. type: integer format: int64 readOnly: true x-readOnly: true _builtInResourceNoId: description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can''t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs, file systems, file system snapshots, volume snapshot). ' type: object properties: name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string readOnly: true ArrayConnectionPatch: allOf: - $ref: '#/components/schemas/_throttle_deprecated' - type: object properties: connection_key: description: 'The connection key of the target array. It is required when `encryption` is changed, or when `type` is changed from `async-replication` to `sync-replication`. ' type: string example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 encryption: description: 'If `encrypted`, encryption will be enabled for all traffic over this array connection. If `unencrypted`, encryption will be disabled for all traffic over this array connection. `connection_key` must be specified when encryption is changed. If not specified, the current encryption option for the array connection will remain unchanged. ' type: string example: encrypted management_address: description: 'Management IP address of the target array. ' type: string example: 10.202.101.78 replication_addresses: description: 'IP addresses and FQDNs of the target arrays. Configurable only when `replication_transport` is set to `ip`. ' type: array items: type: string example: 10.202.101.70 throttle: $ref: '#/components/schemas/_throttle' type: description: 'The type of replication. Valid values are `async-replication` and `sync-replication`. ' type: string _throttle: description: 'The bandwidth throttling for an array connection. Configurable on PATCH only. ' type: object properties: default_limit: description: 'Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs. ' type: integer format: int64 example: 1073741824 window: description: The time during which the `window_limit` threshold is in effect. title: Time_window allOf: - $ref: '#/components/schemas/_time_window' window_limit: description: 'Maximum bandwidth threshold for outbound traffic during the specified `window_limit` time range in bytes. Once exceeded, bandwidth throttling occurs. ' type: integer format: int64 example: 2097152 PageInfo: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string more_items_remaining: description: 'Returns a value of `true` if subsequent items can be retrieved. ' type: boolean example: false total_item_count: description: 'The total number of records after applying all filter query parameters. The `total_item_count` will be calculated if and only if the corresponding query parameter `total_item_count` is set to `true`. If this query parameter is not set or set to `false`, a value of `null` will be returned. ' type: integer format: int32 parameters: Filter: name: filter in: query description: 'Narrows down the results to only the response objects that satisfy the filter criteria. ' schema: type: string Start_time: name: start_time in: query description: 'When the time window starts (in milliseconds since epoch). ' schema: type: integer format: int64 minimum: 0 example: 1514764800000 Offset: name: offset in: query description: 'The starting position based on the results of the query in relation to the full set of response objects returned. ' schema: type: integer format: int32 minimum: 0 example: 10 Allow_errors: name: allow_errors in: query description: 'If set to `true`, the API will allow the operation to continue even if there are errors. Any errors will be returned in the `errors` field of the response. If set to `false`, the operation will fail if there are any errors. ' schema: type: boolean default: false Encrypted: name: encrypted in: query description: 'If `true`, the returned array connection key will encode an encryption key used to establish trust and secure replication traffic. If `false`, the returned array connection key will not encode an encryption key. If not specified, defaults to `false`. ' schema: type: boolean Remote_ids_deprecated: name: remote_ids in: query description: 'A comma-separated list of remote array IDs. Deprecated, best practice is to reference connections with `ids`. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter. ' style: form explode: false schema: type: array items: type: string Continuation_token: name: continuation_token in: query description: 'A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters. ' schema: type: string Refresh: name: refresh in: query description: 'If set to `true`, the array will attempt to communicate with the connection peer in order to update the connection attributes on both arrays with any changes that have occurred. If set to `true`, other array connection attributes may not be modified in requests. Default value is `false`. ' schema: type: boolean Offset_2: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 example: 10 Resolution: name: resolution in: query description: 'The desired ms between samples. Available resolutions may depend on data type, `start_time` and `end_time`. In general `1000`, `30000`, `300000`, `1800000`, `7200000`, and `86400000` are possible values. ' schema: type: integer format: int64 minimum: 0 example: 30000 Context_names: name: context_names in: query description: 'Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' style: form explode: false schema: type: array items: type: string XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string Limit: name: limit in: query description: 'Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. ' schema: type: integer format: int32 minimum: 0 example: 10 Renew_encryption_key: name: renew_encryption_key in: query description: 'If set to `true`, update array connection with a new encryption key. If set to `true`, other array connection attributes may not be modified in requests. Defaults to `false`. ' schema: type: boolean Remote_ids: name: remote_ids in: query description: 'A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter. ' style: form explode: false schema: type: array items: type: string Authorization: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) ' schema: type: string Names: name: names in: query description: 'Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources. ' style: form explode: false schema: type: array items: type: string Context_names_get: name: context_names in: query description: 'Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. Enter multiple names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string Sort_2: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). NOTE: If you provide a sort you will not get a `continuation_token` in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Total_only: name: total_only in: query description: 'If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. ' schema: type: boolean Ids: name: ids in: query description: "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" style: form explode: false schema: type: array items: type: string End_time: name: end_time in: query description: 'When the time window ends (in milliseconds since epoch). ' schema: type: integer format: int64 minimum: 0 example: 1514764800000 Remote_names: name: remote_names in: query description: 'A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter. ' style: form explode: false schema: type: array items: type: string Ids_2: name: ids in: query description: 'A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of `ids`, then an error is returned. This cannot be provided together with the `name` or `names` query parameters. ' style: form explode: false schema: type: array items: type: string Remote_names_deprecated: name: remote_names in: query description: 'A comma-separated list of remote array names. Deprecated, best practice is to reference connections with `ids`. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with `remote_ids` query parameter. ' style: form explode: false schema: type: array items: type: string Total_item_count: name: total_item_count in: query description: 'If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`. ' schema: type: boolean Type_for_performance: name: type in: query description: 'Display the metric of a specified object type. Valid values are `all`, `file-system`, and `object-store`. If not specified, defaults to `all`. ' schema: type: string Sort: name: sort in: query description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string