From e1adbf18879e3c06ec07fbce753b1d63e9248653 Mon Sep 17 00:00:00 2001 From: Matt Robertson Date: Tue, 26 Nov 2024 14:06:59 -0600 Subject: [PATCH 1/2] Added FlashArray 2.36 & 2.37 Changed from updating from external website to using local github repository. The swagger folder and the purest folder should be in the same directory. --- html/models/FA2.35/log-target-file.yaml | 28 +++ html/models/FA2.35/log-target.yaml | 8 + .../FA2.35/policy-audit-file-patch.yaml | 9 + .../models/FA2.35/policy-audit-file-post.yaml | 9 + html/models/FA2.35/policy-audit-file.yaml | 9 + html/models/FA2.35/support-patch.yaml | 11 ++ html/models/FA2.35/support.yaml | 60 ++++++ html/models/FA2.35/syslog-server.yaml | 15 ++ .../virtual-machine-volume-snapshot.yaml | 54 ++++++ html/models/FA2.36/_admin-role.yaml | 3 + html/models/FA2.36/_container-qos.yaml | 16 ++ ...ixed-reference-with-type-and-location.yaml | 9 + html/models/FA2.36/_location-reference.yaml | 10 + html/models/FA2.36/_member-with-type.yaml | 7 + html/models/FA2.36/_pod_array_status.yaml | 8 + .../_policyrulemanagementaccess-rules.yaml | 16 ++ ...e-no-deprecated-physical-or-effective.yaml | 110 +++++++++++ html/models/FA2.36/admin-cache.yaml | 18 ++ html/models/FA2.36/admin-patch.yaml | 7 + html/models/FA2.36/admin-post.yaml | 14 ++ html/models/FA2.36/admin.yaml | 41 ++++ html/models/FA2.36/api-client-post.yaml | 46 +++++ html/models/FA2.36/api-client.yaml | 67 +++++++ html/models/FA2.36/certificate-group.yaml | 2 + .../FA2.36/container-eradication-config.yaml | 13 ++ html/models/FA2.36/container-performance.yaml | 15 ++ .../FA2.36/directory-service-role-post.yaml | 23 +++ .../models/FA2.36/directory-service-role.yaml | 25 +++ html/models/FA2.36/fleet-key.yaml | 18 ++ html/models/FA2.36/fleet-member-post.yaml | 25 +++ html/models/FA2.36/fleet-member.yaml | 18 ++ html/models/FA2.36/fleet.yaml | 6 + html/models/FA2.36/host-group.yaml | 26 +++ html/models/FA2.36/host.yaml | 25 +++ .../FA2.36/network-interface-performance.yaml | 179 ++++++++++++++++++ html/models/FA2.36/pod-member.yaml | 7 + html/models/FA2.36/pod.yaml | 24 +++ .../FA2.36/policy-assignment-post-policy.yaml | 7 + .../models/FA2.36/policy-assignment-post.yaml | 8 + .../policy-management-access-effective.yaml | 10 + .../policy-management-access-patch.yaml | 18 ++ .../FA2.36/policy-management-access-post.yaml | 18 ++ .../FA2.36/policy-management-access.yaml | 23 +++ html/models/FA2.36/policy-member-clean.yaml | 12 ++ html/models/FA2.36/realm-patch.yaml | 23 +++ html/models/FA2.36/realm-post.yaml | 14 ++ html/models/FA2.36/realm.yaml | 43 +++++ html/models/FA2.36/remote-array.yaml | 31 +++ html/models/FA2.36/resource-realm-space.yaml | 13 ++ .../FA2.36/support-diagnostics-details.yaml | 17 ++ .../FA2.36/support-diagnostics-settings.yaml | 14 ++ html/models/FA2.37/_upgrade_parameters.yaml | 9 + html/models/FA2.37/directory-service.yaml | 52 +++++ .../FA2.37/software-installation-post.yaml | 15 ++ html/models/FA2.37/software-installation.yaml | 15 ++ .../FA2.37/target-protection-group.yaml | 24 +++ html/models/FB2.15/_space.yaml | 9 + html/models/FB2.15/bucket.yaml | 6 + html/models/FB2.15/object-store-account.yaml | 8 + .../directories-policies-audit-file.path.yaml | 64 +++++++ html/paths/FA2.35/log-targets-file.path.yaml | 71 +++++++ .../log-targets-syslog-settings.path.yaml | 38 ++++ .../FA2.35/log-targets-syslog-test.path.yaml | 19 ++ .../paths/FA2.35/log-targets-syslog.path.yaml | 70 +++++++ html/paths/FA2.35/log-targets.path.yaml | 20 ++ .../policies-audit-file-members.path.yaml | 66 +++++++ .../FA2.35/policies-audit-file.path.yaml | 81 ++++++++ html/paths/FA2.35/support.path.yaml | 38 ++++ html/paths/FA2.35/syslog-servers.path.yaml | 70 +++++++ ...virtual-machine-volume-snapshots.path.yaml | 35 ++++ .../FA2.36/admin-policies-access.path.yaml | 66 +++++++ html/paths/FA2.36/admins-cache.path.yaml | 47 +++++ html/paths/FA2.36/admins.path.yaml | 72 +++++++ html/paths/FA2.36/api-clients.path.yaml | 77 ++++++++ .../certificate-groups-certificates.path.yaml | 54 ++++++ .../paths/FA2.36/certificate-groups.path.yaml | 48 +++++ .../certificates-certificate-groups.path.yaml | 52 +++++ ...irectory-services-roles-policies.path.yaml | 67 +++++++ .../FA2.36/directory-services-roles.path.yaml | 74 ++++++++ html/paths/FA2.36/fleet-key.path.yaml | 35 ++++ html/paths/FA2.36/fleet-members.path.yaml | 64 +++++++ html/paths/FA2.36/fleets.path.yaml | 36 ++++ html/paths/FA2.36/host-groups.path.yaml | 66 +++++++ html/paths/FA2.36/hosts.path.yaml | 75 ++++++++ .../network-interfaces-performance.path.yaml | 24 +++ .../FA2.36/pods-arrays-members.path.yaml | 76 ++++++++ html/paths/FA2.36/pods-members.path.yaml | 70 +++++++ html/paths/FA2.36/pods-performance.path.yaml | 29 +++ html/paths/FA2.36/pods.path.yaml | 94 +++++++++ ...licies-management-access-members.path.yaml | 64 +++++++ .../policies-management-access.path.yaml | 79 ++++++++ .../paths/FA2.36/realms-performance.path.yaml | 27 +++ html/paths/FA2.36/realms-space.path.yaml | 26 +++ html/paths/FA2.36/realms.path.yaml | 80 ++++++++ html/paths/FA2.36/remote-arrays.path.yaml | 27 +++ .../support-diagnostics-details.path.yaml | 19 ++ .../support-diagnostics-settings.path.yaml | 33 ++++ html/paths/FA2.36/volume-groups.path.yaml | 90 +++++++++ .../paths/FA2.37/directory-services.path.yaml | 39 ++++ .../protection-groups-targets.path.yaml | 91 +++++++++ .../FA2.37/software-installations.path.yaml | 65 +++++++ html/paths/FB2.15/buckets.path.yaml | 80 ++++++++ .../FB2.15/object-store-accounts.path.yaml | 79 ++++++++ .../FA2.36/certificate_group_ids.query.yaml | 10 + .../FA2.36/certificate_group_names.query.yaml | 9 + .../FA2.36/container_ignore_usage.query.yaml | 6 + .../FA2.36/destroy_contents.query.yaml | 6 + .../FA2.36/eradicate_contents.query.yaml | 6 + html/queries/FA2.36/fleet_ids.query.yaml | 8 + html/queries/FA2.36/fleet_names.query.yaml | 9 + .../queries/FA2.36/from_member_ids.query.yaml | 9 + .../FA2.36/from_member_names.query.yaml | 9 + .../FA2.36/member_ids-unrestricted.query.yaml | 8 + .../move_with_host_group_names.query.yaml | 9 + .../FA2.36/move_with_host_names.query.yaml | 8 + html/queries/FA2.36/names_single.query.yaml | 8 + html/queries/FA2.36/pod_ids.query.yaml | 7 + html/queries/FA2.36/pod_names.query.yaml | 8 + .../FA2.36/policy_ids-unrestricted.query.yaml | 8 + html/queries/FA2.36/purity-default.query.yaml | 5 + html/queries/FA2.36/role_names.query.yaml | 7 + html/queries/FA2.36/to_member_ids.query.yaml | 8 + .../queries/FA2.36/to_member_names.query.yaml | 8 + html/queries/FA2.36/unreachable.query.yaml | 7 + .../FA2.35/log-target-file-get-response.yaml | 3 + .../FA2.35/log-target-file-response.yaml | 6 + .../FA2.35/log-targets-get-response.yaml | 3 + .../FA2.35/log-targets-response.yaml | 6 + .../policy-audit-file-get-response.yaml | 3 + .../FA2.35/policy-audit-file-response.yaml | 8 + .../FA2.35/support-get-response.yaml | 3 + html/responses/FA2.35/support-response.yaml | 6 + .../FA2.35/syslog-server-get-response.yaml | 3 + .../FA2.35/syslog-server-response.yaml | 6 + ...tual-machine-volume-snapshot-response.yaml | 9 + .../FA2.36/admin-cache-get-response.yaml | 3 + .../FA2.36/admin-cache-response.yaml | 6 + html/responses/FA2.36/admin-get-response.yaml | 3 + html/responses/FA2.36/admin-response.yaml | 6 + .../FA2.36/api-client-get-response.yaml | 3 + .../responses/FA2.36/api-client-response.yaml | 8 + ...ficate-certificate-group-get-response.yaml | 3 + ...ertificate-certificate-group-response.yaml | 7 + ...ficate-group-certificate-get-response.yaml | 3 + ...ertificate-group-certificate-response.yaml | 7 + .../certificate-group-get-response.yaml | 3 + .../FA2.36/certificate-group-response.yaml | 7 + .../container-performance-get-response.yaml | 17 ++ .../directory-service-role-get-response.yaml | 3 + .../directory-service-role-response.yaml | 6 + html/responses/FA2.36/fleet-get-response.yaml | 3 + .../FA2.36/fleet-key-get-response.yaml | 3 + html/responses/FA2.36/fleet-key-response.yaml | 7 + .../FA2.36/fleet-member-get-response.yaml | 3 + .../FA2.36/fleet-member-response.yaml | 8 + html/responses/FA2.36/fleet-response.yaml | 9 + html/responses/FA2.36/host-get-response.yaml | 3 + .../FA2.36/host-group-get-response.yaml | 3 + .../responses/FA2.36/host-group-response.yaml | 8 + html/responses/FA2.36/host-response.yaml | 8 + ...rk-interface-performance-get-response.yaml | 16 ++ html/responses/FA2.36/pod-get-response.yaml | 11 ++ .../FA2.36/pod-member-get-response.yaml | 3 + .../responses/FA2.36/pod-member-response.yaml | 9 + html/responses/FA2.36/pod-response.yaml | 6 + ...policy-management-access-get-response.yaml | 3 + .../policy-management-access-response.yaml | 8 + .../policy-member-clean-get-response.yaml | 3 + .../FA2.36/policy-member-clean-response.yaml | 8 + html/responses/FA2.36/realm-get-response.yaml | 11 ++ html/responses/FA2.36/realm-response.yaml | 6 + .../FA2.36/realm-space-get-response.yaml | 18 ++ .../FA2.36/remote-arrays-response.yaml | 10 + ...port-diagnostics-details-get-response.yaml | 3 + .../support-diagnostics-details-response.yaml | 6 + .../support-diagnostics-get-response.yaml | 3 + .../FA2.36/support-diagnostics-response.yaml | 6 + .../directory-service-get-response.yaml | 3 + .../FA2.37/directory-service-response.yaml | 6 + .../protection-group-target-get-response.yaml | 3 + .../protection-group-target-response.yaml | 8 + .../software-installations-get-response.yaml | 3 + .../software-installations-response.yaml | 6 + .../responses/FB2.15/bucket-get-response.yaml | 6 + html/responses/FB2.15/bucket-response.yaml | 7 + .../object-store-account-get-response.yaml | 10 + .../FB2.15/object-store-account-response.yaml | 7 + rest_extract/purest_download.py | 90 +++++---- 188 files changed, 4469 insertions(+), 36 deletions(-) create mode 100644 html/models/FA2.35/log-target-file.yaml create mode 100644 html/models/FA2.35/log-target.yaml create mode 100644 html/models/FA2.35/policy-audit-file-patch.yaml create mode 100644 html/models/FA2.35/policy-audit-file-post.yaml create mode 100644 html/models/FA2.35/policy-audit-file.yaml create mode 100644 html/models/FA2.35/support-patch.yaml create mode 100644 html/models/FA2.35/support.yaml create mode 100644 html/models/FA2.35/syslog-server.yaml create mode 100644 html/models/FA2.35/virtual-machine-volume-snapshot.yaml create mode 100644 html/models/FA2.36/_admin-role.yaml create mode 100644 html/models/FA2.36/_container-qos.yaml create mode 100644 html/models/FA2.36/_fixed-reference-with-type-and-location.yaml create mode 100644 html/models/FA2.36/_location-reference.yaml create mode 100644 html/models/FA2.36/_member-with-type.yaml create mode 100644 html/models/FA2.36/_pod_array_status.yaml create mode 100644 html/models/FA2.36/_policyrulemanagementaccess-rules.yaml create mode 100644 html/models/FA2.36/_space-no-deprecated-physical-or-effective.yaml create mode 100644 html/models/FA2.36/admin-cache.yaml create mode 100644 html/models/FA2.36/admin-patch.yaml create mode 100644 html/models/FA2.36/admin-post.yaml create mode 100644 html/models/FA2.36/admin.yaml create mode 100644 html/models/FA2.36/api-client-post.yaml create mode 100644 html/models/FA2.36/api-client.yaml create mode 100644 html/models/FA2.36/certificate-group.yaml create mode 100644 html/models/FA2.36/container-eradication-config.yaml create mode 100644 html/models/FA2.36/container-performance.yaml create mode 100644 html/models/FA2.36/directory-service-role-post.yaml create mode 100644 html/models/FA2.36/directory-service-role.yaml create mode 100644 html/models/FA2.36/fleet-key.yaml create mode 100644 html/models/FA2.36/fleet-member-post.yaml create mode 100644 html/models/FA2.36/fleet-member.yaml create mode 100644 html/models/FA2.36/fleet.yaml create mode 100644 html/models/FA2.36/host-group.yaml create mode 100644 html/models/FA2.36/host.yaml create mode 100644 html/models/FA2.36/network-interface-performance.yaml create mode 100644 html/models/FA2.36/pod-member.yaml create mode 100644 html/models/FA2.36/pod.yaml create mode 100644 html/models/FA2.36/policy-assignment-post-policy.yaml create mode 100644 html/models/FA2.36/policy-assignment-post.yaml create mode 100644 html/models/FA2.36/policy-management-access-effective.yaml create mode 100644 html/models/FA2.36/policy-management-access-patch.yaml create mode 100644 html/models/FA2.36/policy-management-access-post.yaml create mode 100644 html/models/FA2.36/policy-management-access.yaml create mode 100644 html/models/FA2.36/policy-member-clean.yaml create mode 100644 html/models/FA2.36/realm-patch.yaml create mode 100644 html/models/FA2.36/realm-post.yaml create mode 100644 html/models/FA2.36/realm.yaml create mode 100644 html/models/FA2.36/remote-array.yaml create mode 100644 html/models/FA2.36/resource-realm-space.yaml create mode 100644 html/models/FA2.36/support-diagnostics-details.yaml create mode 100644 html/models/FA2.36/support-diagnostics-settings.yaml create mode 100644 html/models/FA2.37/_upgrade_parameters.yaml create mode 100644 html/models/FA2.37/directory-service.yaml create mode 100644 html/models/FA2.37/software-installation-post.yaml create mode 100644 html/models/FA2.37/software-installation.yaml create mode 100644 html/models/FA2.37/target-protection-group.yaml create mode 100644 html/models/FB2.15/_space.yaml create mode 100644 html/models/FB2.15/bucket.yaml create mode 100644 html/models/FB2.15/object-store-account.yaml create mode 100644 html/paths/FA2.35/directories-policies-audit-file.path.yaml create mode 100644 html/paths/FA2.35/log-targets-file.path.yaml create mode 100644 html/paths/FA2.35/log-targets-syslog-settings.path.yaml create mode 100644 html/paths/FA2.35/log-targets-syslog-test.path.yaml create mode 100644 html/paths/FA2.35/log-targets-syslog.path.yaml create mode 100644 html/paths/FA2.35/log-targets.path.yaml create mode 100644 html/paths/FA2.35/policies-audit-file-members.path.yaml create mode 100644 html/paths/FA2.35/policies-audit-file.path.yaml create mode 100644 html/paths/FA2.35/support.path.yaml create mode 100644 html/paths/FA2.35/syslog-servers.path.yaml create mode 100644 html/paths/FA2.35/virtual-machine-volume-snapshots.path.yaml create mode 100644 html/paths/FA2.36/admin-policies-access.path.yaml create mode 100644 html/paths/FA2.36/admins-cache.path.yaml create mode 100644 html/paths/FA2.36/admins.path.yaml create mode 100644 html/paths/FA2.36/api-clients.path.yaml create mode 100644 html/paths/FA2.36/certificate-groups-certificates.path.yaml create mode 100644 html/paths/FA2.36/certificate-groups.path.yaml create mode 100644 html/paths/FA2.36/certificates-certificate-groups.path.yaml create mode 100644 html/paths/FA2.36/directory-services-roles-policies.path.yaml create mode 100644 html/paths/FA2.36/directory-services-roles.path.yaml create mode 100644 html/paths/FA2.36/fleet-key.path.yaml create mode 100644 html/paths/FA2.36/fleet-members.path.yaml create mode 100644 html/paths/FA2.36/fleets.path.yaml create mode 100644 html/paths/FA2.36/host-groups.path.yaml create mode 100644 html/paths/FA2.36/hosts.path.yaml create mode 100644 html/paths/FA2.36/network-interfaces-performance.path.yaml create mode 100644 html/paths/FA2.36/pods-arrays-members.path.yaml create mode 100644 html/paths/FA2.36/pods-members.path.yaml create mode 100644 html/paths/FA2.36/pods-performance.path.yaml create mode 100644 html/paths/FA2.36/pods.path.yaml create mode 100644 html/paths/FA2.36/policies-management-access-members.path.yaml create mode 100644 html/paths/FA2.36/policies-management-access.path.yaml create mode 100644 html/paths/FA2.36/realms-performance.path.yaml create mode 100644 html/paths/FA2.36/realms-space.path.yaml create mode 100644 html/paths/FA2.36/realms.path.yaml create mode 100644 html/paths/FA2.36/remote-arrays.path.yaml create mode 100644 html/paths/FA2.36/support-diagnostics-details.path.yaml create mode 100644 html/paths/FA2.36/support-diagnostics-settings.path.yaml create mode 100644 html/paths/FA2.36/volume-groups.path.yaml create mode 100644 html/paths/FA2.37/directory-services.path.yaml create mode 100644 html/paths/FA2.37/protection-groups-targets.path.yaml create mode 100644 html/paths/FA2.37/software-installations.path.yaml create mode 100644 html/paths/FB2.15/buckets.path.yaml create mode 100644 html/paths/FB2.15/object-store-accounts.path.yaml create mode 100644 html/queries/FA2.36/certificate_group_ids.query.yaml create mode 100644 html/queries/FA2.36/certificate_group_names.query.yaml create mode 100644 html/queries/FA2.36/container_ignore_usage.query.yaml create mode 100644 html/queries/FA2.36/destroy_contents.query.yaml create mode 100644 html/queries/FA2.36/eradicate_contents.query.yaml create mode 100644 html/queries/FA2.36/fleet_ids.query.yaml create mode 100644 html/queries/FA2.36/fleet_names.query.yaml create mode 100644 html/queries/FA2.36/from_member_ids.query.yaml create mode 100644 html/queries/FA2.36/from_member_names.query.yaml create mode 100644 html/queries/FA2.36/member_ids-unrestricted.query.yaml create mode 100644 html/queries/FA2.36/move_with_host_group_names.query.yaml create mode 100644 html/queries/FA2.36/move_with_host_names.query.yaml create mode 100644 html/queries/FA2.36/names_single.query.yaml create mode 100644 html/queries/FA2.36/pod_ids.query.yaml create mode 100644 html/queries/FA2.36/pod_names.query.yaml create mode 100644 html/queries/FA2.36/policy_ids-unrestricted.query.yaml create mode 100644 html/queries/FA2.36/purity-default.query.yaml create mode 100644 html/queries/FA2.36/role_names.query.yaml create mode 100644 html/queries/FA2.36/to_member_ids.query.yaml create mode 100644 html/queries/FA2.36/to_member_names.query.yaml create mode 100644 html/queries/FA2.36/unreachable.query.yaml create mode 100644 html/responses/FA2.35/log-target-file-get-response.yaml create mode 100644 html/responses/FA2.35/log-target-file-response.yaml create mode 100644 html/responses/FA2.35/log-targets-get-response.yaml create mode 100644 html/responses/FA2.35/log-targets-response.yaml create mode 100644 html/responses/FA2.35/policy-audit-file-get-response.yaml create mode 100644 html/responses/FA2.35/policy-audit-file-response.yaml create mode 100644 html/responses/FA2.35/support-get-response.yaml create mode 100644 html/responses/FA2.35/support-response.yaml create mode 100644 html/responses/FA2.35/syslog-server-get-response.yaml create mode 100644 html/responses/FA2.35/syslog-server-response.yaml create mode 100644 html/responses/FA2.35/virtual-machine-volume-snapshot-response.yaml create mode 100644 html/responses/FA2.36/admin-cache-get-response.yaml create mode 100644 html/responses/FA2.36/admin-cache-response.yaml create mode 100644 html/responses/FA2.36/admin-get-response.yaml create mode 100644 html/responses/FA2.36/admin-response.yaml create mode 100644 html/responses/FA2.36/api-client-get-response.yaml create mode 100644 html/responses/FA2.36/api-client-response.yaml create mode 100644 html/responses/FA2.36/certificate-certificate-group-get-response.yaml create mode 100644 html/responses/FA2.36/certificate-certificate-group-response.yaml create mode 100644 html/responses/FA2.36/certificate-group-certificate-get-response.yaml create mode 100644 html/responses/FA2.36/certificate-group-certificate-response.yaml create mode 100644 html/responses/FA2.36/certificate-group-get-response.yaml create mode 100644 html/responses/FA2.36/certificate-group-response.yaml create mode 100644 html/responses/FA2.36/container-performance-get-response.yaml create mode 100644 html/responses/FA2.36/directory-service-role-get-response.yaml create mode 100644 html/responses/FA2.36/directory-service-role-response.yaml create mode 100644 html/responses/FA2.36/fleet-get-response.yaml create mode 100644 html/responses/FA2.36/fleet-key-get-response.yaml create mode 100644 html/responses/FA2.36/fleet-key-response.yaml create mode 100644 html/responses/FA2.36/fleet-member-get-response.yaml create mode 100644 html/responses/FA2.36/fleet-member-response.yaml create mode 100644 html/responses/FA2.36/fleet-response.yaml create mode 100644 html/responses/FA2.36/host-get-response.yaml create mode 100644 html/responses/FA2.36/host-group-get-response.yaml create mode 100644 html/responses/FA2.36/host-group-response.yaml create mode 100644 html/responses/FA2.36/host-response.yaml create mode 100644 html/responses/FA2.36/network-interface-performance-get-response.yaml create mode 100644 html/responses/FA2.36/pod-get-response.yaml create mode 100644 html/responses/FA2.36/pod-member-get-response.yaml create mode 100644 html/responses/FA2.36/pod-member-response.yaml create mode 100644 html/responses/FA2.36/pod-response.yaml create mode 100644 html/responses/FA2.36/policy-management-access-get-response.yaml create mode 100644 html/responses/FA2.36/policy-management-access-response.yaml create mode 100644 html/responses/FA2.36/policy-member-clean-get-response.yaml create mode 100644 html/responses/FA2.36/policy-member-clean-response.yaml create mode 100644 html/responses/FA2.36/realm-get-response.yaml create mode 100644 html/responses/FA2.36/realm-response.yaml create mode 100644 html/responses/FA2.36/realm-space-get-response.yaml create mode 100644 html/responses/FA2.36/remote-arrays-response.yaml create mode 100644 html/responses/FA2.36/support-diagnostics-details-get-response.yaml create mode 100644 html/responses/FA2.36/support-diagnostics-details-response.yaml create mode 100644 html/responses/FA2.36/support-diagnostics-get-response.yaml create mode 100644 html/responses/FA2.36/support-diagnostics-response.yaml create mode 100644 html/responses/FA2.37/directory-service-get-response.yaml create mode 100644 html/responses/FA2.37/directory-service-response.yaml create mode 100644 html/responses/FA2.37/protection-group-target-get-response.yaml create mode 100644 html/responses/FA2.37/protection-group-target-response.yaml create mode 100644 html/responses/FA2.37/software-installations-get-response.yaml create mode 100644 html/responses/FA2.37/software-installations-response.yaml create mode 100644 html/responses/FB2.15/bucket-get-response.yaml create mode 100644 html/responses/FB2.15/bucket-response.yaml create mode 100644 html/responses/FB2.15/object-store-account-get-response.yaml create mode 100644 html/responses/FB2.15/object-store-account-response.yaml diff --git a/html/models/FA2.35/log-target-file.yaml b/html/models/FA2.35/log-target-file.yaml new file mode 100644 index 00000000..0155c5bd --- /dev/null +++ b/html/models/FA2.35/log-target-file.yaml @@ -0,0 +1,28 @@ +allOf: +- $ref: ../../models/FA2.35/log-target.yaml +- description: A file log target + type: object + properties: + directory: + description: Directory name to be used as log target. + allOf: + - $ref: ../../models/FA2.3/_reference-with-type.yaml + keep_for: + description: Specifies the period that audit logs are retained before they are + deleted, in milliseconds. If not specified, defaults to `null` which means + size based retention does not apply. Use 0 to reset the value to `null`. At + least one of the `keep_for` or `keep_size` parameters are required, and they + can be set together. + type: integer + format: int64 + minimum: 86400000 + example: 86400000 + keep_size: + description: Specifies the maximum size of audit logs to be retained. Measured + in bytes. When exceeded, older logs will be deleted. If not specified, defaults + to `null` which means size based retention does not apply. Use 0 to reset + the value to `null`. + type: integer + format: int64 + minimum: 1000000 + example: 1000000 diff --git a/html/models/FA2.35/log-target.yaml b/html/models/FA2.35/log-target.yaml new file mode 100644 index 00000000..9965818c --- /dev/null +++ b/html/models/FA2.35/log-target.yaml @@ -0,0 +1,8 @@ +allOf: +- $ref: ../../models/FA2.2/_fixed-name-resource-no-id.yaml +- properties: + target_type: + description: The type of log target. Valid values include `file`, and `syslog`. + readOnly: true + type: string + example: syslog diff --git a/html/models/FA2.35/policy-audit-file-patch.yaml b/html/models/FA2.35/policy-audit-file-patch.yaml new file mode 100644 index 00000000..a2b6fa67 --- /dev/null +++ b/html/models/FA2.35/policy-audit-file-patch.yaml @@ -0,0 +1,9 @@ +allOf: +- $ref: ../../models/FA2.3/policy-patch.yaml +- properties: + log_targets: + description: A list of targets to which audit logs will be sent. This list, + if sent, overrides existing target list. + type: array + items: + $ref: ../../models/FA2.26/_reference-no-id-with-type.yaml diff --git a/html/models/FA2.35/policy-audit-file-post.yaml b/html/models/FA2.35/policy-audit-file-post.yaml new file mode 100644 index 00000000..d2655cd4 --- /dev/null +++ b/html/models/FA2.35/policy-audit-file-post.yaml @@ -0,0 +1,9 @@ +allOf: +- $ref: ../../models/FA2.3/policy-post.yaml +- properties: + log_targets: + description: A list of targets to which audit logs will be sent. + type: array + required: true + items: + $ref: ../../models/FA2.26/_reference-no-id-with-type.yaml diff --git a/html/models/FA2.35/policy-audit-file.yaml b/html/models/FA2.35/policy-audit-file.yaml new file mode 100644 index 00000000..204fa5ca --- /dev/null +++ b/html/models/FA2.35/policy-audit-file.yaml @@ -0,0 +1,9 @@ +allOf: +- $ref: ../../models/FA2.24/policy.yaml +- properties: + log_targets: + description: A list of targets to which audit logs will be sent. + type: array + required: true + items: + $ref: ../../models/FA2.26/_reference-no-id-with-type.yaml diff --git a/html/models/FA2.35/support-patch.yaml b/html/models/FA2.35/support-patch.yaml new file mode 100644 index 00000000..8161fb8c --- /dev/null +++ b/html/models/FA2.35/support-patch.yaml @@ -0,0 +1,11 @@ +allOf: +- $ref: ../../models/FA2.2/support-patch.yaml +- properties: + remote_assist_duration: + type: integer + format: int64 + description: Specifies the duration of the remote assist session in milliseconds. + This parameter should only be provided when establishing a new session. This + parameter determines the length of time the session will remain active after + it is initiated. + example: 86400000 diff --git a/html/models/FA2.35/support.yaml b/html/models/FA2.35/support.yaml new file mode 100644 index 00000000..67470845 --- /dev/null +++ b/html/models/FA2.35/support.yaml @@ -0,0 +1,60 @@ +allOf: +- $ref: ../../models/FA2.35/support-patch.yaml +- type: object + properties: + phonehome_enabled: + description: If set to `true`, enables phonehome. If set to `false`, disables + phonehome. + type: boolean + proxy: + description: The value of the current proxy, which is used to connect to cloud + services such as phonehome and remote assist. Specify the server name, including + the scheme and proxy port number. + type: string + example: http://proxy.example.com:8080 + remote_assist_active: + description: If set to `true`, enables the remote assist session. If set to + `false`, disables the remote assist session. + type: boolean + remote_assist_duration: + type: integer + format: int64 + description: Specifies the duration of the remote assist session in milliseconds. + This parameter should only be provided when establishing a new session. It + determines the length of time the session will remain active after it's initiated. + example: 86400000 + remote_assist_opened: + description: The timestamp when the session opened, measured in milliseconds + since the UNIX epoch. + type: integer + format: int64 + readOnly: true + example: 1574460534674 + remote_assist_expires: + description: The timestamp when the session expires, measured in milliseconds + since the UNIX epoch. + type: integer + format: int64 + readOnly: true + example: 1574633337678 + remote_assist_status: + description: The status of the remote assist session. Values include `connected`, + `connecting`, `disconnected`, and `session-active`. + type: string + readOnly: true + example: connected + remote_assist_paths: + type: array + readOnly: true + items: + properties: + component_name: + description: The name of the local controller that is running the remote + assist session. + type: string + example: CT0 + status: + description: The status of the remote assist session on the local controller. + Values include `connected`, `connecting`, `disconnected`, and `session-active`. + type: string + example: connected diff --git a/html/models/FA2.35/syslog-server.yaml b/html/models/FA2.35/syslog-server.yaml new file mode 100644 index 00000000..8e55455a --- /dev/null +++ b/html/models/FA2.35/syslog-server.yaml @@ -0,0 +1,15 @@ +allOf: +- $ref: ../../models/FA2.35/log-target.yaml +- description: A syslog server + type: object + properties: + uri: + description: The URI of the syslog server in the format `PROTOCOL://HOSTNAME:PORT`. + type: string + example: tcp://my.syslogserver.com + services: + description: Valid values are `data-audit` and `management`. If not specified, + defaults to `management`. + type: array + items: + type: string diff --git a/html/models/FA2.35/virtual-machine-volume-snapshot.yaml b/html/models/FA2.35/virtual-machine-volume-snapshot.yaml new file mode 100644 index 00000000..3820cf45 --- /dev/null +++ b/html/models/FA2.35/virtual-machine-volume-snapshot.yaml @@ -0,0 +1,54 @@ +allOf: +- properties: + vm_id: + description: The ID of the virtual machine, as assigned by the external system. + type: string + readOnly: true + vm_type: + description: The type of virtual machine. The only valid value is `vvol`. + type: string + example: vvol + readOnly: true + vvol_type: + description: The type of virtual machine volume. Values include `config` and + `data`. + type: string + example: config + readOnly: true + vvol_name: + description: The name of the virtual machine volume. + type: string + readOnly: true + id: + description: A globally unique, system-generated ID. The ID cannot be modified. + type: string + readOnly: true + name: + description: The name of the virtual machine volume snapshot. + type: string + readOnly: true + created: + description: The virtual machine volume snapshot creation time measured in milliseconds + since the UNIX epoch. + type: integer + format: int64 + readOnly: true + destroyed: + description: Returns a value of `true` if the virtual machine volume snapshot + has been destroyed and is pending eradication. + type: boolean + readOnly: true + time_remaining: + description: Specifies the amount of time left until the destroyed volume snapshot + is permanently eradicated, measured in milliseconds. Once the `time_remaining` + period has elapsed, the volume snapshot is permanently eradicated and can + no longer be recovered. + type: integer + format: int64 + readOnly: true + recover_context: + description: A reference to any additional entities needed to recover this virtual + machine. + readOnly: true + allOf: + - $ref: ../../models/FA2.0/_fixed-reference.yaml diff --git a/html/models/FA2.36/_admin-role.yaml b/html/models/FA2.36/_admin-role.yaml new file mode 100644 index 00000000..6728e5fd --- /dev/null +++ b/html/models/FA2.36/_admin-role.yaml @@ -0,0 +1,3 @@ +allOf: +- description: This field has been deprecated. Predecessor to management access policies. +- $ref: ../../models/FA2.0/_reference-no-id.yaml diff --git a/html/models/FA2.36/_container-qos.yaml b/html/models/FA2.36/_container-qos.yaml new file mode 100644 index 00000000..17e6dbd7 --- /dev/null +++ b/html/models/FA2.36/_container-qos.yaml @@ -0,0 +1,16 @@ +type: object +properties: + bandwidth_limit: + description: The maximum QoS bandwidth limit for the container. Whenever throughput + exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. + Maximum limit is 512 GB/s. + type: integer + format: int64 + minimum: 1048576 + maximum: 549755813888 + iops_limit: + description: The QoS IOPs limit for the container. + type: integer + format: int64 + minimum: 100 + maximum: 100000000 diff --git a/html/models/FA2.36/_fixed-reference-with-type-and-location.yaml b/html/models/FA2.36/_fixed-reference-with-type-and-location.yaml new file mode 100644 index 00000000..ddd568ad --- /dev/null +++ b/html/models/FA2.36/_fixed-reference-with-type-and-location.yaml @@ -0,0 +1,9 @@ +allOf: +- $ref: ../../models/FA2.0/_fixed-reference.yaml +- $ref: ../../models/FA2.36/_location-reference.yaml +- properties: + resource_type: + type: string + description: "Type of the object (full name of the endpoint).\n Valid values\ + \ are the unique part of the resource's REST endpoint.\n For example, a reference\ + \ to a fleet would have a\n `resource_type` of `fleets`." diff --git a/html/models/FA2.36/_location-reference.yaml b/html/models/FA2.36/_location-reference.yaml new file mode 100644 index 00000000..76c489d1 --- /dev/null +++ b/html/models/FA2.36/_location-reference.yaml @@ -0,0 +1,10 @@ +allOf: +- $ref: ../../models/FA2.0/_reference.yaml +- type: object + properties: + is_local: + type: boolean + description: -> If set to `true`, the location reference is to the local array. + If set to `false`, the location reference is to a remote location, such as + a remote array or offload target. + readOnly: true diff --git a/html/models/FA2.36/_member-with-type.yaml b/html/models/FA2.36/_member-with-type.yaml new file mode 100644 index 00000000..027c6843 --- /dev/null +++ b/html/models/FA2.36/_member-with-type.yaml @@ -0,0 +1,7 @@ +allOf: +- type: object + properties: + group: + $ref: ../../models/FA2.3/_reference-with-type.yaml + member: + $ref: ../../models/FA2.3/_reference-with-type.yaml diff --git a/html/models/FA2.36/_pod_array_status.yaml b/html/models/FA2.36/_pod_array_status.yaml new file mode 100644 index 00000000..f6315d97 --- /dev/null +++ b/html/models/FA2.36/_pod_array_status.yaml @@ -0,0 +1,8 @@ +allOf: +- $ref: ../../models/FA2.1/_pod_array_status.yaml +- type: object +- properties: + member: + description: A reference to the member associated with the pod's array status. + allOf: + - $ref: ../../models/FA2.3/_reference-with-type.yaml diff --git a/html/models/FA2.36/_policyrulemanagementaccess-rules.yaml b/html/models/FA2.36/_policyrulemanagementaccess-rules.yaml new file mode 100644 index 00000000..87971a9c --- /dev/null +++ b/html/models/FA2.36/_policyrulemanagementaccess-rules.yaml @@ -0,0 +1,16 @@ +type: object +properties: + role: + description: Role defines a set of permissions applicable in a scope. `viewer` + grants users the ability to read a resource. `support` grants the ability to + perform general support-related actions, as well as read resources. `storage` + grants access to all storage operations on a resource. `admin` grants access + to all operations. + allOf: + - $ref: ../../models/FA2.0/_reference-no-id.yaml + scope: + description: Reference to the resource (e.g. arrays, realms) which specifies the + scope that the role applies. The `id` or `name` parameter is required, but they + cannot be set together. Also, `resource_type` must be set. + allOf: + - $ref: ../../models/FA2.3/_reference-with-type.yaml diff --git a/html/models/FA2.36/_space-no-deprecated-physical-or-effective.yaml b/html/models/FA2.36/_space-no-deprecated-physical-or-effective.yaml new file mode 100644 index 00000000..1f42d64c --- /dev/null +++ b/html/models/FA2.36/_space-no-deprecated-physical-or-effective.yaml @@ -0,0 +1,110 @@ +allOf: +- readOnly: true +- properties: + data_reduction: + description: The ratio of mapped sectors within a volume versus the amount of + physical space the data occupies after data compression and deduplication. + The data reduction ratio does not include thin provisioning savings. For example, + a data reduction ratio of 5:1 means that for every 5 MB the host writes + to the array, 1 MB is stored on the array's flash modules. + type: number + format: float + shared: + description: The physical space occupied by deduplicated data, meaning that + the space is shared with other volumes and snapshots as a result of data deduplication, + measured in bytes. On Evergreen//One arrays, this is the effective space contributed + by data that is not unique to a specific volume, managed directory, or snapshot, + measured in bytes. + type: integer + format: int64 + minimum: 0 + example: 111863360624 + snapshots: + description: The physical space occupied by data unique to one or more snapshots, + measured in bytes. On Evergreen//One arrays, this is the effective space contributed + by data unique to one or more snapshots, measured in bytes. + type: integer + format: int64 + minimum: 0 + system: + description: The physical space occupied by internal array metadata, measured + in bytes. + type: integer + format: int64 + minimum: 0 + thin_provisioning: + description: The percentage of volume sectors that do not contain host-written + data because the hosts have not written data to them or the sectors have been + explicitly trimmed. + type: number + format: float + minimum: 0.0 + maximum: 1.0 + total_reduction: + description: The ratio of provisioned sectors within a volume versus the amount + of physical space the data occupies after reduction via data compression and + deduplication and with thin provisioning savings. Total reduction is data + reduction with thin provisioning savings. For example, a total reduction ratio + of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored + on the array's flash modules. + type: number + format: float + unique: + description: The unique physical space occupied by customer data. Unique physical + space does not include shared space, snapshots, and internal array metadata. + Measured in bytes. On Evergreen//One arrays, this is the effective space contributed + by unique customer data, measured in bytes. Unique data does not include shared + space, snapshots, and internal array metadata. + type: integer + format: int64 + minimum: 0 + virtual: + description: The amount of logically written data that a volume or a snapshot + references, measured in bytes. + type: integer + format: int64 + minimum: 0 + total_provisioned: + description: The provisioned size of a volume for a single volume, host or host + group, protocol endpoint, managed directory, and containers can be infinite + or measured in bytes. Infinite is represented by `null`. The provisioned size + for a host or host group, includes all volumes that are connected to the resource. + The provisioned size for a protocol endpoint is `null'. The provisioned size + for a managed directory is the quota limit if it or its parent has a managed + directory configured, otherwise it defaults to `null`. The provisioned size + for a container is the sum of the total_provisioned of the object it contains, + capped by the container's quota limit (or the container's used_provisioned + if current usage is above the quota limit), if any. Provisioned size represents + the storage capacity reported to hosts. + type: integer + format: int64 + minimum: 0 + example: 19937690345472 + readOnly: true + used_provisioned: + description: The amount of logical space a container has consumed. The amount + of logical space is compared against the quota limit if the container has + one configured. Used provisioned does not include destroyed objects inside + the container. For a destroyed container, used provisioned can include destroyed + objects and represents how much logical space it would take to recover the + container. + type: integer + format: int64 + minimum: 0 + example: 19937690345472 + readOnly: true + total_used: + description: The total space contributed by customer data, measured in bytes. + type: integer + format: int64 + minimum: 0 + readOnly: true + footprint: + description: The maximum amount of physical space the container would take up + on any array, ignoring any data shared outside the container. Measured in + bytes. On Evergreen//One arrays, this is the maximum amount of effective used + space, measured in bytes. The footprint metric is mostly used for capacity + planning. This field will be null in non-container contexts. + type: integer + format: int64 + minimum: 0 diff --git a/html/models/FA2.36/admin-cache.yaml b/html/models/FA2.36/admin-cache.yaml new file mode 100644 index 00000000..f8bab3fb --- /dev/null +++ b/html/models/FA2.36/admin-cache.yaml @@ -0,0 +1,18 @@ +allOf: +- $ref: ../../models/FA2.2/_fixed-name-resource-no-id.yaml +- description: A cache entry for the admin cache to quickly look up admin roles. +- type: object + readOnly: true + properties: + cached_at: + description: Time when the entry was added to the cache, in milliseconds since + the UNIX epoch. + type: integer + format: int64 + role: + $ref: ../../models/FA2.36/_admin-role.yaml + management_access_policies: + description: List of management access policies associated with the administrator. + type: array + items: + $ref: ../../models/FA2.3/_fixed-reference-with-type.yaml diff --git a/html/models/FA2.36/admin-patch.yaml b/html/models/FA2.36/admin-patch.yaml new file mode 100644 index 00000000..965019b8 --- /dev/null +++ b/html/models/FA2.36/admin-patch.yaml @@ -0,0 +1,7 @@ +allOf: +- $ref: ../../models/FA2.36/admin.yaml +- type: object + properties: + old_password: + description: The current password. + type: string diff --git a/html/models/FA2.36/admin-post.yaml b/html/models/FA2.36/admin-post.yaml new file mode 100644 index 00000000..f2c6bc6c --- /dev/null +++ b/html/models/FA2.36/admin-post.yaml @@ -0,0 +1,14 @@ +type: object +properties: + password: + description: Password associated with the account. + type: string + role: + $ref: ../../models/FA2.36/_admin-role.yaml + management_access_policies: + description: List of management access policies to associate with the administrator. + Policies can be specified by the `name` or `ID` parameter, but they cannot be + set together. + type: array + items: + $ref: ../../models/FA2.3/_reference-with-type.yaml diff --git a/html/models/FA2.36/admin.yaml b/html/models/FA2.36/admin.yaml new file mode 100644 index 00000000..c355a482 --- /dev/null +++ b/html/models/FA2.36/admin.yaml @@ -0,0 +1,41 @@ +allOf: +- $ref: ../../models/FA2.2/_fixed-name-resource-no-id.yaml +- description: Administrator account. +- type: object + properties: + api_token: + $ref: ../../models/FA2.2/_api-token.yaml + is_local: + description: Returns a value of `true` if the user is local to the machine. + type: boolean + example: true + readOnly: true + locked: + description: Returns a value of `true` if the user is currently locked out. + otherwise `false`. Change to `false` to unlock a user. This field is only + visible to `array_admin` roles. For all other users, the value is always `null`. + type: boolean + example: false + lockout_remaining: + description: The remaining lockout period if the user is locked out, in milliseconds. + This field is only visible to `array_admin` roles. For all other users, the + value is always `null`. + type: integer + format: int64 + example: null + readOnly: true + password: + description: Password associated with the account. + type: string + public_key: + description: Public key for SSH access. Multiple public keys can be specified, + separated by newlines. + type: string + role: + $ref: ../../models/FA2.36/_admin-role.yaml + management_access_policies: + description: List of management access policies associated with the administrator. + readOnly: true + type: array + items: + $ref: ../../models/FA2.3/_reference-with-type.yaml diff --git a/html/models/FA2.36/api-client-post.yaml b/html/models/FA2.36/api-client-post.yaml new file mode 100644 index 00000000..c45845e0 --- /dev/null +++ b/html/models/FA2.36/api-client-post.yaml @@ -0,0 +1,46 @@ +type: object +properties: + max_role: + description: Deprecated. The maximum Admin Access Policy (previously 'role') allowed + for ID Tokens issued by this API client. The bearer of an access token will + be authorized to perform actions within the intersection of this policy and + that of the array user specified as the JWT `sub` (subject) claim. `max_role` + is deprecated in favor of `access_policies`, but remains for backwards compatibility. + If `max_role` is the name of a valid legacy role, it will be interpreted as + the corresponding access policy of the same name. Otherwise, it's invalid. + type: string + example: storage_admin + access_policies: + description: The access policies allowed for ID Tokens issued by this API client. + The bearer of an access token will be authorized to perform actions within the + intersection of these policies and those of the array user specified as the + JWT `sub` (subject) claim. + type: array + items: + $ref: ../../models/FA2.3/_reference-with-type.yaml + issuer: + description: 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. + type: string + example: https://purestorage.idp.okta.com + public_key: + description: The API client's PEM formatted (Base64 encoded) RSA public key. Include + the `-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----` lines. + type: string + required: true + example: '-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 + eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O + nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q + sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 + 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 + SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd + FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----' + access_token_ttl_in_ms: + description: The TTL (Time To Live) length of time for the exchanged access token. + Measured in milliseconds. If not specified, defaults to `86400000`. + min: 1000 + max: 86400000 + type: integer + format: int64 + example: 15000 diff --git a/html/models/FA2.36/api-client.yaml b/html/models/FA2.36/api-client.yaml new file mode 100644 index 00000000..94e8f339 --- /dev/null +++ b/html/models/FA2.36/api-client.yaml @@ -0,0 +1,67 @@ +type: object +readOnly: true +properties: + id: + description: The unique identifier for the associated API client. The ID represents + the JWT `aud` (audience) claim in ID Tokens issued for this API client. + type: string + example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 + name: + description: The API client name. + type: string + example: NightlyStatsAggregationScript + max_role: + description: This field has been deprecated. The maximum Admin Access Policy (previously + 'role') allowed for ID Tokens issued by this API client. The bearer of an access + token will be authorized to perform actions within the intersection of this + policy and that of the array user specified as the JWT `sub` (subject) claim. + `max_role` is deprecated in favor of `access_policies`, but remains for backwards + compatibility. If a client has exactly one access policy which corresponds to + a valid legacy role of the same name, `max_role` will be the name of that policy. + Otherwise, it will be null. + type: string + example: storage_admin + access_policies: + description: The access policies allowed for ID Tokens issued by this API client. + The bearer of an access token will be authorized to perform actions within the + intersection of these policies and those of the array user specified as the + JWT `sub` (subject) claim. + type: array + items: + $ref: ../../models/FA2.3/_fixed-reference-with-type.yaml + readOnly: true + issuer: + description: 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. + type: string + example: https://purestorage.idp.okta.com + public_key: + description: The API client's PEM formatted (Base64 encoded) RSA public key. + type: string + example: '-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 + eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O + nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q + sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 + 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 + SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd + FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----' + key_id: + description: 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. + type: string + example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 + enabled: + description: If `true`, the API client is permitted to exchange ID Tokens for + access tokens. API clients are disabled by default. + type: boolean + example: true + access_token_ttl_in_ms: + description: The requested TTL (Time To Live) length of time for the exchanged + access token, measured in milliseconds. + min: 1000 + max: 86400000 + type: integer + format: int64 + example: 15000 diff --git a/html/models/FA2.36/certificate-group.yaml b/html/models/FA2.36/certificate-group.yaml new file mode 100644 index 00000000..6295e8b1 --- /dev/null +++ b/html/models/FA2.36/certificate-group.yaml @@ -0,0 +1,2 @@ +allOf: +- $ref: ../../models/FA2.0/_built-in.yaml diff --git a/html/models/FA2.36/container-eradication-config.yaml b/html/models/FA2.36/container-eradication-config.yaml new file mode 100644 index 00000000..30bf7c40 --- /dev/null +++ b/html/models/FA2.36/container-eradication-config.yaml @@ -0,0 +1,13 @@ +type: object +description: The status of the eradication functionality +properties: + manual_eradication: + description: The manual eradication status of the container. If `all-enabled`, + the container and its contents can be eradicated. If `partially-disabled`, the + container cannot be eradicated because the container contains some non-empty + protection groups that are retention-locked. If `all-disabled`, the container + and its contents cannot be eradicated. Values include `all-disabled`, `all-enabled`, + and `partially-disabled`. + type: string + readOnly: true + example: all-enabled diff --git a/html/models/FA2.36/container-performance.yaml b/html/models/FA2.36/container-performance.yaml new file mode 100644 index 00000000..0c8274e7 --- /dev/null +++ b/html/models/FA2.36/container-performance.yaml @@ -0,0 +1,15 @@ +allOf: +- $ref: ../../models/FA2.4/_performance.yaml +- $ref: ../../models/FA2.0/_resource.yaml +- properties: + others_per_sec: + description: The number of other requests processed per second. + type: integer + format: int64 + minimum: 0 + usec_per_other_op: + description: The average time it takes the pod to process an I/O other request, + measured in microseconds. + type: integer + format: int64 + minimum: 0 diff --git a/html/models/FA2.36/directory-service-role-post.yaml b/html/models/FA2.36/directory-service-role-post.yaml new file mode 100644 index 00000000..b86860e5 --- /dev/null +++ b/html/models/FA2.36/directory-service-role-post.yaml @@ -0,0 +1,23 @@ +type: object +properties: + role: + description: This field has been deprecated. Predecessor to management access + policies. Can be set to the premade policy of the same name. Cannot be set with + management_access_policies. + allOf: + - $ref: ../../models/FA2.0/_reference-no-id.yaml + management_access_policies: + description: List of management access policies to associate with the group. + type: array + items: + $ref: ../../models/FA2.3/_reference-with-type.yaml + group: + description: Group name that contains users with the abilities granted by the + associated policies. + type: string + example: groupOfUsers + group_base: + description: Specifies where the configured group is located in the directory + tree. + type: string + example: OU=PureGroups,OU=SANManagers diff --git a/html/models/FA2.36/directory-service-role.yaml b/html/models/FA2.36/directory-service-role.yaml new file mode 100644 index 00000000..ae3c3c99 --- /dev/null +++ b/html/models/FA2.36/directory-service-role.yaml @@ -0,0 +1,25 @@ +allOf: +- $ref: ../../models/FA2.2/_fixed-name-resource-no-id.yaml +- type: object + properties: + role: + description: This field has been deprecated. Predecessor to management access + policies. + allOf: + - $ref: ../../models/FA2.0/_reference-no-id.yaml + management_access_policies: + description: List of management access policies associated with the group. + type: array + items: + $ref: ../../models/FA2.3/_fixed-reference-with-type.yaml + readOnly: true + group: + description: Group name that contains users with the abilities granted by the + associated policies. + type: string + example: groupOfUsers + group_base: + description: Specifies where the configured group is located in the directory + tree. + type: string + example: OU=PureGroups,OU=SANManagers diff --git a/html/models/FA2.36/fleet-key.yaml b/html/models/FA2.36/fleet-key.yaml new file mode 100644 index 00000000..1b8d57e5 --- /dev/null +++ b/html/models/FA2.36/fleet-key.yaml @@ -0,0 +1,18 @@ +type: object +readOnly: true +properties: + fleet_key: + description: Fleet key, used for fleet connections. After creation, listing will + only show ****. + type: string + example: CAUSJDljMGM3MGY3LWFhZDEtNDRkZC05ZDQ2LTZlOTA3YzY3Yzg1YxokOWMwYzcwZjctYWFkMS00NGRkLTlkND + created: + description: Creation time in milliseconds since UNIX epoch. + type: integer + format: int64 + example: 1706850977 + expires: + description: Expiration time in milliseconds since UNIX epoch. + type: integer + format: int64 + example: 1706854577 diff --git a/html/models/FA2.36/fleet-member-post.yaml b/html/models/FA2.36/fleet-member-post.yaml new file mode 100644 index 00000000..12079e41 --- /dev/null +++ b/html/models/FA2.36/fleet-member-post.yaml @@ -0,0 +1,25 @@ +type: object +properties: + members: + description: Details about the members being added to fleet. + type: array + items: + type: object + properties: + member: + type: object + properties: + id: + type: string + description: A globally unique, system-generated ID. The ID cannot be + modified. + name: + type: string + description: The resource name. + resource_type: + type: string + description: Type of the object (e.g. remote-arrays) + key: + description: Provide the `fleet key` generated from any array in the fleet. + required: true + type: string diff --git a/html/models/FA2.36/fleet-member.yaml b/html/models/FA2.36/fleet-member.yaml new file mode 100644 index 00000000..da7f4ebe --- /dev/null +++ b/html/models/FA2.36/fleet-member.yaml @@ -0,0 +1,18 @@ +type: object +properties: + member: + allOf: + - $ref: ../FA2.36/_fixed-reference-with-type-and-location.yaml + status: + type: string + description: 'Current fleet membership status Valid values are one of: `joining`, + `joined`, or `removing` A status of `joining` indicates that the member is attempting + to join the fleet. A status of `joined` indicates that the member has joined + the fleet. A status of `removing` indicates that the member is being removed + from the fleet.' + status_details: + type: string + description: Describes the error, if any. + example: cannot reach array + fleet: + $ref: ../FA2.36/_fixed-reference-with-type-and-location.yaml diff --git a/html/models/FA2.36/fleet.yaml b/html/models/FA2.36/fleet.yaml new file mode 100644 index 00000000..a415fe0a --- /dev/null +++ b/html/models/FA2.36/fleet.yaml @@ -0,0 +1,6 @@ +allOf: +- $ref: ../../models/FA2.0/_resource.yaml +- properties: + is_local: + type: boolean + description: If set to `true`, the current array is a member of the fleet. diff --git a/html/models/FA2.36/host-group.yaml b/html/models/FA2.36/host-group.yaml new file mode 100644 index 00000000..ead46dcd --- /dev/null +++ b/html/models/FA2.36/host-group.yaml @@ -0,0 +1,26 @@ +allOf: +- $ref: ../../models/FA2.26/host-group.yaml +- type: object + properties: + space: + description: Displays provisioned (virtual) size and physical storage consumption + information for the sum of all volumes connected to the specified host. + readOnly: true + allOf: + - $ref: ../../models/FA2.34/_space.yaml + destroyed: + description: Returns a value of `true` if the host group has been destroyed + with its container realm and is pending eradication. The `time_remaining` + value displays the amount of time left until the destroyed host group is permanently + eradicated. Before the `time_remaining` period has elapsed, the destroyed + host group will be recovered if its container realm is recovered. Once the + `time_remaining` period has elapsed, the host group is permanently eradicated + and can no longer be recovered. + type: boolean + readOnly: true + time_remaining: + description: The amount of time left until the destroyed host group is permanently + eradicated, measured in milliseconds. + type: integer + format: int64 + readOnly: true diff --git a/html/models/FA2.36/host.yaml b/html/models/FA2.36/host.yaml new file mode 100644 index 00000000..1d6e408f --- /dev/null +++ b/html/models/FA2.36/host.yaml @@ -0,0 +1,25 @@ +allOf: +- $ref: ../../models/FA2.26/host.yaml +- type: object + properties: + space: + description: Displays provisioned (virtual) size and physical storage consumption + information for the sum of all volumes connected to the specified host. + readOnly: true + allOf: + - $ref: ../../models/FA2.34/_space.yaml + destroyed: + description: Returns a value of `true` if the host has been destroyed with its + container realm and is pending eradication. The `time_remaining` value displays + the amount of time left until the destroyed host is permanently eradicated. + Before the `time_remaining` period has elapsed, the destroyed host will be + recovered if its container realm is recovered. Once the `time_remaining` period + has elapsed, the host is permanently eradicated and can no longer be recovered. + type: boolean + readOnly: true + time_remaining: + description: The amount of time left until the destroyed host is permanently + eradicated, measured in milliseconds. + type: integer + format: int64 + readOnly: true diff --git a/html/models/FA2.36/network-interface-performance.yaml b/html/models/FA2.36/network-interface-performance.yaml new file mode 100644 index 00000000..d2dd200d --- /dev/null +++ b/html/models/FA2.36/network-interface-performance.yaml @@ -0,0 +1,179 @@ +allOf: +- $ref: ../../models/FA2.0/_resource-no-id.yaml +- readOnly: true + properties: + interface_type: + description: The interface type. Valid values are `eth` and `fc`. + type: string + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + eth: + description: Ethernet network interface statistics. + type: object + properties: + other_errors_per_sec: + description: This field has been deprecated. Since Purity version 6.6.8, + this will always return `null`. The sum of unspecified reception and transmission + errors per second. + type: integer + format: int64 + minimum: 0 + received_bytes_per_sec: + description: Bytes received per second. + type: integer + format: int64 + minimum: 0 + received_crc_errors_per_sec: + description: Reception CRC errors per second. + type: integer + format: int64 + minimum: 0 + received_frame_errors_per_sec: + description: Received packet frame errors per second. + type: integer + format: int64 + minimum: 0 + received_packets_per_sec: + description: Packets received per second. + type: integer + format: int64 + minimum: 0 + total_errors_per_sec: + description: The sum of all reception and transmission errors per second. + type: integer + format: int64 + minimum: 0 + transmitted_bytes_per_sec: + description: Bytes transmitted per second. + type: integer + format: int64 + minimum: 0 + transmitted_carrier_errors_per_sec: + description: Transmission carrier errors per second. + type: integer + format: int64 + minimum: 0 + transmitted_dropped_errors_per_sec: + description: Transmitted packets dropped per second. + type: integer + format: int64 + minimum: 0 + transmitted_packets_per_sec: + description: Packets transmitted per second. + type: integer + format: int64 + minimum: 0 + flow_control_received_congestion_packets_per_sec: + description: Number of congestion control packets received per second. + type: integer + format: int64 + minimum: 0 + flow_control_received_discarded_packets_per_sec: + description: Number of received packets that were physically discarded by + the NIC per second due to errors or other reasons. + type: integer + format: int64 + minimum: 0 + flow_control_received_lossless_bytes_per_sec: + description: Bytes received per second with lossless flow control settings. + type: integer + format: int64 + minimum: 0 + flow_control_received_pause_frames_per_sec: + description: Received pause frames per second. + type: integer + format: int64 + minimum: 0 + flow_control_transmitted_congestion_packets_per_sec: + description: Number of congestion control packets transmitted per second. + type: integer + format: int64 + minimum: 0 + flow_control_transmitted_discarded_packets_per_sec: + description: Number of transmitted packets that were physically discarded + by the NIC per second due to errors or other reasons. + type: integer + format: int64 + minimum: 0 + flow_control_transmitted_lossless_bytes_per_sec: + description: Bytes transmitted per second with lossless flow control settings. + type: integer + format: int64 + minimum: 0 + flow_control_transmitted_pause_frames_per_sec: + description: Transmitted pause frames per second. + type: integer + format: int64 + minimum: 0 + rdma_received_req_cqe_errors_per_sec: + description: The number of times port detected RDMA CQEs with error per + second. + type: integer + format: int64 + minimum: 0 + rdma_received_sequence_errors_per_sec: + description: The number of received RDMA packet sequence errors per second. + type: integer + format: int64 + minimum: 0 + rdma_transmitted_local_ack_timeout_errors_per_sec: + description: The number of times RDMA ack timer expired for QPs per second. + type: integer + format: int64 + minimum: 0 + fc: + description: Fibre Channel port statistics. + type: object + properties: + received_bytes_per_sec: + description: Bytes received per second. + type: integer + format: int64 + minimum: 0 + received_crc_errors_per_sec: + description: Fibre Channel frame CRC errors per second. + type: integer + format: int64 + minimum: 0 + received_frames_per_sec: + description: Fibre Channel frames received per second. + type: integer + format: int64 + minimum: 0 + received_link_failures_per_sec: + description: Loss of connectivity errors per second. + type: integer + format: int64 + minimum: 0 + received_loss_of_signal_per_sec: + description: Loss of signal errors on Fibre Channel port per second. + type: integer + format: int64 + minimum: 0 + received_loss_of_sync_per_sec: + description: Loss of sync errors on Fibre Channel port per second. + type: integer + format: int64 + minimum: 0 + total_errors_per_sec: + description: The sum of all reception and transmission errors per second. + type: integer + format: int64 + minimum: 0 + transmitted_bytes_per_sec: + description: Bytes transmitted per second. + type: integer + format: int64 + minimum: 0 + transmitted_frames_per_sec: + description: Fibre Channel frames transmitted per second. + type: integer + format: int64 + minimum: 0 + transmitted_invalid_words_per_sec: + description: Bit errors in transmission word per second. + type: integer + format: int64 + minimum: 0 diff --git a/html/models/FA2.36/pod-member.yaml b/html/models/FA2.36/pod-member.yaml new file mode 100644 index 00000000..74a5f5ef --- /dev/null +++ b/html/models/FA2.36/pod-member.yaml @@ -0,0 +1,7 @@ +allOf: +- type: object + properties: + pod: + $ref: ../../models/FA2.3/_reference-with-type.yaml + member: + $ref: ../../models/FA2.3/_reference-with-type.yaml diff --git a/html/models/FA2.36/pod.yaml b/html/models/FA2.36/pod.yaml new file mode 100644 index 00000000..9d0bd0b5 --- /dev/null +++ b/html/models/FA2.36/pod.yaml @@ -0,0 +1,24 @@ +allOf: +- $ref: ../../models/FA2.34/pod.yaml +- type: object + properties: + eradication_config: + readOnly: true + $ref: ../../models/FA2.36/container-eradication-config.yaml + members: + description: A list of arrays or realms over which the pod is stretched. If + there are two or more members in the stretched pod, all data in the pod is + synchronously replicated between all of the members within the pod. + type: array + items: + $ref: ../../models/FA2.3/_reference-with-type.yaml + minItems: 1 + readOnly: true + arrays: + description: A list of arrays over which the pod is stretched. If there are + two or more arrays in the stretched pod, all data in the pod is synchronously + replicated between all of the arrays within the pod. + type: array + items: + $ref: ../../models/FA2.36/_pod_array_status.yaml + minItems: 1 diff --git a/html/models/FA2.36/policy-assignment-post-policy.yaml b/html/models/FA2.36/policy-assignment-post-policy.yaml new file mode 100644 index 00000000..322c48fa --- /dev/null +++ b/html/models/FA2.36/policy-assignment-post-policy.yaml @@ -0,0 +1,7 @@ +type: object +properties: + policy: + allOf: + - description: Reference to the policy to apply to the resource. + - required: true + - $ref: ../../models/FA2.0/_reference.yaml diff --git a/html/models/FA2.36/policy-assignment-post.yaml b/html/models/FA2.36/policy-assignment-post.yaml new file mode 100644 index 00000000..b7ca827e --- /dev/null +++ b/html/models/FA2.36/policy-assignment-post.yaml @@ -0,0 +1,8 @@ +type: object +properties: + policies: + description: A list of policies to apply to the resource. One of `id` or `name` + is required in each `policy`. + type: array + items: + $ref: ../../models/FA2.36/policy-assignment-post-policy.yaml diff --git a/html/models/FA2.36/policy-management-access-effective.yaml b/html/models/FA2.36/policy-management-access-effective.yaml new file mode 100644 index 00000000..52c836bb --- /dev/null +++ b/html/models/FA2.36/policy-management-access-effective.yaml @@ -0,0 +1,10 @@ +type: object +properties: + details: + description: Additional details about policy resolution. + type: string + rules: + description: List the rules that defines the scoped roles. + type: array + items: + $ref: ../../models/FA2.36/_policyrulemanagementaccess-rules.yaml diff --git a/html/models/FA2.36/policy-management-access-patch.yaml b/html/models/FA2.36/policy-management-access-patch.yaml new file mode 100644 index 00000000..34c0dda9 --- /dev/null +++ b/html/models/FA2.36/policy-management-access-patch.yaml @@ -0,0 +1,18 @@ +allOf: +- $ref: ../../models/FA2.0/_new-name.yaml +- properties: + aggregation_strategy: + description: When this is set to `least-common-permissions`, any users to whom + this policy applies can receive no access rights exceeding those defined in + this policy's capability and resource. When this is set to `all-permissions`, + any users to whom this policy applies are capable of receiving additional + access rights from other policies that apply to them. + type: string + enabled: + description: Sets whether the policy is enabled and grants the permissions specified. + type: boolean + rules: + description: List the rules that defines the scoped roles. + type: array + items: + $ref: ../../models/FA2.36/_policyrulemanagementaccess-rules.yaml diff --git a/html/models/FA2.36/policy-management-access-post.yaml b/html/models/FA2.36/policy-management-access-post.yaml new file mode 100644 index 00000000..3d949a58 --- /dev/null +++ b/html/models/FA2.36/policy-management-access-post.yaml @@ -0,0 +1,18 @@ +allOf: +- $ref: ../../models/FA2.3/policy-post.yaml +- type: object + properties: + aggregation_strategy: + description: When set to `least-common-permissions`, any users to whom this + policy applies can receive no access rights exceeding those defined in this + policy's capability and resource. When this is set to `all-permissions`, any + users to whom this policy applies are capable of receiving additional access + rights from other policies that apply to them. If not specified, defaults + to `all-permissions`. + type: string + required: true + rules: + description: List the rules that defines the scoped roles. + type: array + items: + $ref: ../../models/FA2.36/_policyrulemanagementaccess-rules.yaml diff --git a/html/models/FA2.36/policy-management-access.yaml b/html/models/FA2.36/policy-management-access.yaml new file mode 100644 index 00000000..f6d01b20 --- /dev/null +++ b/html/models/FA2.36/policy-management-access.yaml @@ -0,0 +1,23 @@ +allOf: +- $ref: ../../models/FA2.0/_resource.yaml +- properties: + aggregation_strategy: + description: When set to `least-common-permissions`, any users to whom this + policy applies can receive no access rights exceeding those defined in this + policy's rules. When this is set to `all-permissions`, any users to whom this + policy applies are capable of receiving additional access rights from other + policies that apply to them. + type: string + enabled: + description: Returns a value of `true` if the policy is enabled. + type: boolean + policy_type: + description: The type of policy. Valid values include `management-access`, `autodir`, + `nfs`, `smb`, `snapshot`, and `quota`. + readOnly: true + type: string + rules: + description: List the rules that defines the scoped roles. + type: array + items: + $ref: ../../models/FA2.36/_policyrulemanagementaccess-rules.yaml diff --git a/html/models/FA2.36/policy-member-clean.yaml b/html/models/FA2.36/policy-member-clean.yaml new file mode 100644 index 00000000..cee929e4 --- /dev/null +++ b/html/models/FA2.36/policy-member-clean.yaml @@ -0,0 +1,12 @@ +type: object +properties: + member: + description: Reference to the resource that the policy is applied to. + readOnly: true + allOf: + - $ref: ../../models/FA2.3/_fixed-reference-with-type.yaml + policy: + description: Reference to the policy. + readOnly: true + allOf: + - $ref: ../../models/FA2.3/_fixed-reference-with-type.yaml diff --git a/html/models/FA2.36/realm-patch.yaml b/html/models/FA2.36/realm-patch.yaml new file mode 100644 index 00000000..a0075d8e --- /dev/null +++ b/html/models/FA2.36/realm-patch.yaml @@ -0,0 +1,23 @@ +allOf: +- $ref: ../../models/FA2.0/_new-name.yaml +- type: object + properties: + destroyed: + description: If set to `true`, the realm will be destroyed and pending eradication. + The `time_remaining` value displays the amount of time left until the destroyed + realm is permanently eradicated. A realm can only be destroyed if it is empty + or destroy_contents is set to true. Before the `time_remaining` period has + elapsed, the destroyed realm can be recovered by setting `destroyed=false`. + Once the `time_remaining` period has elapsed, the realm is permanently eradicated + and can no longer be recovered. + type: boolean + quota_limit: + type: integer + format: int64 + description: The logical quota limit of the realm, measured in bytes. + minimum: 1048576 + maximum: 4503599627370496 + qos: + description: Sets QoS limits. + allOf: + - $ref: ../../models/FA2.36/_container-qos.yaml diff --git a/html/models/FA2.36/realm-post.yaml b/html/models/FA2.36/realm-post.yaml new file mode 100644 index 00000000..654daaea --- /dev/null +++ b/html/models/FA2.36/realm-post.yaml @@ -0,0 +1,14 @@ +allOf: +- type: object + properties: + quota_limit: + type: integer + format: int64 + description: The logical quota limit of the realm, measured in bytes. Must be + a multiple of 512. + minimum: 1048576 + maximum: 4503599627370496 + qos: + description: Sets QoS limits. + allOf: + - $ref: ../../models/FA2.36/_container-qos.yaml diff --git a/html/models/FA2.36/realm.yaml b/html/models/FA2.36/realm.yaml new file mode 100644 index 00000000..967ecf3a --- /dev/null +++ b/html/models/FA2.36/realm.yaml @@ -0,0 +1,43 @@ +allOf: +- $ref: ../../models/FA2.0/_resource.yaml +- description: A realm is an administrative domain, a data container, and a namespace + for pods, hosts, and host groups. + type: object + properties: + created: + type: integer + description: Creation timestamp of the realm. + readOnly: true + format: int64 + destroyed: + type: boolean + description: Returns a value of `true` if the realm has been destroyed and is + pending eradication. The realm cannot be modified while it is in the destroyed + state. The `time_remaining` value displays the amount of time left until the + destroyed realm is permanently eradicated. Once eradication has begun, the + realm can no longer be recovered. Before the `time_remaining` period has elapsed, + the destroyed realm can be recovered through the PATCH method + space: + description: Displays provisioned size and physical storage consumption information + for the realm. + allOf: + - $ref: ../../models/FA2.36/_space-no-deprecated-physical-or-effective.yaml + time_remaining: + type: integer + format: int64 + description: Time in milliseconds before the realm is eradicated. `null` if + not destroyed. + readOnly: true + eradication_config: + readOnly: true + $ref: ../../models/FA2.36/container-eradication-config.yaml + quota_limit: + type: integer + format: int64 + description: The logical quota limit of the realm, measured in bytes. + readOnly: true + maximum: 4503599627370496 + qos: + description: Displays QoS limit information. + allOf: + - $ref: ../../models/FA2.36/_container-qos.yaml diff --git a/html/models/FA2.36/remote-array.yaml b/html/models/FA2.36/remote-array.yaml new file mode 100644 index 00000000..6397200f --- /dev/null +++ b/html/models/FA2.36/remote-array.yaml @@ -0,0 +1,31 @@ +type: object +allOf: +- $ref: ../../models/FA2.0/_resource.yaml +- type: object + properties: + fleet: + allOf: + - $ref: ../../models/FA2.36/fleet.yaml + - type: object + properties: + is_local: + type: boolean + description: If set to `true`, the current array is a member of the fleet. + example: false + os: + type: string + description: Specifies the operating system. Valid values are `Purity`, `Purity//FA`, + and `Purity//FB`. + example: Purity//FA + version: + type: string + description: Specifies the operating system version. + example: 6.8.0 + model: + type: string + description: Specifies the array model. + example: FA//X + is_local: + type: boolean + description: If set to `true`, this array is the current array. + example: false diff --git a/html/models/FA2.36/resource-realm-space.yaml b/html/models/FA2.36/resource-realm-space.yaml new file mode 100644 index 00000000..dcfd90aa --- /dev/null +++ b/html/models/FA2.36/resource-realm-space.yaml @@ -0,0 +1,13 @@ +allOf: +- $ref: ../../models/FA2.0/_built-in.yaml +- readOnly: true + properties: + space: + description: Displays size and space consumption information. + allOf: + - $ref: ../../models/FA2.36/_space-no-deprecated-physical-or-effective.yaml + time: + type: integer + format: int64 + description: The timestamp of when the data was taken, measured in milliseconds + since the UNIX epoch. diff --git a/html/models/FA2.36/support-diagnostics-details.yaml b/html/models/FA2.36/support-diagnostics-details.yaml new file mode 100644 index 00000000..06f1df00 --- /dev/null +++ b/html/models/FA2.36/support-diagnostics-details.yaml @@ -0,0 +1,17 @@ +allOf: +- type: object + description: Details of diagnostics tests tasks + properties: + test_name: + description: Name of the test that was performed. + type: string + severity: + type: string + description: Severity level of the test. Valid values are `info`, `warning`, + and `critical`. + result_details: + description: Additional details related to the test. This field also provides + remediation information. + type: string + readOnly: true + example: enabled diff --git a/html/models/FA2.36/support-diagnostics-settings.yaml b/html/models/FA2.36/support-diagnostics-settings.yaml new file mode 100644 index 00000000..5eead640 --- /dev/null +++ b/html/models/FA2.36/support-diagnostics-settings.yaml @@ -0,0 +1,14 @@ +allOf: +- type: object + description: Diagnostics tools + properties: + version: + description: Version of the diagnostics tool. + type: string + readOnly: true + example: 1.0.0 + last_updated: + description: Date the diagnostics tool was last updated. + type: integer + format: int64 + example: 1672531200000 diff --git a/html/models/FA2.37/_upgrade_parameters.yaml b/html/models/FA2.37/_upgrade_parameters.yaml new file mode 100644 index 00000000..c764d680 --- /dev/null +++ b/html/models/FA2.37/_upgrade_parameters.yaml @@ -0,0 +1,9 @@ +type: object +properties: + name: + description: The name of the upgrade parameter to be sent to the upgrade process. + type: string + value: + description: The value of the upgrade parameter to be sent to the upgrade process. + type: string + maxLength: 1024 diff --git a/html/models/FA2.37/directory-service.yaml b/html/models/FA2.37/directory-service.yaml new file mode 100644 index 00000000..19b80d91 --- /dev/null +++ b/html/models/FA2.37/directory-service.yaml @@ -0,0 +1,52 @@ +allOf: +- $ref: ../../models/FA2.0/_built-in-resource-no-id.yaml +- description: Configuration information for the directory service. + type: object + properties: + base_dn: + description: Base of the Distinguished Name (DN) of the directory service groups. + type: string + example: DC=mycompany,DC=com + bind_password: + description: Masked password used to query the directory. + type: string + example: '****' + bind_user: + description: Username used to query the directory. + type: string + example: CN=John,OU=Users,DC=example,DC=com + ca_certificate: + description: The certificate of the Certificate Authority (CA) that signed the + certificates of the directory servers, which is used to validate the authenticity + of the configured servers. + type: string + check_peer: + description: Whether or not server authenticity is enforced when a certificate + is provided. + type: boolean + example: false + enabled: + description: Whether or not the directory service is enabled. + type: boolean + example: true + services: + description: The services the directory service configuration is used for. + type: array + items: + description: Valid values are `data` and `management`. + type: string + example: data + example: + - data + - management + readOnly: true + uris: + description: List of URIs for the configured directory servers. + type: array + maxLength: 30 + items: + type: string + pattern: ^(ldap|ldaps) + example: ldaps://ad1.mycompany.com + management: + $ref: ../../models/FA2.32/_directory-service-management.yaml diff --git a/html/models/FA2.37/software-installation-post.yaml b/html/models/FA2.37/software-installation-post.yaml new file mode 100644 index 00000000..b8780c9c --- /dev/null +++ b/html/models/FA2.37/software-installation-post.yaml @@ -0,0 +1,15 @@ +allOf: +- $ref: ../../models/FA2.9/software-installation-post.yaml +- properties: + upgrade_parameters: + description: A list of parameters to be sent to the upgrade process. These parameters + can be used to change the behavior of the upgrade process in specific ways + such as enabling or disabling features in the target version or changing the + attributes of the appliance at upgrade time. When there is a need or option + to set an upgrade parameter, Pure Storage will provide documentation for the + specific parameter. If you have been provided documentation related to a specific + upgrade parameter, follow the instructions in the documentation. Otherwise, + do not set any upgrade parameters. + type: array + items: + $ref: _upgrade_parameters.yaml diff --git a/html/models/FA2.37/software-installation.yaml b/html/models/FA2.37/software-installation.yaml new file mode 100644 index 00000000..030098df --- /dev/null +++ b/html/models/FA2.37/software-installation.yaml @@ -0,0 +1,15 @@ +allOf: +- $ref: ../../models/FA2.9/software-installation.yaml +- properties: + upgrade_parameters: + description: A list of parameters to be sent to the upgrade process. These parameters + can be used to change the behavior of the upgrade process in specific ways + such as enabling or disabling features in the target version or changing the + attributes of the appliance at upgrade time. When there is a need or option + to set an upgrade parameter, Pure Storage will provide documentation for the + specific parameter. If you have been provided documentation related to a specific + upgrade parameter, follow the instructions in the documentation. Otherwise, + do not set any upgrade parameters. + type: array + items: + $ref: _upgrade_parameters.yaml diff --git a/html/models/FA2.37/target-protection-group.yaml b/html/models/FA2.37/target-protection-group.yaml new file mode 100644 index 00000000..8fa5fa61 --- /dev/null +++ b/html/models/FA2.37/target-protection-group.yaml @@ -0,0 +1,24 @@ +allOf: +- type: object + properties: + group: + $ref: ../../models/FA2.0/_reference.yaml + member: + $ref: ../../models/FA2.3/_reference-with-type.yaml + allowed: + type: boolean + description: If set to `true`, the target array or pod allows the source array + to replicate protection group data to the target. If set to `false`, the target + array or pod does not allow the source array to replicate protection group + data to the target. + example: true + status: + type: string + description: The replication status of the target. Valid values are `replicating`, + `suspended`, and `disallowed`. If `allowed` is `true` and protection group + data is replicating to the target, `status` will display `replicating`. If + `allowed` is `true`, but replication is suspended due to the target being + demoted, linked, stretched, etc., `status` will display `suspended`. Replication + will be automatically resumed if the target becomes promoted or local only + again. If `allowed` is `false`, `status` will display `disallowed`. + example: suspended diff --git a/html/models/FB2.15/_space.yaml b/html/models/FB2.15/_space.yaml new file mode 100644 index 00000000..3fabf2c6 --- /dev/null +++ b/html/models/FB2.15/_space.yaml @@ -0,0 +1,9 @@ +allOf: +- $ref: ../../models/FB2.11/_space.yaml +- properties: + shared: + type: integer + readOnly: true + format: int64 + description: The space contributed by data that is not unique to a managed directory, + or snapshot, measured in bytes. diff --git a/html/models/FB2.15/bucket.yaml b/html/models/FB2.15/bucket.yaml new file mode 100644 index 00000000..1f8f6636 --- /dev/null +++ b/html/models/FB2.15/bucket.yaml @@ -0,0 +1,6 @@ +allOf: +- $ref: ../../models/FB2.14/bucket.yaml +- properties: + space: + allOf: + - $ref: ../../models/FB2.15/_space.yaml diff --git a/html/models/FB2.15/object-store-account.yaml b/html/models/FB2.15/object-store-account.yaml new file mode 100644 index 00000000..70e50b76 --- /dev/null +++ b/html/models/FB2.15/object-store-account.yaml @@ -0,0 +1,8 @@ +allOf: +- $ref: ../../models/FB2.12/object-store-account.yaml +- properties: + space: + description: The space specification of the object store account. + readOnly: true + allOf: + - $ref: ../../models/FB2.15/_space.yaml diff --git a/html/paths/FA2.35/directories-policies-audit-file.path.yaml b/html/paths/FA2.35/directories-policies-audit-file.path.yaml new file mode 100644 index 00000000..33a18298 --- /dev/null +++ b/html/paths/FA2.35/directories-policies-audit-file.path.yaml @@ -0,0 +1,64 @@ +get: + summary: List audit policies attached to a directory + description: Displays a list of audit policies that are attached to directories. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/policy_ids.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.21/policy-member-get-response.yaml + tags: + - Directories +post: + summary: Create a membership between a directory and one or more audit policies + description: Creates a membership between a directory and one or more audit policies. + Either the `member_ids` or `member_names` parameter is required, but they cannot + be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - name: policies + in: body + required: true + schema: + $ref: ../../models/FA2.3/directory-policy-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.21/policy-member-response.yaml + tags: + - Directories +delete: + summary: Delete a membership between a directory and one or more audit policies + description: Deletes a membership between a directory and one or more audit policies. + Either the `policy_ids` or `policy_names` parameter is required, but they cannot + be set together. Either the `member_ids` or `member_names` parameter is required, + but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/policy_ids.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + responses: + 200: + description: OK + tags: + - Directories diff --git a/html/paths/FA2.35/log-targets-file.path.yaml b/html/paths/FA2.35/log-targets-file.path.yaml new file mode 100644 index 00000000..d76f094f --- /dev/null +++ b/html/paths/FA2.35/log-targets-file.path.yaml @@ -0,0 +1,71 @@ +get: + summary: List file log targets + description: Displays a list of configured file log targets. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/log-target-file-get-response.yaml + tags: + - Log Targets +post: + summary: Create a file log target + description: Creates a new file log target. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: log-target-file + in: body + required: true + schema: + $ref: ../../models/FA2.35/log-target-file.yaml + responses: + 200: + description: Displays the newly configured file log target. + schema: + $ref: ../../responses/FA2.35/log-target-file-response.yaml + tags: + - Log Targets +delete: + summary: Delete a file log target + description: Deletes a configured file log target. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - Log Targets +patch: + summary: Modify a file log target + description: Modifies the managed directory and retention of a configured file log + target. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: log-target-file + in: body + required: true + schema: + $ref: ../../models/FA2.35/log-target-file.yaml + responses: + 200: + description: Displays the newly updated file log target. + schema: + $ref: ../../responses/FA2.35/log-target-file-response.yaml + tags: + - Log Targets diff --git a/html/paths/FA2.35/log-targets-syslog-settings.path.yaml b/html/paths/FA2.35/log-targets-syslog-settings.path.yaml new file mode 100644 index 00000000..52eb5736 --- /dev/null +++ b/html/paths/FA2.35/log-targets-syslog-settings.path.yaml @@ -0,0 +1,38 @@ +get: + summary: List syslog settings + description: Displays syslog settings. Values include `continuation_token`, `items`, + `more_items_remaining`, and `total_item_count`. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.9/syslog-server-settings-get-response.yaml + tags: + - Log Targets +patch: + summary: Modify syslog settings + description: Modifies syslog settings. Values include `continuation_token`, `items`, + `more_items_remaining`, and `total_item_count`. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - name: syslog-server-settings + in: body + required: true + schema: + $ref: ../../models/FA2.9/syslog-server-settings.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.9/syslog-server-settings-response.yaml + tags: + - Log Targets diff --git a/html/paths/FA2.35/log-targets-syslog-test.path.yaml b/html/paths/FA2.35/log-targets-syslog-test.path.yaml new file mode 100644 index 00000000..7be08c49 --- /dev/null +++ b/html/paths/FA2.35/log-targets-syslog-test.path.yaml @@ -0,0 +1,19 @@ +get: + summary: List syslog server test results + description: Displays syslog server test results, which indicate whether the syslog + is working and configured correctly. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.4/test-result-with-resource-get-response.yaml + tags: + - Log Targets diff --git a/html/paths/FA2.35/log-targets-syslog.path.yaml b/html/paths/FA2.35/log-targets-syslog.path.yaml new file mode 100644 index 00000000..8735d74c --- /dev/null +++ b/html/paths/FA2.35/log-targets-syslog.path.yaml @@ -0,0 +1,70 @@ +get: + summary: List syslog servers + description: Displays a list of configured syslog servers. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/syslog-server-get-response.yaml + tags: + - Log Targets +post: + summary: Create syslog server + description: Creates a new syslog server. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: syslog-server + in: body + required: true + schema: + $ref: ../../models/FA2.35/syslog-server.yaml + responses: + 200: + description: Displays the newly configured syslog server. + schema: + $ref: ../../responses/FA2.35/syslog-server-response.yaml + tags: + - Log Targets +delete: + summary: Delete syslog server + description: Deletes a configured syslog server and stop forwarding syslog messages. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - Log Targets +patch: + summary: Modify syslog server + description: Modifies the URI and services of a configured syslog server. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: syslog-server + in: body + required: true + schema: + $ref: ../../models/FA2.35/syslog-server.yaml + responses: + 200: + description: Displays the newly updated syslog server. + schema: + $ref: ../../responses/FA2.35/syslog-server-response.yaml + tags: + - Log Targets diff --git a/html/paths/FA2.35/log-targets.path.yaml b/html/paths/FA2.35/log-targets.path.yaml new file mode 100644 index 00000000..3956bb3f --- /dev/null +++ b/html/paths/FA2.35/log-targets.path.yaml @@ -0,0 +1,20 @@ +get: + summary: List log targets + description: Displays a list of configured log targets. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/log-targets-get-response.yaml + tags: + - Log Targets diff --git a/html/paths/FA2.35/policies-audit-file-members.path.yaml b/html/paths/FA2.35/policies-audit-file-members.path.yaml new file mode 100644 index 00000000..1a126fed --- /dev/null +++ b/html/paths/FA2.35/policies-audit-file-members.path.yaml @@ -0,0 +1,66 @@ +get: + summary: List audit policy members + description: Displays a list of audit policy members. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/member_types.query.yaml + - $ref: ../../queries/FA2.3/policy_ids.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.21/policy-member-get-response.yaml + tags: + - Policies +post: + summary: Create a membership between a managed directory and a audit policy + description: Creates a membership between one or more managed directories and an + audit policy. Either the `policy_ids` or `policy_names` parameter is required, + but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.3/policy_ids.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + - name: members + in: body + required: true + schema: + $ref: ../../models/FA2.3/policy-member-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.21/policy-member-response.yaml + tags: + - Policies +delete: + summary: Delete membership between audit policies and managed directories + description: Deletes a membership between one or more audit policies and managed + directories. Either the `policy_ids` or `policy_names` parameter is required, + but they cannot be set together. Either the `member_ids` or `member_names` parameter + is required, but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/member_types.query.yaml + - $ref: ../../queries/FA2.3/policy_ids.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + responses: + 200: + description: OK + tags: + - Policies diff --git a/html/paths/FA2.35/policies-audit-file.path.yaml b/html/paths/FA2.35/policies-audit-file.path.yaml new file mode 100644 index 00000000..548447c6 --- /dev/null +++ b/html/paths/FA2.35/policies-audit-file.path.yaml @@ -0,0 +1,81 @@ +get: + summary: List audit policies + description: Displays a list of audit policies. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/policy-audit-file-get-response.yaml + tags: + - Policies +post: + summary: Create audit policies + description: Creates one or more audit policies. To copy a policy, either the `source_names` + or `source_ids` parameter is required, but they cannot be set together. To create + a policy from scratch, the policy body is required. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/source_ids.query.yaml + - $ref: ../../queries/FA2.0/source_names.query.yaml + - name: policy + in: body + schema: + $ref: ../../models/FA2.35/policy-audit-file-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/policy-audit-file-response.yaml + tags: + - Policies +delete: + summary: Delete audit policies + description: Deletes one or more audit policies. Either the `ids` or `names` parameter + is required, but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - Policies +patch: + summary: Modify audit policies + description: Modifies one or more audit policies. To enable a policy, set `enabled=true`. + To disable a policy, set `enabled=false`. To rename a policy, set `name` to the + new name. Either the `ids` or `names` parameter is required, but they cannot be + set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: policy + in: body + required: true + schema: + $ref: ../../models/FA2.35/policy-audit-file-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/policy-audit-file-response.yaml + tags: + - Policies diff --git a/html/paths/FA2.35/support.path.yaml b/html/paths/FA2.35/support.path.yaml new file mode 100644 index 00000000..942b1cfb --- /dev/null +++ b/html/paths/FA2.35/support.path.yaml @@ -0,0 +1,38 @@ +get: + summary: List connection paths + description: Displays connection paths between the current array and each connected + array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/support-get-response.yaml + tags: + - Support +patch: + summary: Create connection path + description: Creates a connection path from the array to another array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - name: support + in: body + required: true + schema: + $ref: ../../models/FA2.35/support-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/support-response.yaml + tags: + - Support diff --git a/html/paths/FA2.35/syslog-servers.path.yaml b/html/paths/FA2.35/syslog-servers.path.yaml new file mode 100644 index 00000000..7be3d00d --- /dev/null +++ b/html/paths/FA2.35/syslog-servers.path.yaml @@ -0,0 +1,70 @@ +get: + summary: List syslog servers + description: Displays a list of configured syslog servers. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/syslog-server-get-response.yaml + tags: + - Syslog +post: + summary: Create syslog server + description: Creates a new syslog server. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: syslog-server + in: body + required: true + schema: + $ref: ../../models/FA2.35/syslog-server.yaml + responses: + 200: + description: Displays the newly configured syslog server. + schema: + $ref: ../../responses/FA2.35/syslog-server-response.yaml + tags: + - Syslog +delete: + summary: Delete syslog server + description: Deletes a configured syslog server and stops forwarding syslog messages. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - Syslog +patch: + summary: Modify syslog server + description: Modifies the URI and services of a configured syslog server. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: syslog-server + in: body + required: true + schema: + $ref: ../../models/FA2.35/syslog-server.yaml + responses: + 200: + description: Displays the newly updated syslog server. + schema: + $ref: ../../responses/FA2.35/syslog-server-response.yaml + tags: + - Syslog diff --git a/html/paths/FA2.35/virtual-machine-volume-snapshots.path.yaml b/html/paths/FA2.35/virtual-machine-volume-snapshots.path.yaml new file mode 100644 index 00000000..845cea6d --- /dev/null +++ b/html/paths/FA2.35/virtual-machine-volume-snapshots.path.yaml @@ -0,0 +1,35 @@ +get: + summary: List Virtual Machine Volume Snapshots + description: Displays a list of virtual machine volume snapshots, including those + pending eradication. If `vm_type` is `vvol`, the `recover_context` in the response + will represent a protection group snapshot containing the virtual machine volume. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + - name: vm_type + in: query + description: The type of virtual machine. The only valid value is `vvol`. + type: string + - name: vm_ids + in: query + description: Performs the operation on the unique virtual machine IDs specified. + Enter multiple resource IDs in a comma-separated format. + type: array + required: true + collectionFormat: csv + items: + type: string + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.35/virtual-machine-volume-snapshot-response.yaml + tags: + - Virtual Machines diff --git a/html/paths/FA2.36/admin-policies-access.path.yaml b/html/paths/FA2.36/admin-policies-access.path.yaml new file mode 100644 index 00000000..ac000c9d --- /dev/null +++ b/html/paths/FA2.36/admin-policies-access.path.yaml @@ -0,0 +1,66 @@ +get: + summary: List management access policies attached to administrators + description: Displays a list of management access policies that are attached to + administrators. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/policy_ids.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/policy-member-clean-get-response.yaml + tags: + - Administrators +post: + summary: Create a membership between an administrator with one or more management + access policies. + description: Creates a membership between an administrator with one or more management + access policies. The `member_ids` or `member_names` parameter is required, but + they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - name: policies + in: body + required: true + schema: + $ref: ../../models/FA2.36/policy-assignment-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/policy-member-clean-response.yaml + tags: + - Administrators +delete: + summary: Delete a membership between an administrator and one or more management + access policies + description: Deletes a membership between an administrator with one or more management + access policies. The`policy_ids` or `policy_names` is required, but they cannot + be set together. The `member_ids` or `member_names` is required, but they cannot + be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/policy_ids.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + responses: + 200: + description: OK + tags: + - Administrators diff --git a/html/paths/FA2.36/admins-cache.path.yaml b/html/paths/FA2.36/admins-cache.path.yaml new file mode 100644 index 00000000..d5eff48a --- /dev/null +++ b/html/paths/FA2.36/admins-cache.path.yaml @@ -0,0 +1,47 @@ +get: + summary: List administrator cache entries + description: Displays entries in the administrator cache. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/admin-cache-get-response.yaml + tags: + - Administrators +delete: + summary: Delete cache entries + description: Deletes all entries from the administrator cache. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.2/remove_all_entries.query.yaml + responses: + 200: + description: OK + tags: + - Administrators +put: + summary: Update or refresh entries in the administrator cache + description: Updates entries in the cache for administrators who currently do not + have a cache entry, otherwise refreshes the existing entry. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/admin-cache-response.yaml + tags: + - Administrators diff --git a/html/paths/FA2.36/admins.path.yaml b/html/paths/FA2.36/admins.path.yaml new file mode 100644 index 00000000..ac0028fd --- /dev/null +++ b/html/paths/FA2.36/admins.path.yaml @@ -0,0 +1,72 @@ +get: + summary: List administrators + description: Displays a list of administrators. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.2/expose_api_token.query.yaml + - $ref: ../../queries/FA2.32/expose_public_key.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/admin-get-response.yaml + tags: + - Administrators +post: + summary: Create an administrator + description: Creates an administrator. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: admin + in: body + required: true + schema: + $ref: ../../models/FA2.36/admin-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/admin-response.yaml + tags: + - Administrators +delete: + summary: Delete an administrator + description: Deletes the specified administrator. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - Administrators +patch: + summary: Modify an administrator + description: Modifies properties for the specified administrator. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: admin + in: body + required: true + schema: + $ref: ../../models/FA2.36/admin-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/admin-response.yaml + tags: + - Administrators diff --git a/html/paths/FA2.36/api-clients.path.yaml b/html/paths/FA2.36/api-clients.path.yaml new file mode 100644 index 00000000..3a0f05a3 --- /dev/null +++ b/html/paths/FA2.36/api-clients.path.yaml @@ -0,0 +1,77 @@ +get: + summary: List API clients + description: Displays a list of API clients. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/api-client-get-response.yaml + tags: + - API Clients +post: + summary: Create an API client + description: Creates an API client. Newly created API clients are disabled by default. + Enable an API client through the `PATCH` method. The `names`, `issuer`, and `public_key` + parameters are required. The `access_policies` or `max_role` parameter is required, + but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: API clients + in: body + required: true + schema: + $ref: ../../models/FA2.36/api-client-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/api-client-response.yaml + tags: + - API Clients +patch: + summary: Manage an API client + description: Enables or disables an API client. The `ids` or `names` parameter is + required, but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: API clients + in: body + required: true + schema: + $ref: ../../models/FA2.1/api-client-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/api-client-response.yaml + tags: + - API Clients +delete: + summary: Delete an API client + description: Deletes an API client. The `ids` or `names` parameter is required, + but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - API Clients diff --git a/html/paths/FA2.36/certificate-groups-certificates.path.yaml b/html/paths/FA2.36/certificate-groups-certificates.path.yaml new file mode 100644 index 00000000..133ebd7e --- /dev/null +++ b/html/paths/FA2.36/certificate-groups-certificates.path.yaml @@ -0,0 +1,54 @@ +get: + summary: List certificate-groups/certificates + description: Displays membership associations between groups and certificates on + the array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.36/certificate_group_ids.query.yaml + - $ref: ../../queries/FA2.36/certificate_group_names.query.yaml + - $ref: ../../queries/FA2.26/certificate_names.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/certificate-group-certificate-get-response.yaml + tags: + - Certificate Groups +post: + summary: Create certificate-groups/certificates + description: Creates one or more certificates to one or more certificate groups + on the array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/certificate_group_ids.query.yaml + - $ref: ../../queries/FA2.36/certificate_group_names.query.yaml + - $ref: ../../queries/FA2.26/certificate_names.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/certificate-group-certificate-response.yaml + tags: + - Certificate Groups +delete: + summary: Delete certificate-groups/certificates + description: Deletes one or more certificate groups. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/certificate_group_ids.query.yaml + - $ref: ../../queries/FA2.36/certificate_group_names.query.yaml + - $ref: ../../queries/FA2.26/certificate_names.query.yaml + responses: + 200: + description: OK + tags: + - Certificate Groups diff --git a/html/paths/FA2.36/certificate-groups.path.yaml b/html/paths/FA2.36/certificate-groups.path.yaml new file mode 100644 index 00000000..8a92a82a --- /dev/null +++ b/html/paths/FA2.36/certificate-groups.path.yaml @@ -0,0 +1,48 @@ +get: + summary: List certificate-groups + description: Display all array certificate groups. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/certificate-group-get-response.yaml + tags: + - Certificate Groups +post: + summary: Create certificate-groups + description: Creates one or more certificate groups on the array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/certificate-group-response.yaml + tags: + - Certificate Groups +delete: + summary: Delete certificate-groups + description: Deletes one or more certificate groups from the array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - Certificate Groups diff --git a/html/paths/FA2.36/certificates-certificate-groups.path.yaml b/html/paths/FA2.36/certificates-certificate-groups.path.yaml new file mode 100644 index 00000000..957c9711 --- /dev/null +++ b/html/paths/FA2.36/certificates-certificate-groups.path.yaml @@ -0,0 +1,52 @@ +get: + summary: List certificates/certificate-groups + description: Displays membership associations between groups and certificates. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.36/certificate_group_ids.query.yaml + - $ref: ../../queries/FA2.36/certificate_group_names.query.yaml + - $ref: ../../queries/FA2.26/certificate_names.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/certificate-certificate-group-get-response.yaml + tags: + - Certificates +post: + summary: Create certificates/certificate-groups + description: Creates one or more certificates to one or more certificate groups. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/certificate_group_ids.query.yaml + - $ref: ../../queries/FA2.36/certificate_group_names.query.yaml + - $ref: ../../queries/FA2.26/certificate_names.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/certificate-certificate-group-response.yaml + tags: + - Certificates +delete: + summary: Delete certificates/certificate-groups + description: Deletes one or more certificates from one or more certificate groups. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/certificate_group_ids.query.yaml + - $ref: ../../queries/FA2.36/certificate_group_names.query.yaml + - $ref: ../../queries/FA2.26/certificate_names.query.yaml + responses: + 200: + description: OK + tags: + - Certificates diff --git a/html/paths/FA2.36/directory-services-roles-policies.path.yaml b/html/paths/FA2.36/directory-services-roles-policies.path.yaml new file mode 100644 index 00000000..1f1870a8 --- /dev/null +++ b/html/paths/FA2.36/directory-services-roles-policies.path.yaml @@ -0,0 +1,67 @@ +get: + summary: List management access policies attached to a group to management access + policy mapping + description: Displays a list of management access policies that are attached to + group to management access policy mappings. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/policy_ids.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/policy-member-clean-get-response.yaml + tags: + - Directory Services +post: + summary: Create a membership between a group to management access policy mapping + with one or more management access policies + description: Creates a membership between a group to management access policy mapping + with one or more management access policies. The `member_ids` or `member_names` + parameter is required, but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - name: policies + in: body + required: true + schema: + $ref: ../../models/FA2.36/policy-assignment-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/policy-member-clean-response.yaml + tags: + - Directory Services +delete: + summary: Delete a membership between a group to management access policy mapping + and one or more management access policies + description: Deletes a membership between a group to management access policy mapping + with one or more management access policies. The `policy_ids` or `policy_names` + is required, but they cannot be set together. Also, `member_ids` or `member_names` + is required, but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/policy_ids.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + responses: + 200: + description: OK + tags: + - Directory Services diff --git a/html/paths/FA2.36/directory-services-roles.path.yaml b/html/paths/FA2.36/directory-services-roles.path.yaml new file mode 100644 index 00000000..f6a929ed --- /dev/null +++ b/html/paths/FA2.36/directory-services-roles.path.yaml @@ -0,0 +1,74 @@ +get: + summary: List group to management access policy mappings + description: Displays access control settings for remote groups. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.30/group_mapping_names.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.36/role_names.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/directory-service-role-get-response.yaml + tags: + - Directory Services +post: + summary: Create a group in management access policy mappings + description: Creates one or more groups in management access policy mappings. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.30/group_mapping_names_required.query.yaml + - name: directory-service-roles + in: body + required: true + schema: + $ref: ../../models/FA2.36/directory-service-role-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/directory-service-role-response.yaml + tags: + - Directory Services +delete: + summary: Delete group to management access policy mappings + description: Deletes one or more group to management access policy mappings. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.30/group_mapping_names_required.query.yaml + responses: + 200: + description: OK + tags: + - Directory Services +patch: + summary: Modify group to management access policy mappings + description: Modifies properties of one or more group to management access policy + mappings. Modifying management access policies is done at `/directory-services/roles/policies/management-access` + instead. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/role_names.query.yaml + - $ref: ../../queries/FA2.30/group_mapping_names_required.query.yaml + - name: directory-service-roles + in: body + required: true + schema: + $ref: ../../models/FA2.36/directory-service-role.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/directory-service-role-response.yaml + tags: + - Directory Services diff --git a/html/paths/FA2.36/fleet-key.path.yaml b/html/paths/FA2.36/fleet-key.path.yaml new file mode 100644 index 00000000..743b78c3 --- /dev/null +++ b/html/paths/FA2.36/fleet-key.path.yaml @@ -0,0 +1,35 @@ +get: + summary: Get fleet key information + description: Displays the time remaining on the fleet key. Note, fleet key itself + is not displayed, since that is only available at time of fleet key creation. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/fleet-key-get-response.yaml + tags: + - Fleets +post: + summary: Create a fleet key + description: Creates a fleet key allowing an array to be added to a fleet. This + is the only time the fleet key is displayed, it cannot be retrieved subsequently. + Note, creation of a subsequent key invalidates all keys created earlier. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/fleet-key-response.yaml + tags: + - Fleets diff --git a/html/paths/FA2.36/fleet-members.path.yaml b/html/paths/FA2.36/fleet-members.path.yaml new file mode 100644 index 00000000..e302e725 --- /dev/null +++ b/html/paths/FA2.36/fleet-members.path.yaml @@ -0,0 +1,64 @@ +get: + summary: List fleet members + description: Displays the members in the current fleet. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.36/fleet_ids.query.yaml + - $ref: ../../queries/FA2.36/fleet_names.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/fleet-member-get-response.yaml + tags: + - Fleets +post: + summary: Add members to a fleet + description: 'Adds arrays to an existing fleet. This API needs to be run from the + array that''s joining the fleet. + + To add the current array to the fleet, specify its own array `id` or `name`, as + well as the `fleet key` generated on any array already in the fleet. `resource_type` + is `remote-arrays`. The array''s `ID` and `name` can be retrieved with a call + to `GET /arrays` on the array.' + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/fleet_ids.query.yaml + - $ref: ../../queries/FA2.36/fleet_names.query.yaml + - name: members + in: body + description: Info about the members being added to fleet. + schema: + $ref: ../../models/FA2.36/fleet-member-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/fleet-member-response.yaml + tags: + - Fleets +delete: + summary: Delete fleet members + description: Deletes the specified array(s) from the fleet. Note that this will + only succeed if the array(s) to be removed are not making use of any fleet resources. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.36/unreachable.query.yaml + responses: + 200: + description: OK + tags: + - Fleets diff --git a/html/paths/FA2.36/fleets.path.yaml b/html/paths/FA2.36/fleets.path.yaml new file mode 100644 index 00000000..58a6499d --- /dev/null +++ b/html/paths/FA2.36/fleets.path.yaml @@ -0,0 +1,36 @@ +get: + summary: List fleets + description: Displays information about the fleets known to the array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.36/names_single.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/fleet-get-response.yaml + tags: + - Fleets +post: + summary: Create a fleet + description: Creates a fleet and adds the current array as its first member. Additional + arrays can be added to the fleet with `POST /fleets/members` + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/names_single.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/fleet-response.yaml + tags: + - Fleets diff --git a/html/paths/FA2.36/host-groups.path.yaml b/html/paths/FA2.36/host-groups.path.yaml new file mode 100644 index 00000000..4adb16be --- /dev/null +++ b/html/paths/FA2.36/host-groups.path.yaml @@ -0,0 +1,66 @@ +get: + summary: List host groups + description: Displays a list of host groups. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/host-group-get-response.yaml + tags: + - Host Groups +post: + summary: Create a host group + description: Creates a host group. The `names` query parameter is required. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/host-group-response.yaml + tags: + - Host Groups +delete: + summary: Delete a host group + description: Deletes a host group. The `names` query parameter is required. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - Host Groups +patch: + summary: Modify a host group + description: Modifies a host group. The `names` query parameter is required. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: host-group + in: body + required: true + schema: + $ref: ../../models/FA2.0/host-group-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/host-group-response.yaml + tags: + - Host Groups diff --git a/html/paths/FA2.36/hosts.path.yaml b/html/paths/FA2.36/hosts.path.yaml new file mode 100644 index 00000000..81152aaf --- /dev/null +++ b/html/paths/FA2.36/hosts.path.yaml @@ -0,0 +1,75 @@ +get: + summary: List hosts + description: Displays a list of hosts. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/host-get-response.yaml + tags: + - Hosts +post: + summary: Create a host + description: Creates a host. The `names` query parameter is required. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: host + in: body + required: true + schema: + $ref: ../../models/FA2.16/host-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/host-response.yaml + tags: + - Hosts +delete: + summary: Delete a host + description: Deletes an existing host. All volumes that are connected to the host, + either through private or shared connections, must be disconnected from the host + before the host can be deleted. The `names` query parameter is required. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - Hosts +patch: + summary: Modify a host + description: Modifies an existing host, including its storage network addresses, + CHAP, host personality, and preferred arrays, or associate a host to a host group. + The `names` query parameter is required. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: host + in: body + required: true + schema: + $ref: ../../models/FA2.16/host-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/host-response.yaml + tags: + - Hosts diff --git a/html/paths/FA2.36/network-interfaces-performance.path.yaml b/html/paths/FA2.36/network-interfaces-performance.path.yaml new file mode 100644 index 00000000..bee4dc5a --- /dev/null +++ b/html/paths/FA2.36/network-interfaces-performance.path.yaml @@ -0,0 +1,24 @@ +get: + summary: List network performance statistics + description: Displays network statistics, historical bandwidth, and error reporting + for all specified network interfaces. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/history_end_time.query.yaml + - $ref: ../../queries/FA2.0/history_resolution.query.yaml + - $ref: ../../queries/FA2.0/history_start_time.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + - $ref: ../../queries/FA2.0/total_only.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/network-interface-performance-get-response.yaml + tags: + - Network Interfaces diff --git a/html/paths/FA2.36/pods-arrays-members.path.yaml b/html/paths/FA2.36/pods-arrays-members.path.yaml new file mode 100644 index 00000000..01af8f87 --- /dev/null +++ b/html/paths/FA2.36/pods-arrays-members.path.yaml @@ -0,0 +1,76 @@ +get: + summary: List pods and their the array members + description: This field has been deprecated. Use pods/members instead. Returns a + list of pods and the local and remote arrays over which the pods are stretched. + Pods with realm members will not be returned. The optional `group_names` parameter + represents the name of the pod. The optional `member_names` parameter represents + the name of the array over which the pod is stretched. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/group_names.query.yaml + - $ref: ../../queries/FA2.0/group_ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.1/member-get-response.yaml + tags: + - Pods +post: + summary: Stretch a pod to an array + description: This field has been deprecated. Use pods/members instead. Stretches + a pod to an array. When a pod is stretched to an array, the data in the arrays + over which the pod is stretched is synchronously replicated. The `group_names` + parameter represents the name of the pod to be stretched. The `member_names` parameter + represents the name of the array over which the pod is to be stretched. The `group_names` + and `member_names` parameters are required and must be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/group_names.query.yaml + - $ref: ../../queries/FA2.0/group_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.0/member-response.yaml + tags: + - Pods +delete: + summary: Unstretch a pod from an array + description: This field has been deprecated. Use pods/members instead. Unstretches + a pod from an array, collapsing the pod to a single array. Unstretch a pod from + an array when the volumes within the stretched pod no longer need to be synchronously + replicated between the two arrays. After a pod has been unstretched, synchronous + replication stops. A destroyed version of the pod with "restretch" appended to + the pod name is created on the array that no longer has the pod. The restretch + pod represents a point-in-time snapshot of the pod, just before it was unstretched. + The restretch pod enters an eradication pending period starting from the time + that the pod was unstretched. A restretch can pod can be cloned or destroyed, + but it cannot be explicitly recovered. The `group_names` parameter represents + the name of the pod to be unstretched. The `member_names` parameter represents + the name of the array from which the pod is to be unstretched. The `group_names` + and `member_names` parameters are required and must be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/group_names.query.yaml + - $ref: ../../queries/FA2.0/group_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/with_unknown.query.yaml + responses: + 200: + description: OK + tags: + - Pods diff --git a/html/paths/FA2.36/pods-members.path.yaml b/html/paths/FA2.36/pods-members.path.yaml new file mode 100644 index 00000000..0c045733 --- /dev/null +++ b/html/paths/FA2.36/pods-members.path.yaml @@ -0,0 +1,70 @@ +get: + summary: List pods and their members + description: Displays a list of pods and the local and remote members over which + the pods are stretched. Currently either array or realm is supported as member. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.36/pod_names.query.yaml + - $ref: ../../queries/FA2.36/pod_ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/pod-member-get-response.yaml + tags: + - Pods +post: + summary: Creatse a member to add to a pod + description: Creates a stretched pod on an array. When a pod is stretched to an + array, the data in the arrays over which the pod is stretched is synchronously + replicated. The `member_names` or `member_ids` parameter represents the array + over which the pod is to be stretched. Both pod and member must be specified by + `name` or `ID`. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/pod_names.query.yaml + - $ref: ../../queries/FA2.36/pod_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/pod-member-response.yaml + tags: + - Pods +delete: + summary: Delete a member from a pod + description: Unstretches a pod from an array, collapsing the pod to a member array. + Unstretch a pod from an array when the volumes within the stretched pod no longer + need to be synchronously replicated between the two members. After a pod has been + unstretched, synchronous replication stops. A destroyed version of the pod with + "restretch" appended to the pod name is created on the member that no longer has + the pod. The restretch pod represents a point-in-time snapshot of the pod, just + before it was unstretched. The restretch pod enters an eradication pending period + starting from the time that the pod was unstretched. A restretch can pod can be + cloned or destroyed, but it cannot be explicitly recovered. The `member_names` + parameter represents the name of the array from which the pod is to be unstretched. + Both pod and member must be specified by `name` or `ID`. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/pod_names.query.yaml + - $ref: ../../queries/FA2.36/pod_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/with_unknown.query.yaml + responses: + 200: + description: OK + tags: + - Pods diff --git a/html/paths/FA2.36/pods-performance.path.yaml b/html/paths/FA2.36/pods-performance.path.yaml new file mode 100644 index 00000000..929309a3 --- /dev/null +++ b/html/paths/FA2.36/pods-performance.path.yaml @@ -0,0 +1,29 @@ +get: + summary: List pod performance data + description: Displays real-time and historical performance data, real-time latency + data, and average I/O sizes across all pods, displayed both by pod and as a total + across all pods. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/history_end_time.query.yaml + - $ref: ../../queries/FA2.0/history_resolution.query.yaml + - $ref: ../../queries/FA2.0/history_start_time.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.2/perf_protocol_type.query.yaml + - $ref: ../../queries/FA2.2/perf_protocol_group.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + - $ref: ../../queries/FA2.0/total_only.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/container-performance-get-response.yaml + tags: + - Pods diff --git a/html/paths/FA2.36/pods.path.yaml b/html/paths/FA2.36/pods.path.yaml new file mode 100644 index 00000000..7a74a7ca --- /dev/null +++ b/html/paths/FA2.36/pods.path.yaml @@ -0,0 +1,94 @@ +get: + summary: List pods + description: Displays a list of pods that are stretched to this array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + - $ref: ../../queries/FA2.0/total_only.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/pod-get-response.yaml + tags: + - Pods +post: + summary: Create a pod + description: Creates a pod on the local array. Each pod must be given a unique name + across the arrays to which they are stretched. A pod cannot be stretched to an + array that already contains a pod with the same name. After a pod has been created, + add volumes and protection groups, and then stretch the pod to another connected + array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.31/allow_throttle_operation.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: pod + in: body + required: true + schema: + $ref: ../../models/FA2.23/pod-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/pod-response.yaml + tags: + - Pods +delete: + summary: Delete a pod + description: Deletes a pod that has been destroyed and is pending eradication. Eradicated + pods cannot be recovered. Pods are destroyed using the PATCH method. The `ids` + or `names` parameter is required, but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.36/eradicate_contents.query.yaml + responses: + 200: + description: OK + tags: + - Pods +patch: + summary: Modify a pod + description: Modifies pod details. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.2/abort_quiesce.query.yaml + - $ref: ../../queries/FA2.2/quiesce.query.yaml + - $ref: ../../queries/FA2.2/skip_quiesce.query.yaml + - $ref: ../../queries/FA2.2/promote_from.query.yaml + - $ref: ../../queries/FA2.36/destroy_contents.query.yaml + - $ref: ../../queries/FA2.36/from_member_ids.query.yaml + - $ref: ../../queries/FA2.36/from_member_names.query.yaml + - $ref: ../../queries/FA2.36/to_member_ids.query.yaml + - $ref: ../../queries/FA2.36/to_member_names.query.yaml + - $ref: ../../queries/FA2.36/move_with_host_names.query.yaml + - $ref: ../../queries/FA2.36/move_with_host_group_names.query.yaml + - name: pod + in: body + required: true + schema: + $ref: ../../models/FA2.23/pod-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/pod-response.yaml + tags: + - Pods diff --git a/html/paths/FA2.36/policies-management-access-members.path.yaml b/html/paths/FA2.36/policies-management-access-members.path.yaml new file mode 100644 index 00000000..eed1af87 --- /dev/null +++ b/html/paths/FA2.36/policies-management-access-members.path.yaml @@ -0,0 +1,64 @@ +get: + summary: List management access policy members + description: Displays a list of management access policy members. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.36/member_ids-unrestricted.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/member_types.query.yaml + - $ref: ../../queries/FA2.36/policy_ids-unrestricted.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/policy-member-clean-get-response.yaml + tags: + - Policies +post: + summary: Create a membership between an object and a management access policy + description: Creates a membership between one or more objects and a management access + policy. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/policy_ids-unrestricted.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + - name: members + in: body + required: true + schema: + $ref: ../../models/FA2.3/policy-member-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/policy-member-clean-response.yaml + tags: + - Policies +delete: + summary: Delete membership between management access policies and attached object + description: Deletes a membership between one or more management access policies + and attached object. The`policy_ids` or `policy_names` is required, but they cannot + be set together. The `member_ids` or `member_names`. `member_types` is also required, + but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.3/member_types.query.yaml + - $ref: ../../queries/FA2.36/policy_ids-unrestricted.query.yaml + - $ref: ../../queries/FA2.3/policy_names.query.yaml + responses: + 200: + description: OK + tags: + - Policies diff --git a/html/paths/FA2.36/policies-management-access.path.yaml b/html/paths/FA2.36/policies-management-access.path.yaml new file mode 100644 index 00000000..c7844008 --- /dev/null +++ b/html/paths/FA2.36/policies-management-access.path.yaml @@ -0,0 +1,79 @@ +get: + summary: List management access policies + description: Displays a list of management access policies. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/policy-management-access-get-response.yaml + tags: + - Policies +post: + summary: Create management access policies + description: Creates one or more management access policies. To copy a policy, the`source_names` + or `source_ids` is required, but they cannot be set together. To create a policy + from scratch, `policy body` is required. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names_required.query.yaml + - $ref: ../../queries/FA2.0/source_ids.query.yaml + - $ref: ../../queries/FA2.0/source_names.query.yaml + - name: policy + in: body + schema: + $ref: ../../models/FA2.36/policy-management-access-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/policy-management-access-response.yaml + tags: + - Policies +delete: + summary: Delete management access policies + description: Deletes one or more management access policies. The `ids` or `names` + is required, but they cannot be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + responses: + 200: + description: OK + tags: + - Policies +patch: + summary: Modify management access policies + description: Modifies one or more management access policies. The `ids` or `names` + is required, but they cannot be set together. For renames, can only specify one + old policy in `ids` or `names`. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: policy + in: body + required: true + schema: + $ref: ../../models/FA2.36/policy-management-access-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/policy-management-access-response.yaml + tags: + - Policies diff --git a/html/paths/FA2.36/realms-performance.path.yaml b/html/paths/FA2.36/realms-performance.path.yaml new file mode 100644 index 00000000..e659497d --- /dev/null +++ b/html/paths/FA2.36/realms-performance.path.yaml @@ -0,0 +1,27 @@ +get: + summary: List realm performance data + description: Displays real-time and historical performance data, real-time latency + data, and average I/O sizes across all realms, displayed both by realm and as + a total across all realms. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/history_end_time.query.yaml + - $ref: ../../queries/FA2.0/history_resolution.query.yaml + - $ref: ../../queries/FA2.0/history_start_time.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + - $ref: ../../queries/FA2.0/total_only.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/container-performance-get-response.yaml + tags: + - Realms diff --git a/html/paths/FA2.36/realms-space.path.yaml b/html/paths/FA2.36/realms-space.path.yaml new file mode 100644 index 00000000..6d6a04ac --- /dev/null +++ b/html/paths/FA2.36/realms-space.path.yaml @@ -0,0 +1,26 @@ +get: + summary: List realm space information + description: Displays provisioned size and storage consumption data for each realm + on the local array. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/history_end_time.query.yaml + - $ref: ../../queries/FA2.0/history_resolution.query.yaml + - $ref: ../../queries/FA2.0/history_start_time.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + - $ref: ../../queries/FA2.0/total_only.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/realm-space-get-response.yaml + tags: + - Realms diff --git a/html/paths/FA2.36/realms.path.yaml b/html/paths/FA2.36/realms.path.yaml new file mode 100644 index 00000000..b0d8f035 --- /dev/null +++ b/html/paths/FA2.36/realms.path.yaml @@ -0,0 +1,80 @@ +get: + summary: List realms + description: Displays a list of realms. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + - $ref: ../../queries/FA2.0/total_only.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/realm-get-response.yaml + tags: + - Realms +post: + summary: Create realms + description: Creates realms on the local array. Each realm must be given a name + that is unique across the connected arrays. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names_required.query.yaml + - name: realm + in: body + required: false + schema: + $ref: ../../models/FA2.36/realm-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/realm-response.yaml + tags: + - Realms +patch: + summary: Modify realms + description: Modifies realm details. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.36/destroy_contents.query.yaml + - $ref: ../../queries/FA2.36/container_ignore_usage.query.yaml + - name: realm + in: body + required: true + schema: + $ref: ../../models/FA2.36/realm-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/realm-response.yaml + tags: + - Realms +delete: + summary: Delete Realms + description: Deletes realms that have been destroyed and are pending eradication. + Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.36/eradicate_contents.query.yaml + responses: + 200: + description: OK + tags: + - Realms diff --git a/html/paths/FA2.36/remote-arrays.path.yaml b/html/paths/FA2.36/remote-arrays.path.yaml new file mode 100644 index 00000000..4a1fab34 --- /dev/null +++ b/html/paths/FA2.36/remote-arrays.path.yaml @@ -0,0 +1,27 @@ +get: + summary: List remote arrays + description: Dispalys arrays in the current fleet, as well as arrays that the current + array has existing replication connections to. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + - name: current_fleet_only + in: query + description: If current_fleet_only is specified, then results will only show arrays + from the same fleet to which the current array is a member of. + type: boolean + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/remote-arrays-response.yaml + tags: + - Remote Arrays diff --git a/html/paths/FA2.36/support-diagnostics-details.path.yaml b/html/paths/FA2.36/support-diagnostics-details.path.yaml new file mode 100644 index 00000000..2682ad47 --- /dev/null +++ b/html/paths/FA2.36/support-diagnostics-details.path.yaml @@ -0,0 +1,19 @@ +get: + summary: List diagnostics details + description: Displays the diagnostics tests details. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/support-diagnostics-details-get-response.yaml + tags: + - Support diff --git a/html/paths/FA2.36/support-diagnostics-settings.path.yaml b/html/paths/FA2.36/support-diagnostics-settings.path.yaml new file mode 100644 index 00000000..5df15745 --- /dev/null +++ b/html/paths/FA2.36/support-diagnostics-settings.path.yaml @@ -0,0 +1,33 @@ +get: + summary: List diagnostics tools version and last updated date + description: Displays diagnostics tools version and last updated date. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.36/support-diagnostics-get-response.yaml + tags: + - Support +patch: + summary: Update diagnostics tools + description: Update diagnostics tools from downloaded bundle. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.36/purity-default.query.yaml + responses: + 200: + description: The diagnostics tools were updated successfully. + schema: + $ref: ../../responses/FA2.36/support-diagnostics-response.yaml + tags: + - Support diff --git a/html/paths/FA2.36/volume-groups.path.yaml b/html/paths/FA2.36/volume-groups.path.yaml new file mode 100644 index 00000000..d7315019 --- /dev/null +++ b/html/paths/FA2.36/volume-groups.path.yaml @@ -0,0 +1,90 @@ +get: + summary: List volume groups + description: Displays a list of volume groups, including those pending eradication. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/destroyed.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + - $ref: ../../queries/FA2.0/total_only.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.34/volume-group-get-response.yaml + tags: + - Volume Groups +post: + summary: Create a volume group + description: Creates a volume group. The volume group itself does not contain any + meaningful content; instead, it acts as a container that is used to organize volumes. + Once a volume group has been created, volumes can be created inside the volume + group or moved into and out of the volume group. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - name: volume-group + in: body + required: true + schema: + $ref: ../../models/FA2.34/volume-group-post.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.34/volume-group-response.yaml + tags: + - Volume Groups +delete: + summary: Delete a volume group + description: Deletes a volume group that has been destroyed and is pending eradication. + Eradicated volume groups cannot be recovered. Volume groups are destroyed through + the PATCH method. The `ids` or `names` parameter is required, but they cannot + be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.36/eradicate_contents.query.yaml + responses: + 200: + description: OK + tags: + - Volume Groups +patch: + summary: Modify a volume group + description: Modifies a volume group. You can rename, destroy, recover, or set QoS + limits for a volume group. To rename a volume group, set `name` to the new name. + To destroy a volume group, set `destroyed=true`. To recover a volume group that + has been destroyed and is pending eradication, set `destroyed=false`. Sets the + bandwidth and IOPs limits of a volume group through the respective `bandwidth_limit` + and `iops_limit` parameter. The `ids` or `names` parameter is required, but they + cannot be set together. Sets the priority adjustment for a volume group using + the `priority_adjustment_operator` and `priority_adjustment_value` fields. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.36/destroy_contents.query.yaml + - name: volume-group + in: body + required: true + schema: + $ref: ../../models/FA2.34/volume-group-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.34/volume-group-response.yaml + tags: + - Volume Groups diff --git a/html/paths/FA2.37/directory-services.path.yaml b/html/paths/FA2.37/directory-services.path.yaml new file mode 100644 index 00000000..fbbac22c --- /dev/null +++ b/html/paths/FA2.37/directory-services.path.yaml @@ -0,0 +1,39 @@ +get: + summary: List directory services configuration + description: Displays the directory services configuration settings for manageability. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.37/directory-service-get-response.yaml + tags: + - Directory Services +patch: + summary: Modify directory services configuration + description: Modifies the directory service configuration. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/names_required.query.yaml + - name: directory-service + in: body + required: true + schema: + $ref: ../../models/FA2.37/directory-service.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.37/directory-service-response.yaml + tags: + - Directory Services diff --git a/html/paths/FA2.37/protection-groups-targets.path.yaml b/html/paths/FA2.37/protection-groups-targets.path.yaml new file mode 100644 index 00000000..e6a3bb25 --- /dev/null +++ b/html/paths/FA2.37/protection-groups-targets.path.yaml @@ -0,0 +1,91 @@ +get: + summary: List protection groups with targets + description: Displays a list of protection groups that have target arrays, pods, + or offload targets. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/group_ids.query.yaml + - $ref: ../../queries/FA2.0/group_names.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.37/protection-group-target-get-response.yaml + tags: + - Protection Groups +post: + summary: Create an action to add a target to a protection group + description: Creates an action to add an array, pod, or offload target to a protection + group. The `group_names` parameter represents the name of the protection group. + The `member_names` parameter represents the name of the array, pod, or offload + target that is being added to the protection group. The `group_names` and `member_names` + parameters are required and must be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/group_ids.query.yaml + - $ref: ../../queries/FA2.0/group_names.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.37/protection-group-target-response.yaml + tags: + - Protection Groups +patch: + summary: Modify a protection group target + description: Modifies the source array to replicate protection group data to the + target, or disallows the source array from replicating protection group data to + the target. The `allowed` parameter must be set from the target array. The `group_names` + parameter represents the name of the protection group. The `allowed` and `group_names` + parameters are required and must be set together. Offload targets do not support + the `allowed` parameter. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/group_ids.query.yaml + - $ref: ../../queries/FA2.0/group_names.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + - name: target + in: body + required: true + schema: + $ref: ../../models/FA2.26/target-protection-group-post-patch.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.37/protection-group-target-response.yaml + tags: + - Protection Groups +delete: + summary: Delete a target from a protection group + description: Deletes an array, pod, or offload target from a protection group. The + `group_names` parameter represents the name of the protection group. The `member_names` + parameter represents the name of the array, pod, or offload target that is being + removed from the protection group. The `group_names` and `member_names` parameters + are required and must be set together. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.0/group_ids.query.yaml + - $ref: ../../queries/FA2.0/group_names.query.yaml + - $ref: ../../queries/FA2.0/member_ids.query.yaml + - $ref: ../../queries/FA2.0/member_names.query.yaml + responses: + 200: + description: OK + tags: + - Protection Groups diff --git a/html/paths/FA2.37/software-installations.path.yaml b/html/paths/FA2.37/software-installations.path.yaml new file mode 100644 index 00000000..716ec220 --- /dev/null +++ b/html/paths/FA2.37/software-installations.path.yaml @@ -0,0 +1,65 @@ +get: + summary: List software upgrades + description: Displays a list of software upgrades, including currently running and + past upgrades. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.1/continuation_token.query.yaml + - $ref: ../../queries/FA2.0/filter.query.yaml + - $ref: ../../queries/FA2.0/ids.query.yaml + - $ref: ../../queries/FA2.0/limit.query.yaml + - $ref: ../../queries/FA2.0/names.query.yaml + - $ref: ../../queries/FA2.0/offset.query.yaml + - $ref: ../../queries/FA2.2/software_ids.query.yaml + - $ref: ../../queries/FA2.2/software_names.query.yaml + - $ref: ../../queries/FA2.0/sort.query.yaml + - $ref: ../../queries/FA2.0/total_item_count.query.yaml + responses: + 200: + description: OK + schema: + $ref: ../../responses/FA2.37/software-installations-get-response.yaml + tags: + - Software +post: + summary: Create a software upgrade + description: Creates and initiates a software upgrade. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.2/software_ids-required.query.yaml + - name: software-installations + in: body + required: true + schema: + $ref: ../../models/FA2.37/software-installation-post.yaml + responses: + 200: + description: The software upgrade record was created successfully. + schema: + $ref: ../../responses/FA2.37/software-installations-response.yaml + tags: + - Software +patch: + summary: Modify software upgrade + description: Modifies a software upgrade by continuing, retrying, or aborting it. + All `override_checks` are updated before the command is issued if `add_override_checks` + is present. The `override_checks` parameter is valid when `command` is set to + `continue` or `retry`. + parameters: + - $ref: ../../queries/FA2.0/authorization.header.yaml + - $ref: ../../queries/FA2.0/x-request-id.header.yaml + - $ref: ../../queries/FA2.2/software_installation_command_required.query.yaml + - $ref: ../../queries/FA2.2/software_installation_current_step_id-required.query.yaml + - name: software-installations + in: body + schema: + $ref: ../../models/FA2.4/software-installation-patch.yaml + responses: + 200: + description: The `command` was issued and/or `override_checks` was updated. + schema: + $ref: ../../responses/FA2.37/software-installations-response.yaml + tags: + - Software diff --git a/html/paths/FB2.15/buckets.path.yaml b/html/paths/FB2.15/buckets.path.yaml new file mode 100644 index 00000000..e3949434 --- /dev/null +++ b/html/paths/FB2.15/buckets.path.yaml @@ -0,0 +1,80 @@ +get: + summary: GET buckets + description: List object store bucket attributes such as creation time and space + usage. + parameters: + - $ref: ../../queries/FB2.14/x-request-id.header.yaml + - $ref: ../../queries/FB2.0/continuation_token.query.yaml + - $ref: ../../queries/FB2.0/destroyed.query.yaml + - $ref: ../../queries/FB2.0/filter.query.yaml + - $ref: ../../queries/FB2.0/ids.query.yaml + - $ref: ../../queries/FB2.0/limit.query.yaml + - $ref: ../../queries/FB2.0/names.query.yaml + - $ref: ../../queries/FB2.0/offset.query.yaml + - $ref: ../../queries/FB2.0/sort.query.yaml + - $ref: ../../queries/FB2.0/total_only.query.yaml + responses: + 200: + description: OK + headers: + $ref: ../../responses/FB2.14/headers-all-default.response.yaml + schema: + $ref: ../../responses/FB2.15/bucket-get-response.yaml + tags: + - Buckets +post: + summary: POST buckets + description: Create a new object store bucket. + parameters: + - $ref: ../../queries/FB2.14/x-request-id.header.yaml + - $ref: ../../queries/FB2.0/names_required.query.yaml + - name: bucket + in: body + required: true + schema: + $ref: ../../models/FB2.13/bucket-post.yaml + responses: + 200: + description: OK + headers: + $ref: ../../responses/FB2.14/headers-all-default.response.yaml + schema: + $ref: ../../responses/FB2.15/bucket-response.yaml + tags: + - Buckets +patch: + summary: PATCH buckets + description: Modify object store bucket attributes such as destroyed and versioning. + parameters: + - $ref: ../../queries/FB2.14/x-request-id.header.yaml + - $ref: ../../queries/FB2.0/ids.query.yaml + - $ref: ../../queries/FB2.11/ignore_usage.query.yaml + - $ref: ../../queries/FB2.0/names.query.yaml + - name: bucket + in: body + required: true + schema: + $ref: ../../models/FB2.13/bucket-patch.yaml + responses: + 200: + description: OK + headers: + $ref: ../../responses/FB2.14/headers-all-default.response.yaml + schema: + $ref: ../../responses/FB2.15/bucket-response.yaml + tags: + - Buckets +delete: + summary: DELETE buckets + description: Delete object store buckets. + parameters: + - $ref: ../../queries/FB2.14/x-request-id.header.yaml + - $ref: ../../queries/FB2.0/ids.query.yaml + - $ref: ../../queries/FB2.0/names.query.yaml + responses: + 200: + description: OK + headers: + $ref: ../../responses/FB2.14/headers-all-default.response.yaml + tags: + - Buckets diff --git a/html/paths/FB2.15/object-store-accounts.path.yaml b/html/paths/FB2.15/object-store-accounts.path.yaml new file mode 100644 index 00000000..3dd84571 --- /dev/null +++ b/html/paths/FB2.15/object-store-accounts.path.yaml @@ -0,0 +1,79 @@ +get: + summary: GET object-store-accounts + description: List object store accounts and their attributes. + parameters: + - $ref: ../../queries/FB2.14/x-request-id.header.yaml + - $ref: ../../queries/FB2.0/continuation_token.query.yaml + - $ref: ../../queries/FB2.0/filter.query.yaml + - $ref: ../../queries/FB2.0/ids.query.yaml + - $ref: ../../queries/FB2.0/limit.query.yaml + - $ref: ../../queries/FB2.0/names.query.yaml + - $ref: ../../queries/FB2.0/offset.query.yaml + - $ref: ../../queries/FB2.0/sort.query.yaml + - $ref: ../../queries/FB2.0/total_only.query.yaml + responses: + 200: + description: OK + headers: + $ref: ../../responses/FB2.14/headers-all-default.response.yaml + schema: + $ref: ../../responses/FB2.15/object-store-account-get-response.yaml + tags: + - Object Store Accounts +post: + summary: POST object-store-accounts + description: Create an object store account. + parameters: + - $ref: ../../queries/FB2.14/x-request-id.header.yaml + - $ref: ../../queries/FB2.0/names_required.query.yaml + - name: object-store-account + in: body + required: false + schema: + $ref: ../../models/FB2.8/object-store-account-post.yaml + responses: + 200: + description: OK + headers: + $ref: ../../responses/FB2.14/headers-all-default.response.yaml + schema: + $ref: ../../responses/FB2.15/object-store-account-response.yaml + tags: + - Object Store Accounts +patch: + summary: PATCH object-store-accounts + description: Modify object store account attributes such as quota limit and bucket + defaults. + parameters: + - $ref: ../../queries/FB2.14/x-request-id.header.yaml + - $ref: ../../queries/FB2.0/ids.query.yaml + - $ref: ../../queries/FB2.11/ignore_usage.query.yaml + - $ref: ../../queries/FB2.0/names.query.yaml + - name: object-store-account + in: body + required: true + schema: + $ref: ../../models/FB2.12/object-store-account-patch.yaml + responses: + 200: + description: OK + headers: + $ref: ../../responses/FB2.14/headers-all-default.response.yaml + schema: + $ref: ../../responses/FB2.15/object-store-account-response.yaml + tags: + - Object Store Accounts +delete: + summary: DELETE object-store-accounts + description: Delete an object store account. + parameters: + - $ref: ../../queries/FB2.14/x-request-id.header.yaml + - $ref: ../../queries/FB2.0/ids.query.yaml + - $ref: ../../queries/FB2.0/names.query.yaml + responses: + 200: + description: OK + headers: + $ref: ../../responses/FB2.14/headers-all-default.response.yaml + tags: + - Object Store Accounts diff --git a/html/queries/FA2.36/certificate_group_ids.query.yaml b/html/queries/FA2.36/certificate_group_ids.query.yaml new file mode 100644 index 00000000..d2a4b75b --- /dev/null +++ b/html/queries/FA2.36/certificate_group_ids.query.yaml @@ -0,0 +1,10 @@ +name: certificate_group_ids +in: query +description: A comma-separated list of certificate group ids. If there is not at least + one resource that matches each of the elements of `certificate_group_ids`, then + an error is returned. This cannot be provided in conjunction with the `certificate_group_names` + parameter. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/certificate_group_names.query.yaml b/html/queries/FA2.36/certificate_group_names.query.yaml new file mode 100644 index 00000000..3e0aac12 --- /dev/null +++ b/html/queries/FA2.36/certificate_group_names.query.yaml @@ -0,0 +1,9 @@ +name: certificate_group_names +in: query +description: A comma-separated list of certificate group names. If no resource matches + each of the elements of `certificate_group_names`, then an error is returned. This + cannot be provided in conjunction with the `certificate_group_ids` parameter. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/container_ignore_usage.query.yaml b/html/queries/FA2.36/container_ignore_usage.query.yaml new file mode 100644 index 00000000..b2ff0aa3 --- /dev/null +++ b/html/queries/FA2.36/container_ignore_usage.query.yaml @@ -0,0 +1,6 @@ +name: ignore_usage +in: query +description: Set to `true` to set a `quota_limit` that is lower than the existing + usage. This ensures that no new volumes can be created until the existing usage + drops below the `quota_limit`. If not specified, defaults to `false`. +type: boolean diff --git a/html/queries/FA2.36/destroy_contents.query.yaml b/html/queries/FA2.36/destroy_contents.query.yaml new file mode 100644 index 00000000..4818b6ca --- /dev/null +++ b/html/queries/FA2.36/destroy_contents.query.yaml @@ -0,0 +1,6 @@ +name: destroy_contents +in: query +description: Set to `true` to destroy contents (e.g., volumes, protection groups, + snapshots) and containers (e.g., realms, pods, volume groups), including eradicating + containers with content. +type: boolean diff --git a/html/queries/FA2.36/eradicate_contents.query.yaml b/html/queries/FA2.36/eradicate_contents.query.yaml new file mode 100644 index 00000000..f9c3982d --- /dev/null +++ b/html/queries/FA2.36/eradicate_contents.query.yaml @@ -0,0 +1,6 @@ +name: eradicate_contents +in: query +description: Set to `true` to eradicate contents (e.g., volumes, protection groups, + snapshots) and containers (e.g., realms, pods, volume groups). This enables you + to eradicate containers with contents. +type: boolean diff --git a/html/queries/FA2.36/fleet_ids.query.yaml b/html/queries/FA2.36/fleet_ids.query.yaml new file mode 100644 index 00000000..da94a226 --- /dev/null +++ b/html/queries/FA2.36/fleet_ids.query.yaml @@ -0,0 +1,8 @@ +name: fleet_ids +in: query +description: Performs the operation on the unique Fleet IDs specified. This query + currently accepts only 1 ID. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/fleet_names.query.yaml b/html/queries/FA2.36/fleet_names.query.yaml new file mode 100644 index 00000000..bd48d0f3 --- /dev/null +++ b/html/queries/FA2.36/fleet_names.query.yaml @@ -0,0 +1,9 @@ +name: fleet_names +in: query +description: Performs the operation on the unique Fleet names specified. Enter multiple + names in comma-separated format. For example, `name01,name02`. This query currently + accepts only 1 name. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/from_member_ids.query.yaml b/html/queries/FA2.36/from_member_ids.query.yaml new file mode 100644 index 00000000..190854d5 --- /dev/null +++ b/html/queries/FA2.36/from_member_ids.query.yaml @@ -0,0 +1,9 @@ +name: from_member_ids +in: query +description: Move the resource from the specified local member realm or array. This + should be a union of all local realms and arrays from which the resource should + be removed. Enter multiple IDs in a comma-separated format. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/from_member_names.query.yaml b/html/queries/FA2.36/from_member_names.query.yaml new file mode 100644 index 00000000..5936f87b --- /dev/null +++ b/html/queries/FA2.36/from_member_names.query.yaml @@ -0,0 +1,9 @@ +name: from_member_names +in: query +description: Move the resource from the specified local member realm or array. This + should be a union of all local realms and arrays to be removed from the specified + resource. Enter multiple names in a comma-separated format. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/member_ids-unrestricted.query.yaml b/html/queries/FA2.36/member_ids-unrestricted.query.yaml new file mode 100644 index 00000000..ca52106e --- /dev/null +++ b/html/queries/FA2.36/member_ids-unrestricted.query.yaml @@ -0,0 +1,8 @@ +name: member_ids +in: query +description: Performs the operation on the unique member IDs specified. Enter multiple + member IDs in a comma-separated format. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/move_with_host_group_names.query.yaml b/html/queries/FA2.36/move_with_host_group_names.query.yaml new file mode 100644 index 00000000..9737a08a --- /dev/null +++ b/html/queries/FA2.36/move_with_host_group_names.query.yaml @@ -0,0 +1,9 @@ +name: move_with_host_group_names +in: query +description: The host groups to be moved together with the pods to the specified local + member realm or array. All the hosts in the host groups will also be moved. Enter + multiple names in a comma-separated format. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/move_with_host_names.query.yaml b/html/queries/FA2.36/move_with_host_names.query.yaml new file mode 100644 index 00000000..7ad2b6ec --- /dev/null +++ b/html/queries/FA2.36/move_with_host_names.query.yaml @@ -0,0 +1,8 @@ +name: move_with_host_names +in: query +description: The hosts to be moved together with the pods to the specified local member + realm or array. Enter multiple names in a comma-separated format. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/names_single.query.yaml b/html/queries/FA2.36/names_single.query.yaml new file mode 100644 index 00000000..cf1279ea --- /dev/null +++ b/html/queries/FA2.36/names_single.query.yaml @@ -0,0 +1,8 @@ +name: names +in: query +description: Performs the operation on the unique resource names specified. Only one + value is supported. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/pod_ids.query.yaml b/html/queries/FA2.36/pod_ids.query.yaml new file mode 100644 index 00000000..88da8306 --- /dev/null +++ b/html/queries/FA2.36/pod_ids.query.yaml @@ -0,0 +1,7 @@ +name: pod_ids +in: query +description: A comma-separated list of pod IDs. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/pod_names.query.yaml b/html/queries/FA2.36/pod_names.query.yaml new file mode 100644 index 00000000..797a971e --- /dev/null +++ b/html/queries/FA2.36/pod_names.query.yaml @@ -0,0 +1,8 @@ +name: pod_names +in: query +description: Performs the operation on the unique pod name specified. Enter multiple + names in comma-separated format. For example, `pod01,pod02`. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/policy_ids-unrestricted.query.yaml b/html/queries/FA2.36/policy_ids-unrestricted.query.yaml new file mode 100644 index 00000000..4001abaa --- /dev/null +++ b/html/queries/FA2.36/policy_ids-unrestricted.query.yaml @@ -0,0 +1,8 @@ +name: policy_ids +in: query +description: Performs the operation on the unique policy IDs specified. Enter multiple + policy IDs in a comma-separated format. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/purity-default.query.yaml b/html/queries/FA2.36/purity-default.query.yaml new file mode 100644 index 00000000..d341f20a --- /dev/null +++ b/html/queries/FA2.36/purity-default.query.yaml @@ -0,0 +1,5 @@ +name: purity_default +in: query +description: Set diagnostics tool to default version. +type: boolean +required: false diff --git a/html/queries/FA2.36/role_names.query.yaml b/html/queries/FA2.36/role_names.query.yaml new file mode 100644 index 00000000..23b0d29c --- /dev/null +++ b/html/queries/FA2.36/role_names.query.yaml @@ -0,0 +1,7 @@ +name: role_names +in: query +description: This field has been deprecated. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/to_member_ids.query.yaml b/html/queries/FA2.36/to_member_ids.query.yaml new file mode 100644 index 00000000..1dd609d2 --- /dev/null +++ b/html/queries/FA2.36/to_member_ids.query.yaml @@ -0,0 +1,8 @@ +name: to_member_ids +in: query +description: The resource will be moved to the specified local member realm or array. + Enter multiple IDs in a comma-separated format. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/to_member_names.query.yaml b/html/queries/FA2.36/to_member_names.query.yaml new file mode 100644 index 00000000..a71caeaa --- /dev/null +++ b/html/queries/FA2.36/to_member_names.query.yaml @@ -0,0 +1,8 @@ +name: to_member_names +in: query +description: The resource will be moved to the specified local member realm or array. + Enter multiple names in a comma-separated format. +type: array +collectionFormat: csv +items: + type: string diff --git a/html/queries/FA2.36/unreachable.query.yaml b/html/queries/FA2.36/unreachable.query.yaml new file mode 100644 index 00000000..0b8be330 --- /dev/null +++ b/html/queries/FA2.36/unreachable.query.yaml @@ -0,0 +1,7 @@ +name: unreachable +in: query +description: If set to `true`, allows a one-sided disconnect when the connection status + is `connecting` instead of `connected` or `partially connected`. If set to `false`, + it works just like normal coordinated disconnect. If not specified, defaults to + `false`. +type: boolean diff --git a/html/responses/FA2.35/log-target-file-get-response.yaml b/html/responses/FA2.35/log-target-file-get-response.yaml new file mode 100644 index 00000000..65e6f388 --- /dev/null +++ b/html/responses/FA2.35/log-target-file-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.35/log-target-file-response.yaml diff --git a/html/responses/FA2.35/log-target-file-response.yaml b/html/responses/FA2.35/log-target-file-response.yaml new file mode 100644 index 00000000..d78731c3 --- /dev/null +++ b/html/responses/FA2.35/log-target-file-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.35/log-target-file.yaml diff --git a/html/responses/FA2.35/log-targets-get-response.yaml b/html/responses/FA2.35/log-targets-get-response.yaml new file mode 100644 index 00000000..b6fd0c66 --- /dev/null +++ b/html/responses/FA2.35/log-targets-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.35/log-targets-response.yaml diff --git a/html/responses/FA2.35/log-targets-response.yaml b/html/responses/FA2.35/log-targets-response.yaml new file mode 100644 index 00000000..0b95675e --- /dev/null +++ b/html/responses/FA2.35/log-targets-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.35/log-target.yaml diff --git a/html/responses/FA2.35/policy-audit-file-get-response.yaml b/html/responses/FA2.35/policy-audit-file-get-response.yaml new file mode 100644 index 00000000..7345a421 --- /dev/null +++ b/html/responses/FA2.35/policy-audit-file-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.35/policy-audit-file-response.yaml diff --git a/html/responses/FA2.35/policy-audit-file-response.yaml b/html/responses/FA2.35/policy-audit-file-response.yaml new file mode 100644 index 00000000..f21b0f44 --- /dev/null +++ b/html/responses/FA2.35/policy-audit-file-response.yaml @@ -0,0 +1,8 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.35/policy-audit-file.yaml + description: Returns a list of all items after filtering. If applicable, the values + are displayed for each name. diff --git a/html/responses/FA2.35/support-get-response.yaml b/html/responses/FA2.35/support-get-response.yaml new file mode 100644 index 00000000..05ad7e7d --- /dev/null +++ b/html/responses/FA2.35/support-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.35/support-response.yaml diff --git a/html/responses/FA2.35/support-response.yaml b/html/responses/FA2.35/support-response.yaml new file mode 100644 index 00000000..1d8ab4fe --- /dev/null +++ b/html/responses/FA2.35/support-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.35/support.yaml diff --git a/html/responses/FA2.35/syslog-server-get-response.yaml b/html/responses/FA2.35/syslog-server-get-response.yaml new file mode 100644 index 00000000..e88d8fa2 --- /dev/null +++ b/html/responses/FA2.35/syslog-server-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.35/syslog-server-response.yaml diff --git a/html/responses/FA2.35/syslog-server-response.yaml b/html/responses/FA2.35/syslog-server-response.yaml new file mode 100644 index 00000000..a4fac8d5 --- /dev/null +++ b/html/responses/FA2.35/syslog-server-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.35/syslog-server.yaml diff --git a/html/responses/FA2.35/virtual-machine-volume-snapshot-response.yaml b/html/responses/FA2.35/virtual-machine-volume-snapshot-response.yaml new file mode 100644 index 00000000..40a0df6f --- /dev/null +++ b/html/responses/FA2.35/virtual-machine-volume-snapshot-response.yaml @@ -0,0 +1,9 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- properties: + items: + type: array + items: + $ref: ../../models/FA2.35/virtual-machine-volume-snapshot.yaml + description: Displays a list of all items after filtering. The values are displayed + for each name if meaningful. diff --git a/html/responses/FA2.36/admin-cache-get-response.yaml b/html/responses/FA2.36/admin-cache-get-response.yaml new file mode 100644 index 00000000..21d8fc5f --- /dev/null +++ b/html/responses/FA2.36/admin-cache-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/admin-cache-response.yaml diff --git a/html/responses/FA2.36/admin-cache-response.yaml b/html/responses/FA2.36/admin-cache-response.yaml new file mode 100644 index 00000000..2df3c3e9 --- /dev/null +++ b/html/responses/FA2.36/admin-cache-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/admin-cache.yaml diff --git a/html/responses/FA2.36/admin-get-response.yaml b/html/responses/FA2.36/admin-get-response.yaml new file mode 100644 index 00000000..0a7208ea --- /dev/null +++ b/html/responses/FA2.36/admin-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/admin-response.yaml diff --git a/html/responses/FA2.36/admin-response.yaml b/html/responses/FA2.36/admin-response.yaml new file mode 100644 index 00000000..69a873e2 --- /dev/null +++ b/html/responses/FA2.36/admin-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/admin.yaml diff --git a/html/responses/FA2.36/api-client-get-response.yaml b/html/responses/FA2.36/api-client-get-response.yaml new file mode 100644 index 00000000..71ac0879 --- /dev/null +++ b/html/responses/FA2.36/api-client-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/api-client-response.yaml diff --git a/html/responses/FA2.36/api-client-response.yaml b/html/responses/FA2.36/api-client-response.yaml new file mode 100644 index 00000000..71d0a042 --- /dev/null +++ b/html/responses/FA2.36/api-client-response.yaml @@ -0,0 +1,8 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/api-client.yaml + description: Returns a list of all items after filtering. The values are displayed + for each name, where meaningful. diff --git a/html/responses/FA2.36/certificate-certificate-group-get-response.yaml b/html/responses/FA2.36/certificate-certificate-group-get-response.yaml new file mode 100644 index 00000000..13ba3e36 --- /dev/null +++ b/html/responses/FA2.36/certificate-certificate-group-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/certificate-certificate-group-response.yaml diff --git a/html/responses/FA2.36/certificate-certificate-group-response.yaml b/html/responses/FA2.36/certificate-certificate-group-response.yaml new file mode 100644 index 00000000..85dcdf26 --- /dev/null +++ b/html/responses/FA2.36/certificate-certificate-group-response.yaml @@ -0,0 +1,7 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/_member-with-type.yaml + description: A list of certificate and certificate group relationships. diff --git a/html/responses/FA2.36/certificate-group-certificate-get-response.yaml b/html/responses/FA2.36/certificate-group-certificate-get-response.yaml new file mode 100644 index 00000000..af24de06 --- /dev/null +++ b/html/responses/FA2.36/certificate-group-certificate-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/certificate-group-certificate-response.yaml diff --git a/html/responses/FA2.36/certificate-group-certificate-response.yaml b/html/responses/FA2.36/certificate-group-certificate-response.yaml new file mode 100644 index 00000000..85dcdf26 --- /dev/null +++ b/html/responses/FA2.36/certificate-group-certificate-response.yaml @@ -0,0 +1,7 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/_member-with-type.yaml + description: A list of certificate and certificate group relationships. diff --git a/html/responses/FA2.36/certificate-group-get-response.yaml b/html/responses/FA2.36/certificate-group-get-response.yaml new file mode 100644 index 00000000..dc3c46b4 --- /dev/null +++ b/html/responses/FA2.36/certificate-group-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/certificate-group-response.yaml diff --git a/html/responses/FA2.36/certificate-group-response.yaml b/html/responses/FA2.36/certificate-group-response.yaml new file mode 100644 index 00000000..587197a3 --- /dev/null +++ b/html/responses/FA2.36/certificate-group-response.yaml @@ -0,0 +1,7 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/certificate-group.yaml + description: A list of certificate group objects. diff --git a/html/responses/FA2.36/container-performance-get-response.yaml b/html/responses/FA2.36/container-performance-get-response.yaml new file mode 100644 index 00000000..19d9571b --- /dev/null +++ b/html/responses/FA2.36/container-performance-get-response.yaml @@ -0,0 +1,17 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- type: object + properties: + items: + type: array + items: + $ref: ../../models/FA2.36/container-performance.yaml + description: Performance data. If `total_only=true`, the `items` list will be + empty. + total: + type: array + items: + $ref: ../../models/FA2.36/container-performance.yaml + description: The aggregate value of all items after filtering. When applicable, + the average value is displayed instead. If applicable, the values are displayed + for each field. diff --git a/html/responses/FA2.36/directory-service-role-get-response.yaml b/html/responses/FA2.36/directory-service-role-get-response.yaml new file mode 100644 index 00000000..dfed0fc2 --- /dev/null +++ b/html/responses/FA2.36/directory-service-role-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/directory-service-role-response.yaml diff --git a/html/responses/FA2.36/directory-service-role-response.yaml b/html/responses/FA2.36/directory-service-role-response.yaml new file mode 100644 index 00000000..3d827ede --- /dev/null +++ b/html/responses/FA2.36/directory-service-role-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/directory-service-role.yaml diff --git a/html/responses/FA2.36/fleet-get-response.yaml b/html/responses/FA2.36/fleet-get-response.yaml new file mode 100644 index 00000000..cfc5c028 --- /dev/null +++ b/html/responses/FA2.36/fleet-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/fleet-response.yaml diff --git a/html/responses/FA2.36/fleet-key-get-response.yaml b/html/responses/FA2.36/fleet-key-get-response.yaml new file mode 100644 index 00000000..a44f33d1 --- /dev/null +++ b/html/responses/FA2.36/fleet-key-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/fleet-key-response.yaml diff --git a/html/responses/FA2.36/fleet-key-response.yaml b/html/responses/FA2.36/fleet-key-response.yaml new file mode 100644 index 00000000..9358eab7 --- /dev/null +++ b/html/responses/FA2.36/fleet-key-response.yaml @@ -0,0 +1,7 @@ +type: object +properties: + items: + type: array + items: + allOf: + - $ref: ../../models/FA2.36/fleet-key.yaml diff --git a/html/responses/FA2.36/fleet-member-get-response.yaml b/html/responses/FA2.36/fleet-member-get-response.yaml new file mode 100644 index 00000000..71d94cb0 --- /dev/null +++ b/html/responses/FA2.36/fleet-member-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/fleet-member-response.yaml diff --git a/html/responses/FA2.36/fleet-member-response.yaml b/html/responses/FA2.36/fleet-member-response.yaml new file mode 100644 index 00000000..18b3d9e7 --- /dev/null +++ b/html/responses/FA2.36/fleet-member-response.yaml @@ -0,0 +1,8 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/fleet-member.yaml + description: Returns a list of all items after filtering. If applicable, the values + are displayed for each name. diff --git a/html/responses/FA2.36/fleet-response.yaml b/html/responses/FA2.36/fleet-response.yaml new file mode 100644 index 00000000..2614a82b --- /dev/null +++ b/html/responses/FA2.36/fleet-response.yaml @@ -0,0 +1,9 @@ +type: object +properties: + items: + type: array + items: + allOf: + - $ref: ../../models/FA2.36/fleet.yaml + description: Returns a list of all items after filtering. If applicable, the values + are displayed for each name. diff --git a/html/responses/FA2.36/host-get-response.yaml b/html/responses/FA2.36/host-get-response.yaml new file mode 100644 index 00000000..109c19c1 --- /dev/null +++ b/html/responses/FA2.36/host-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/host-response.yaml diff --git a/html/responses/FA2.36/host-group-get-response.yaml b/html/responses/FA2.36/host-group-get-response.yaml new file mode 100644 index 00000000..dfd748bb --- /dev/null +++ b/html/responses/FA2.36/host-group-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../FA2.36/host-group-response.yaml diff --git a/html/responses/FA2.36/host-group-response.yaml b/html/responses/FA2.36/host-group-response.yaml new file mode 100644 index 00000000..52062955 --- /dev/null +++ b/html/responses/FA2.36/host-group-response.yaml @@ -0,0 +1,8 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/host-group.yaml + description: Returns a list of all items after filtering. If applicable, the values + are displayed for each name. diff --git a/html/responses/FA2.36/host-response.yaml b/html/responses/FA2.36/host-response.yaml new file mode 100644 index 00000000..02448a97 --- /dev/null +++ b/html/responses/FA2.36/host-response.yaml @@ -0,0 +1,8 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/host.yaml + description: Returns a list of all items after filtering. If applicable, the values + are displayed for each name. diff --git a/html/responses/FA2.36/network-interface-performance-get-response.yaml b/html/responses/FA2.36/network-interface-performance-get-response.yaml new file mode 100644 index 00000000..96a50a3e --- /dev/null +++ b/html/responses/FA2.36/network-interface-performance-get-response.yaml @@ -0,0 +1,16 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- type: object + properties: + items: + type: array + items: + $ref: ../../models/FA2.36/network-interface-performance.yaml + description: A list of performance objects. + total: + type: array + items: + $ref: ../../models/FA2.36/network-interface-performance.yaml + description: The aggregate value of all items after filtering. Where it makes + more sense, the average value is displayed instead. The values are displayed + for each field where meaningful. diff --git a/html/responses/FA2.36/pod-get-response.yaml b/html/responses/FA2.36/pod-get-response.yaml new file mode 100644 index 00000000..dfa7519d --- /dev/null +++ b/html/responses/FA2.36/pod-get-response.yaml @@ -0,0 +1,11 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/pod-response.yaml +- properties: + total: + type: array + items: + $ref: ../../models/FA2.36/pod.yaml + description: The aggregate value of all items after filtering. When applicable, + the average value is displayed instead. If applicable, the values are displayed + for each field. diff --git a/html/responses/FA2.36/pod-member-get-response.yaml b/html/responses/FA2.36/pod-member-get-response.yaml new file mode 100644 index 00000000..40b53085 --- /dev/null +++ b/html/responses/FA2.36/pod-member-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: pod-member-response.yaml diff --git a/html/responses/FA2.36/pod-member-response.yaml b/html/responses/FA2.36/pod-member-response.yaml new file mode 100644 index 00000000..3ef548fe --- /dev/null +++ b/html/responses/FA2.36/pod-member-response.yaml @@ -0,0 +1,9 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/pod-member.yaml + description: Returns a list of all items after filtering. The values are displayed + for each name, where meaningful. If `total_only=true`, the `items` list will + be empty. diff --git a/html/responses/FA2.36/pod-response.yaml b/html/responses/FA2.36/pod-response.yaml new file mode 100644 index 00000000..4e2d1eed --- /dev/null +++ b/html/responses/FA2.36/pod-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/pod.yaml diff --git a/html/responses/FA2.36/policy-management-access-get-response.yaml b/html/responses/FA2.36/policy-management-access-get-response.yaml new file mode 100644 index 00000000..ab30575b --- /dev/null +++ b/html/responses/FA2.36/policy-management-access-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/policy-management-access-response.yaml diff --git a/html/responses/FA2.36/policy-management-access-response.yaml b/html/responses/FA2.36/policy-management-access-response.yaml new file mode 100644 index 00000000..beb54e78 --- /dev/null +++ b/html/responses/FA2.36/policy-management-access-response.yaml @@ -0,0 +1,8 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/policy-management-access.yaml + description: Displays a list of all items after filtering. If applicable, the + values are displayed for each name. diff --git a/html/responses/FA2.36/policy-member-clean-get-response.yaml b/html/responses/FA2.36/policy-member-clean-get-response.yaml new file mode 100644 index 00000000..cd9286bd --- /dev/null +++ b/html/responses/FA2.36/policy-member-clean-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/policy-member-clean-response.yaml diff --git a/html/responses/FA2.36/policy-member-clean-response.yaml b/html/responses/FA2.36/policy-member-clean-response.yaml new file mode 100644 index 00000000..b24176ae --- /dev/null +++ b/html/responses/FA2.36/policy-member-clean-response.yaml @@ -0,0 +1,8 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/policy-member-clean.yaml + description: Displays a list of all items after filtering. The values are displayed + for each name, if meaningful. diff --git a/html/responses/FA2.36/realm-get-response.yaml b/html/responses/FA2.36/realm-get-response.yaml new file mode 100644 index 00000000..f2fcd2c7 --- /dev/null +++ b/html/responses/FA2.36/realm-get-response.yaml @@ -0,0 +1,11 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.36/realm-response.yaml +- properties: + total: + type: array + items: + $ref: ../../models/FA2.36/realm.yaml + description: The aggregate value of all items after filtering. When applicable, + the average value is displayed instead. The values are displayed for each + field, if meaningful. diff --git a/html/responses/FA2.36/realm-response.yaml b/html/responses/FA2.36/realm-response.yaml new file mode 100644 index 00000000..9b4cea69 --- /dev/null +++ b/html/responses/FA2.36/realm-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/realm.yaml diff --git a/html/responses/FA2.36/realm-space-get-response.yaml b/html/responses/FA2.36/realm-space-get-response.yaml new file mode 100644 index 00000000..8d93a551 --- /dev/null +++ b/html/responses/FA2.36/realm-space-get-response.yaml @@ -0,0 +1,18 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- type: object + properties: + items: + type: array + items: + $ref: ../../models/FA2.36/resource-realm-space.yaml + description: Displays a list of all items after filtering. If applicable, the + values are displayed for each name. If `total_only=true`, the `items` list + will be empty. + total: + type: array + items: + $ref: ../../models/FA2.36/resource-realm-space.yaml + description: The aggregate value of all items after filtering. When applicable, + the average value is displayed instead. The values are displayed for each + field, if meaningful. diff --git a/html/responses/FA2.36/remote-arrays-response.yaml b/html/responses/FA2.36/remote-arrays-response.yaml new file mode 100644 index 00000000..a51889b8 --- /dev/null +++ b/html/responses/FA2.36/remote-arrays-response.yaml @@ -0,0 +1,10 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- type: object + properties: + items: + type: array + items: + $ref: ../../models/FA2.36/remote-array.yaml + description: Returns a list of all items after filtering. The values are displayed + for each name where meaningful. diff --git a/html/responses/FA2.36/support-diagnostics-details-get-response.yaml b/html/responses/FA2.36/support-diagnostics-details-get-response.yaml new file mode 100644 index 00000000..0a80ccbf --- /dev/null +++ b/html/responses/FA2.36/support-diagnostics-details-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../FA2.1/page-info.yaml +- $ref: support-diagnostics-details-response.yaml diff --git a/html/responses/FA2.36/support-diagnostics-details-response.yaml b/html/responses/FA2.36/support-diagnostics-details-response.yaml new file mode 100644 index 00000000..230b7474 --- /dev/null +++ b/html/responses/FA2.36/support-diagnostics-details-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/support-diagnostics-details.yaml diff --git a/html/responses/FA2.36/support-diagnostics-get-response.yaml b/html/responses/FA2.36/support-diagnostics-get-response.yaml new file mode 100644 index 00000000..db8208a1 --- /dev/null +++ b/html/responses/FA2.36/support-diagnostics-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../FA2.1/page-info.yaml +- $ref: support-diagnostics-response.yaml diff --git a/html/responses/FA2.36/support-diagnostics-response.yaml b/html/responses/FA2.36/support-diagnostics-response.yaml new file mode 100644 index 00000000..4e09bd38 --- /dev/null +++ b/html/responses/FA2.36/support-diagnostics-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.36/support-diagnostics-settings.yaml diff --git a/html/responses/FA2.37/directory-service-get-response.yaml b/html/responses/FA2.37/directory-service-get-response.yaml new file mode 100644 index 00000000..61264e35 --- /dev/null +++ b/html/responses/FA2.37/directory-service-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.37/directory-service-response.yaml diff --git a/html/responses/FA2.37/directory-service-response.yaml b/html/responses/FA2.37/directory-service-response.yaml new file mode 100644 index 00000000..1e6fd5db --- /dev/null +++ b/html/responses/FA2.37/directory-service-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.37/directory-service.yaml diff --git a/html/responses/FA2.37/protection-group-target-get-response.yaml b/html/responses/FA2.37/protection-group-target-get-response.yaml new file mode 100644 index 00000000..a45388dc --- /dev/null +++ b/html/responses/FA2.37/protection-group-target-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../../responses/FA2.1/page-info.yaml +- $ref: ../../responses/FA2.37/protection-group-target-response.yaml diff --git a/html/responses/FA2.37/protection-group-target-response.yaml b/html/responses/FA2.37/protection-group-target-response.yaml new file mode 100644 index 00000000..70f4a7a9 --- /dev/null +++ b/html/responses/FA2.37/protection-group-target-response.yaml @@ -0,0 +1,8 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.37/target-protection-group.yaml + description: Returns a list of all items after filtering. If applicable, the values + are displayed for each name. diff --git a/html/responses/FA2.37/software-installations-get-response.yaml b/html/responses/FA2.37/software-installations-get-response.yaml new file mode 100644 index 00000000..b94342a7 --- /dev/null +++ b/html/responses/FA2.37/software-installations-get-response.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../FA2.1/page-info.yaml +- $ref: software-installations-response.yaml diff --git a/html/responses/FA2.37/software-installations-response.yaml b/html/responses/FA2.37/software-installations-response.yaml new file mode 100644 index 00000000..0c13026c --- /dev/null +++ b/html/responses/FA2.37/software-installations-response.yaml @@ -0,0 +1,6 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FA2.37/software-installation.yaml diff --git a/html/responses/FB2.15/bucket-get-response.yaml b/html/responses/FB2.15/bucket-get-response.yaml new file mode 100644 index 00000000..fd02ee05 --- /dev/null +++ b/html/responses/FB2.15/bucket-get-response.yaml @@ -0,0 +1,6 @@ +allOf: +- $ref: ../../responses/FB2.0/page-info.yaml +- $ref: ../../responses/FB2.15/bucket-response.yaml +- properties: + total: + $ref: ../../models/FB2.15/bucket.yaml diff --git a/html/responses/FB2.15/bucket-response.yaml b/html/responses/FB2.15/bucket-response.yaml new file mode 100644 index 00000000..b39a4c80 --- /dev/null +++ b/html/responses/FB2.15/bucket-response.yaml @@ -0,0 +1,7 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FB2.15/bucket.yaml + description: A list of bucket objects. diff --git a/html/responses/FB2.15/object-store-account-get-response.yaml b/html/responses/FB2.15/object-store-account-get-response.yaml new file mode 100644 index 00000000..2875ab04 --- /dev/null +++ b/html/responses/FB2.15/object-store-account-get-response.yaml @@ -0,0 +1,10 @@ +allOf: +- $ref: ../../responses/FB2.0/page-info.yaml +- $ref: ../../responses/FB2.15/object-store-account-response.yaml +- properties: + total: + description: If `total_only` query param is `true`, then this field will be + a total of all records after filtering and no items will be returned. If `total_only` + is `false`, then it will be a total of all records on this page. + allOf: + - $ref: ../../models/FB2.15/object-store-account.yaml diff --git a/html/responses/FB2.15/object-store-account-response.yaml b/html/responses/FB2.15/object-store-account-response.yaml new file mode 100644 index 00000000..31ee5f9b --- /dev/null +++ b/html/responses/FB2.15/object-store-account-response.yaml @@ -0,0 +1,7 @@ +type: object +properties: + items: + type: array + items: + $ref: ../../models/FB2.15/object-store-account.yaml + description: A list of object store account objects. diff --git a/rest_extract/purest_download.py b/rest_extract/purest_download.py index e99dcbb8..d2a29d79 100644 --- a/rest_extract/purest_download.py +++ b/rest_extract/purest_download.py @@ -1,31 +1,36 @@ -import requests import yaml import json import queue import threading import os -import urllib import sys import argparse fb_max_version = { 0:0, 1:12, 2:15 } #this is a list of major:minor_max version pairs pure1_max_version = { 0:-1, 1:2 } -fa_2_max_version = { 2:35 } +fa_2_max_version = { 2:37 } thread_count = 8 -baseURL = 'http://purest.dev.purestorage.com' -spec_url = baseURL + '/pure-urls.js' +baseURL = '' +#spec_url = baseURL + '/pure-urls.js' +script_path = os.path.dirname(os.path.realpath(__file__)) +file_download_root = os.path.abspath(os.path.join(script_path,"../html")) + +source_dir_root = os.path.abspath(os.path.join(script_path, "../../purest")) +source_spec_file = os.path.abspath(os.path.join(source_dir_root, "doc_server", "custom_files", "pure-urls.js")) + cache = {} overwrite_local_files = False class SpecWorker(threading.Thread): - def __init__(self, s, q, file_download_root, io_lock, cache_lock): + def __init__(self, q, io_lock, cache_lock): threading.Thread.__init__(self, daemon=True) - self.s = s self.q = q - self.file_download_root = file_download_root self.io_lock = io_lock self.cache_lock = cache_lock + # Description: + # This function is a generator that will search a dictionary for a key and return the value. + def find(self, key, dictionary): for k, v in dictionary.items(): if k == key: @@ -46,20 +51,27 @@ def parse_spec(self, spec_dict): #Dowload and return the file - def get_spec_file(self, spec_url, head, model): + def get_spec_file(self, spec_url, head): + #global file_download_root, source_dir_root # figure out local path - url_parse_result = urllib.parse.urlparse(spec_url) - url_path = url_parse_result.path - url_path = url_path.replace("/purest","") #pull out the purest - #print(self.file_download_root) + #url_parse_result = spec_url + url_path = spec_url.replace("/purest", "") #pull out the purest + if url_path.startswith('/'): + url_path = url_path[1:] + print(url_path ) + #print(url_path) + source_path = os.path.join(source_dir_root, url_path) if head: - save_to_path = self.file_download_root + '/original_spec' + url_path + save_to_path = os.path.join(file_download_root, 'original_spec', url_path) else: - save_to_path = self.file_download_root + url_path + save_to_path = os.path.join(file_download_root, url_path) + + # print(f"source: {source_path}") + # print(f"saveto: {save_to_path}") # print("Spec URL:{} Local File:{}".format(spec_url,save_to_path)) # don't used cached file for head file. @@ -68,7 +80,7 @@ def get_spec_file(self, spec_url, head, model): # try and pull yaml file locally try: with self.io_lock: - with open(save_to_path,"r") as f: + with open(save_to_path, "r", encoding='utf-8') as f: spec_file = f.read() #print("Returning Local file") return spec_file @@ -79,13 +91,14 @@ def get_spec_file(self, spec_url, head, model): # file not found, lets download it # print("downloading spec ") try: - self.response = self.s.get(spec_url) + with self.io_lock: + with open(source_path, encoding='utf-8') as f: + spec_file = f.read() + #return spec_file except: - print(f"Unexpected error: getting URL: {spec_url}") + print(f"Unexpected error: getting URL: {source_path}") raise - - spec_file = self.response.text path, _ = os.path.split(save_to_path) os.makedirs(path, exist_ok=True) @@ -99,14 +112,13 @@ def get_spec_file(self, spec_url, head, model): spec_file = yaml.dump(spec_yaml, sort_keys=False) with self.io_lock: - with open(save_to_path,"w") as f: + with open(save_to_path,"w", encoding='utf-8') as f: f.write(spec_file) return spec_file def run(self): - global cache while True: item = self.q.get() @@ -121,10 +133,9 @@ def run(self): cache[spec_url] = 'working' head = item['head'] - model = item['model'] try: - spec_file = self.get_spec_file(spec_url, head, model) + spec_file = self.get_spec_file(spec_url, head) except: print("Unexpected error:", sys.exc_info()[0]) self.q.task_done() @@ -136,10 +147,13 @@ def run(self): #There is at least one file with .yaml extension, but is not yaml... if isinstance(spec_dict, dict): for rel_path in self.parse_spec(spec_dict): - new_abs_path = urllib.parse.urljoin(spec_url,rel_path) - + # we will pretend we on url paths like /purest/model/... + + full_path = os.path.join(os.path.dirname(spec_url), rel_path) + new_abs_path = os.path.abspath(full_path) + #print("source: {} rel: {} abs: {}".format(spec_url,rel_path,new_abs_path)) - self.q.put({'url':new_abs_path,'head':False, 'model':model }) + self.q.put({'url':new_abs_path, 'head':False }) else: print("Yaml file: {} does not appear to be yaml !".format(spec_url)) @@ -155,16 +169,20 @@ def main(): parser.add_argument("--overwrite-local-files", help="overwrite local files", action="store_true") args = parser.parse_args() + #print(file_download_root) + #print(source_dir_root) + #print(source_spec_file) + #return + if args.overwrite_local_files: overwrite_local_files = True - script_path = os.path.dirname(os.path.realpath(__file__)) - - file_download_root = os.path.abspath(os.path.join(script_path,"../html")) - s = requests.Session() q = queue.Queue() - resp = s.get(spec_url).text + + #resp = s.get(spec_url).text + with open(source_spec_file, encoding='utf-8') as f: + resp = f.read() #need to convert it from javascript to valid json #strip just the list: @@ -182,11 +200,11 @@ def main(): print(json_compat) raise - with open("fb_template.yaml") as f: + with open(os.path.join(script_path,"fb_template.yaml"), encoding='utf-8') as f: fb_template_yaml = yaml.safe_load(f) - with open("fa2_template.yaml") as f: + with open(os.path.join(script_path,"fa2_template.yaml"), encoding='utf-8') as f: fa_template_yaml = yaml.safe_load(f) - with open("pure1_template.yaml") as f: + with open(os.path.join(script_path,"pure1_template.yaml"), encoding='utf-8') as f: pure1_template_yaml = yaml.safe_load(f) for spec in spec_list: @@ -229,7 +247,7 @@ def main(): io_lock = threading.Lock() cache_lock = threading.Lock() for _ in range(thread_count): - t = SpecWorker(s,q,file_download_root,io_lock,cache_lock) + t = SpecWorker(q, io_lock, cache_lock) t.start() # wait till all threads finish From 97d81dee7d4b91e485503aecfaacd831cec99203 Mon Sep 17 00:00:00 2001 From: Matt Robertson Date: Tue, 26 Nov 2024 14:10:47 -0600 Subject: [PATCH 2/2] Force overwrite from repository --- html/models/FA2.1/_retention-policy.yaml | 14 +- html/models/FA2.1/_snapshot_schedule.yaml | 6 +- html/models/FA2.23/alert-rules-catalog.yaml | 5 +- .../FA2.32/policy-nfs-policy-mapping.yaml | 9 + html/models/FA2.32/policy-nfs.yaml | 12 +- html/models/FA2.32/policy-smb.yaml | 12 +- html/models/FB2.15/array-space.yaml | 9 +- html/models/FB2.15/file-system-post.yaml | 4 +- html/models/FB2.15/file-system.yaml | 7 +- html/paths/FB2.15/arrays-space.path.yaml | 3 + html/paths/FB2.15/file-systems.path.yaml | 3 +- html/queries/FA2.0/authorization.header.yaml | 6 +- html/queries/FA2.0/limit.query.yaml | 7 +- html/queries/FA2.0/offset.query.yaml | 7 +- html/queries/FB1.0/limit.query.yaml | 7 +- html/queries/FB1.0/start.query.yaml | 7 +- html/queries/FB2.0/limit.query.yaml | 7 +- .../Pure1-1.0/resource_types.query.yaml | 7 +- html/spec_index.yaml | 18 + html/specs/FA2.10.spec.yaml | 4 +- html/specs/FA2.11.spec.yaml | 6 +- html/specs/FA2.13.spec.yaml | 6 +- html/specs/FA2.14.spec.yaml | 6 +- html/specs/FA2.15.spec.yaml | 6 +- html/specs/FA2.16.spec.yaml | 6 +- html/specs/FA2.17.spec.yaml | 6 +- html/specs/FA2.19.spec.yaml | 6 +- html/specs/FA2.20.spec.yaml | 6 +- html/specs/FA2.21.spec.yaml | 6 +- html/specs/FA2.22.spec.yaml | 6 +- html/specs/FA2.23.spec.yaml | 6 +- html/specs/FA2.24.spec.yaml | 6 +- html/specs/FA2.25.spec.yaml | 6 +- html/specs/FA2.26.spec.yaml | 6 +- html/specs/FA2.27.spec.yaml | 6 +- html/specs/FA2.28.spec.yaml | 6 +- html/specs/FA2.29.spec.yaml | 6 +- html/specs/FA2.30.spec.yaml | 6 +- html/specs/FA2.31.spec.yaml | 6 +- html/specs/FA2.32.spec.yaml | 6 +- html/specs/FA2.33.spec.yaml | 6 +- html/specs/FA2.34.spec.yaml | 6 +- html/specs/FA2.35.spec.yaml | 1033 ++++++++++++++++ html/specs/FA2.36.spec.yaml | 1100 +++++++++++++++++ html/specs/FA2.37.spec.yaml | 1100 +++++++++++++++++ html/specs/FA2.4.spec.yaml | 4 +- html/specs/FA2.5.spec.yaml | 4 +- html/specs/FA2.6.spec.yaml | 4 +- html/specs/FA2.7.spec.yaml | 4 +- html/specs/FA2.8.spec.yaml | 4 +- html/specs/FA2.9.spec.yaml | 4 +- html/specs/FB2.15.spec.yaml | 44 +- html/specs/FB2.8.spec.yaml | 2 +- html/specs/Pure1-1.0.spec.yaml | 4 +- html/specs/Pure1-1.1.spec.yaml | 4 +- html/specs/Pure1-1.2.spec.yaml | 4 +- 56 files changed, 3412 insertions(+), 189 deletions(-) create mode 100644 html/models/FA2.32/policy-nfs-policy-mapping.yaml create mode 100644 html/specs/FA2.35.spec.yaml create mode 100644 html/specs/FA2.36.spec.yaml create mode 100644 html/specs/FA2.37.spec.yaml diff --git a/html/models/FA2.1/_retention-policy.yaml b/html/models/FA2.1/_retention-policy.yaml index 0c6f62b5..6811eb0f 100644 --- a/html/models/FA2.1/_retention-policy.yaml +++ b/html/models/FA2.1/_retention-policy.yaml @@ -3,24 +3,22 @@ type: object properties: all_for_sec: description: The length of time to keep the specified snapshots. Measured in seconds. + Prior to 6.8.2 the range of 60 to 34560000 is accepted. In 6.8.2 and onwards + the range of 60 to 2147483647 is accepted. type: integer format: int32 - min: 60 - max: 34560000 example: 86400 days: description: The number of days to keep the snapshots after the `all_for_sec` - period has passed. + period has passed. Prior to 6.6.4 the range of 0 to 4000 is accepted. In 6.6.4 + and onwards the range of 0 to 2147483647 is accepted. type: integer format: int32 - min: 0 - max: 4000 example: 7 per_day: description: The number of snapshots to keep per day after the `all_for_sec` period - has passed. + has passed. Prior to 6.8.2 the range of 0 to 1440 is accepted. In 6.8.2 and + onwards the range of 0 to 2147483647 is accepted. type: integer format: int32 - min: 0 - max: 1440 example: 3 diff --git a/html/models/FA2.1/_snapshot_schedule.yaml b/html/models/FA2.1/_snapshot_schedule.yaml index 69434577..b3a54213 100644 --- a/html/models/FA2.1/_snapshot_schedule.yaml +++ b/html/models/FA2.1/_snapshot_schedule.yaml @@ -3,14 +3,14 @@ type: object properties: at: description: The time of day the snapshot is scheduled to be taken and retained - on the local array or immediately replicated to the target(s). Measured in milliseconds + on the local array or immediately replicated to the target(s). Measured in seconds since midnight. The `at` value is only used if the `frequency` parameter is in days (e.g., `259200000`, which is equal to 3 days). type: integer format: int64 min: 0 - max: 86399000 - example: 7200000 + max: 86399 + example: 7200 enabled: description: If set to `true`, the policy is enabled. type: boolean diff --git a/html/models/FA2.23/alert-rules-catalog.yaml b/html/models/FA2.23/alert-rules-catalog.yaml index 80eb24c4..1f0a7e4e 100644 --- a/html/models/FA2.23/alert-rules-catalog.yaml +++ b/html/models/FA2.23/alert-rules-catalog.yaml @@ -21,6 +21,5 @@ allOf: example: Range 0-100 (must be equal to or lower than Warning Threshold) default_value: description: The system default values for the alert code and parameter. - type: integer - format: int32 - example: 80 + type: string + example: 80% diff --git a/html/models/FA2.32/policy-nfs-policy-mapping.yaml b/html/models/FA2.32/policy-nfs-policy-mapping.yaml new file mode 100644 index 00000000..fe77053e --- /dev/null +++ b/html/models/FA2.32/policy-nfs-policy-mapping.yaml @@ -0,0 +1,9 @@ +type: object +properties: + mapping: + description: The mapping of this policy. Valid values are `connected` and `disconnected`. + type: string + remote_policy: + description: The policy on the remote pod of the pod replica link for this policy + mapping. + type: string diff --git a/html/models/FA2.32/policy-nfs.yaml b/html/models/FA2.32/policy-nfs.yaml index 29bbf470..cd96df52 100644 --- a/html/models/FA2.32/policy-nfs.yaml +++ b/html/models/FA2.32/policy-nfs.yaml @@ -2,15 +2,7 @@ allOf: - $ref: ../../models/FA2.29/policy-nfs.yaml - properties: policy_mapping: - type: object - properties: - mapping: - description: The mapping of this policy. Valid values are `connected` and - `disconnected`. - type: string - remote_policy: - description: The policy on the remote pod of the pod replica link for this - policy mapping. - type: string description: Specifies the mapping of this policy across a pod replica link. If this policy is not inside a pod of a pod replica link, mapping is `null`. + allOf: + - $ref: ../../models/FA2.32/policy-nfs-policy-mapping.yaml diff --git a/html/models/FA2.32/policy-smb.yaml b/html/models/FA2.32/policy-smb.yaml index b08f94c0..423abed4 100644 --- a/html/models/FA2.32/policy-smb.yaml +++ b/html/models/FA2.32/policy-smb.yaml @@ -2,15 +2,7 @@ allOf: - $ref: ../../models/FA2.24/policy-smb.yaml - properties: policy_mapping: - type: object - properties: - mapping: - description: The mapping of this policy. Valid values are `connected` and - `disconnected`. - type: string - remote_policy: - description: The policy on the remote pod of the pod replica link for this - policy mapping. - type: string description: Specifies the mapping of this policy across a pod replica link. If this policy is not inside a pod of a pod replica link, mapping is `null`. + allOf: + - $ref: ../../models/FA2.32/policy-nfs-policy-mapping.yaml diff --git a/html/models/FB2.15/array-space.yaml b/html/models/FB2.15/array-space.yaml index 4da63528..133e6df7 100644 --- a/html/models/FB2.15/array-space.yaml +++ b/html/models/FB2.15/array-space.yaml @@ -3,11 +3,4 @@ allOf: - properties: space: allOf: - - $ref: ../../models/FB2.11/_space.yaml - - properties: - shared: - type: integer - readOnly: true - format: int64 - description: The space contributed by data that is not unique to a managed - directory, or snapshot, measured in bytes. + - $ref: ../../models/FB2.15/_space.yaml diff --git a/html/models/FB2.15/file-system-post.yaml b/html/models/FB2.15/file-system-post.yaml index 93a279ee..507fab2d 100644 --- a/html/models/FB2.15/file-system-post.yaml +++ b/html/models/FB2.15/file-system-post.yaml @@ -3,10 +3,10 @@ allOf: - properties: nfs: allOf: - - $ref: ../../models/FB2.15/_nfs.yaml + - $ref: ../../models/FB2.11/_nfs.yaml smb: allOf: - - $ref: ../../models/FB2.15/_smb-post.yaml + - $ref: ../../models/FB2.12/_smb-post.yaml eradication_config: allOf: - $ref: ../../models/FB2.15/_file-system-eradication-config.yaml diff --git a/html/models/FB2.15/file-system.yaml b/html/models/FB2.15/file-system.yaml index 11d3174f..0e4bc1f4 100644 --- a/html/models/FB2.15/file-system.yaml +++ b/html/models/FB2.15/file-system.yaml @@ -3,10 +3,13 @@ allOf: - properties: nfs: allOf: - - $ref: ../../models/FB2.15/_nfs.yaml + - $ref: ../../models/FB2.11/_nfs.yaml smb: allOf: - - $ref: ../../models/FB2.15/_smb.yaml + - $ref: ../../models/FB2.12/_smb.yaml eradication_config: allOf: - $ref: ../../models/FB2.15/_file-system-eradication-config.yaml + space: + allOf: + - $ref: ../../models/FB2.15/_space.yaml diff --git a/html/paths/FB2.15/arrays-space.path.yaml b/html/paths/FB2.15/arrays-space.path.yaml index 42eed4f4..067da763 100644 --- a/html/paths/FB2.15/arrays-space.path.yaml +++ b/html/paths/FB2.15/arrays-space.path.yaml @@ -2,6 +2,7 @@ get: summary: GET arrays/space description: List available and used storage space on the array. parameters: + - $ref: ../../queries/FB2.14/x-request-id.header.yaml - $ref: ../../queries/FB2.0/end_time.query.yaml - $ref: ../../queries/FB2.0/resolution.query.yaml - $ref: ../../queries/FB2.0/start_time.query.yaml @@ -9,6 +10,8 @@ get: responses: 200: description: OK + headers: + $ref: ../../responses/FB2.14/headers-all-default.response.yaml schema: $ref: ../../responses/FB2.15/array-space-get-response.yaml tags: diff --git a/html/paths/FB2.15/file-systems.path.yaml b/html/paths/FB2.15/file-systems.path.yaml index bda292fa..5bf28a44 100644 --- a/html/paths/FB2.15/file-systems.path.yaml +++ b/html/paths/FB2.15/file-systems.path.yaml @@ -26,7 +26,6 @@ post: description: Create a file system on the current array. parameters: - $ref: ../../queries/FB2.14/x-request-id.header.yaml - - $ref: ../../queries/FB2.15/default_exports.query.yaml - $ref: ../../queries/FB2.0/discard_non_snapshotted_data.query.yaml - $ref: ../../queries/FB2.0/names_required.query.yaml - $ref: ../../queries/FB2.0/overwrite.query.yaml @@ -78,7 +77,7 @@ patch: in: body required: true schema: - $ref: ../../models/FB2.15/file-system-patch.yaml + $ref: ../../models/FB2.13/file-system-patch.yaml responses: 200: description: OK diff --git a/html/queries/FA2.0/authorization.header.yaml b/html/queries/FA2.0/authorization.header.yaml index 185c9988..2d207372 100644 --- a/html/queries/FA2.0/authorization.header.yaml +++ b/html/queries/FA2.0/authorization.header.yaml @@ -1,5 +1,5 @@ -name: Authorization +description: 'Don''t use this field, use the Authorize button at top right side of + this page. ' in: header -description: Access token (in JWT format) required to use any API endpoint (except - `/oauth2`, `/login`, and `/logout`) +name: Authorization type: string diff --git a/html/queries/FA2.0/limit.query.yaml b/html/queries/FA2.0/limit.query.yaml index 8c2b65f9..de3dc3ff 100644 --- a/html/queries/FA2.0/limit.query.yaml +++ b/html/queries/FA2.0/limit.query.yaml @@ -1,11 +1,10 @@ -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. -type: integer format: int32 +in: query minimum: 1 -example: 10 +name: limit +type: integer diff --git a/html/queries/FA2.0/offset.query.yaml b/html/queries/FA2.0/offset.query.yaml index e0a62f0f..a652e540 100644 --- a/html/queries/FA2.0/offset.query.yaml +++ b/html/queries/FA2.0/offset.query.yaml @@ -1,8 +1,7 @@ -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. -type: integer format: int32 +in: query minimum: 0 -example: 10 +name: offset +type: integer diff --git a/html/queries/FB1.0/limit.query.yaml b/html/queries/FB1.0/limit.query.yaml index 8ff1031f..befc3d03 100644 --- a/html/queries/FB1.0/limit.query.yaml +++ b/html/queries/FB1.0/limit.query.yaml @@ -1,12 +1,11 @@ -name: limit -in: query description: Limit the size of the response to the specified number of resources. A `limit` of `0` can be used to get the number of resources without getting all of the resources. It will be returned in the `total_item_count` field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. -type: integer format: int32 +in: query minimum: 1 -example: 10 +name: limit +type: integer diff --git a/html/queries/FB1.0/start.query.yaml b/html/queries/FB1.0/start.query.yaml index 5dbf3629..3f5fd5e5 100644 --- a/html/queries/FB1.0/start.query.yaml +++ b/html/queries/FB1.0/start.query.yaml @@ -1,7 +1,6 @@ -name: start -in: query description: The offset of the first resource to return from a collection. -type: integer format: int32 +in: query minimum: 0 -example: 10 +name: start +type: integer diff --git a/html/queries/FB2.0/limit.query.yaml b/html/queries/FB2.0/limit.query.yaml index 8ff1031f..befc3d03 100644 --- a/html/queries/FB2.0/limit.query.yaml +++ b/html/queries/FB2.0/limit.query.yaml @@ -1,12 +1,11 @@ -name: limit -in: query description: Limit the size of the response to the specified number of resources. A `limit` of `0` can be used to get the number of resources without getting all of the resources. It will be returned in the `total_item_count` field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. -type: integer format: int32 +in: query minimum: 1 -example: 10 +name: limit +type: integer diff --git a/html/queries/Pure1-1.0/resource_types.query.yaml b/html/queries/Pure1-1.0/resource_types.query.yaml index f0d06afa..3db52fda 100644 --- a/html/queries/Pure1-1.0/resource_types.query.yaml +++ b/html/queries/Pure1-1.0/resource_types.query.yaml @@ -1,9 +1,10 @@ name: resource_types in: query description: The resource types to list the available metrics. Valid values are `arrays`, - `volumes`, and `pods`. A metric can belong to a combination of resources, e.g., - write-iops from array to pod. In that case, query by ['arrays', 'pods']. Single - quotes are required around all strings. + `buckets`, `directories`, `file-systems`, `pods`, `subscription-licenses` and `volumes`. + A metric can belong to a combination of resources, e.g., write-iops from array to + pod. In that case, query by ['arrays', 'pods']. Single quotes are required around + all strings. x-quoted: true type: array collectionFormat: csv diff --git a/html/spec_index.yaml b/html/spec_index.yaml index 68df149b..d93774c5 100644 --- a/html/spec_index.yaml +++ b/html/spec_index.yaml @@ -262,6 +262,24 @@ url: specs/FA2.34.spec.yaml version: '2.34' version_sort: 2034 +- filename: FA2.35.spec.yaml + model: FlashArray + name: FlashArray v2.35 + url: specs/FA2.35.spec.yaml + version: '2.35' + version_sort: 2035 +- filename: FA2.36.spec.yaml + model: FlashArray + name: FlashArray v2.36 + url: specs/FA2.36.spec.yaml + version: '2.36' + version_sort: 2036 +- filename: FA2.37.spec.yaml + model: FlashArray + name: FlashArray v2.37 + url: specs/FA2.37.spec.yaml + version: '2.37' + version_sort: 2037 - filename: FB1.0.spec.yaml model: FlashBlade name: FlashBlade v1.0 diff --git a/html/specs/FA2.10.spec.yaml b/html/specs/FA2.10.spec.yaml index 99bc7cd8..267551c6 100644 --- a/html/specs/FA2.10.spec.yaml +++ b/html/specs/FA2.10.spec.yaml @@ -169,11 +169,11 @@ definitions: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.11.spec.yaml b/html/specs/FA2.11.spec.yaml index 65ccbcb5..592bb15a 100644 --- a/html/specs/FA2.11.spec.yaml +++ b/html/specs/FA2.11.spec.yaml @@ -165,17 +165,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.13.spec.yaml b/html/specs/FA2.13.spec.yaml index 46958d3f..21117f37 100644 --- a/html/specs/FA2.13.spec.yaml +++ b/html/specs/FA2.13.spec.yaml @@ -165,17 +165,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.14.spec.yaml b/html/specs/FA2.14.spec.yaml index 0bcb1ff0..9b0340a7 100644 --- a/html/specs/FA2.14.spec.yaml +++ b/html/specs/FA2.14.spec.yaml @@ -165,17 +165,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.15.spec.yaml b/html/specs/FA2.15.spec.yaml index bddfa270..9ffba46a 100644 --- a/html/specs/FA2.15.spec.yaml +++ b/html/specs/FA2.15.spec.yaml @@ -169,17 +169,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.16.spec.yaml b/html/specs/FA2.16.spec.yaml index c90b025c..5a8e97d8 100644 --- a/html/specs/FA2.16.spec.yaml +++ b/html/specs/FA2.16.spec.yaml @@ -173,17 +173,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.17.spec.yaml b/html/specs/FA2.17.spec.yaml index 40e73378..e2074ff6 100644 --- a/html/specs/FA2.17.spec.yaml +++ b/html/specs/FA2.17.spec.yaml @@ -173,17 +173,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.19.spec.yaml b/html/specs/FA2.19.spec.yaml index 8d634252..84818d6e 100644 --- a/html/specs/FA2.19.spec.yaml +++ b/html/specs/FA2.19.spec.yaml @@ -175,17 +175,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.20.spec.yaml b/html/specs/FA2.20.spec.yaml index d899fc22..b116f4cc 100644 --- a/html/specs/FA2.20.spec.yaml +++ b/html/specs/FA2.20.spec.yaml @@ -175,17 +175,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.21.spec.yaml b/html/specs/FA2.21.spec.yaml index 04c65af3..fb33889e 100644 --- a/html/specs/FA2.21.spec.yaml +++ b/html/specs/FA2.21.spec.yaml @@ -183,17 +183,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.22.spec.yaml b/html/specs/FA2.22.spec.yaml index 6dfffe8e..cb75ce5b 100644 --- a/html/specs/FA2.22.spec.yaml +++ b/html/specs/FA2.22.spec.yaml @@ -185,17 +185,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.23.spec.yaml b/html/specs/FA2.23.spec.yaml index a7715b2a..01e31221 100644 --- a/html/specs/FA2.23.spec.yaml +++ b/html/specs/FA2.23.spec.yaml @@ -187,17 +187,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.24.spec.yaml b/html/specs/FA2.24.spec.yaml index b80395f9..5743ec35 100644 --- a/html/specs/FA2.24.spec.yaml +++ b/html/specs/FA2.24.spec.yaml @@ -187,17 +187,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.25.spec.yaml b/html/specs/FA2.25.spec.yaml index db0d3da9..66e3e77b 100644 --- a/html/specs/FA2.25.spec.yaml +++ b/html/specs/FA2.25.spec.yaml @@ -187,17 +187,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.26.spec.yaml b/html/specs/FA2.26.spec.yaml index 999056ab..776e0a5a 100644 --- a/html/specs/FA2.26.spec.yaml +++ b/html/specs/FA2.26.spec.yaml @@ -187,17 +187,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.27.spec.yaml b/html/specs/FA2.27.spec.yaml index c32520eb..a4c5f795 100644 --- a/html/specs/FA2.27.spec.yaml +++ b/html/specs/FA2.27.spec.yaml @@ -187,17 +187,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.28.spec.yaml b/html/specs/FA2.28.spec.yaml index 8fb2bf94..b4e10996 100644 --- a/html/specs/FA2.28.spec.yaml +++ b/html/specs/FA2.28.spec.yaml @@ -187,17 +187,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.29.spec.yaml b/html/specs/FA2.29.spec.yaml index 910308ea..c8a75298 100644 --- a/html/specs/FA2.29.spec.yaml +++ b/html/specs/FA2.29.spec.yaml @@ -191,17 +191,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.30.spec.yaml b/html/specs/FA2.30.spec.yaml index c0a6cfed..8f204aec 100644 --- a/html/specs/FA2.30.spec.yaml +++ b/html/specs/FA2.30.spec.yaml @@ -191,17 +191,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.31.spec.yaml b/html/specs/FA2.31.spec.yaml index cd21cf91..d0976abe 100644 --- a/html/specs/FA2.31.spec.yaml +++ b/html/specs/FA2.31.spec.yaml @@ -191,17 +191,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.32.spec.yaml b/html/specs/FA2.32.spec.yaml index 00c1893f..7ba30dca 100644 --- a/html/specs/FA2.32.spec.yaml +++ b/html/specs/FA2.32.spec.yaml @@ -193,17 +193,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.33.spec.yaml b/html/specs/FA2.33.spec.yaml index 68cca35f..2105a44c 100644 --- a/html/specs/FA2.33.spec.yaml +++ b/html/specs/FA2.33.spec.yaml @@ -193,17 +193,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.33/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.34.spec.yaml b/html/specs/FA2.34.spec.yaml index deff5a17..dd5a20bb 100644 --- a/html/specs/FA2.34.spec.yaml +++ b/html/specs/FA2.34.spec.yaml @@ -197,17 +197,17 @@ definitions: $ref: ../models/FA2.1/remote-volume-snapshot.yaml RemoteVolumeSnapshotTransfer: $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml - SAML2-SSO: + Saml2-sso: $ref: ../models/FA2.11/saml2-sso.yaml Session: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.33/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FA2.35.spec.yaml b/html/specs/FA2.35.spec.yaml new file mode 100644 index 00000000..ef34b245 --- /dev/null +++ b/html/specs/FA2.35.spec.yaml @@ -0,0 +1,1033 @@ +consumes: +- application/json +definitions: + ActiveDirectory: + $ref: ../models/FA2.15/active-directory.yaml + Admin: + $ref: ../models/FA2.32/admin.yaml + AdminApiToken: + $ref: ../models/FA2.2/admin-api-token.yaml + AdminCache: + $ref: ../models/FA2.2/admin-cache.yaml + AdminSettings: + $ref: ../models/FA2.32/admin-settings.yaml + Alert: + $ref: ../models/FA2.2/alert.yaml + AlertEvent: + $ref: ../models/FA2.2/alert-event.yaml + AlertRules: + $ref: ../models/FA2.23/alert-rules.yaml + AlertWatcher: + $ref: ../models/FA2.4/alert-watcher.yaml + ApiClient: + $ref: ../models/FA2.1/api-client.yaml + App: + $ref: ../models/FA2.2/app.yaml + AppNode: + $ref: ../models/FA2.2/app-node.yaml + Array: + $ref: ../models/FA2.34/arrays.yaml + ArrayConnection: + $ref: ../models/FA2.33/array-connection.yaml + ArrayConnectionKey: + $ref: ../models/FA2.4/array-connection-key.yaml + ArrayConnectionPath: + $ref: ../models/FA2.33/array-connection-path.yaml + ArrayErasures: + $ref: ../models/FA2.34/array-erasure.yaml + ArrayFactoryResetToken: + $ref: ../models/FA2.4/array-factory-reset-token.yaml + ArrayPerformance: + $ref: ../models/FA2.4/array-performance.yaml + ArrayPerformanceByLink: + $ref: ../models/FA2.19/array-performance-by-link.yaml + ArraySpace: + $ref: ../models/FA2.34/space.yaml + Audit: + $ref: ../models/FA2.2/audit.yaml + Certificate: + $ref: ../models/FA2.4/certificate.yaml + CloudCapacityStatus: + $ref: ../models/FA2.29/cloud-capacity-status.yaml + CloudCapacityStep: + $ref: ../models/FA2.29/cloud-capacity-step.yaml + CloudProviderTag: + $ref: ../models/FA2.6/cloud-provider-tag.yaml + Connection: + $ref: ../models/FA2.27/connection.yaml + ContainerDefaultProtection: + $ref: ../models/FA2.26/container-default-protection.yaml + Controllers: + $ref: ../models/FA2.30/controller.yaml + Directory: + $ref: ../models/FA2.34/directory.yaml + DirectoryExport: + $ref: ../models/FA2.32/directory-export.yaml + DirectoryLockNLMReclamation: + $ref: ../models/FA2.21/directory-lock-nlm-reclamation.yaml + DirectoryPerformance: + $ref: ../models/FA2.3/directory-performance.yaml + DirectoryQuota: + $ref: ../models/FA2.7/directory-quota.yaml + DirectoryService: + $ref: ../models/FA2.32/directory-service.yaml + DirectoryServiceRole: + $ref: ../models/FA2.30/directory-service-role.yaml + DirectorySnapshot: + $ref: ../models/FA2.34/directory-snapshot.yaml + DirectorySpace: + $ref: ../models/FA2.34/resource-directory-space.yaml + Dns: + $ref: ../models/FA2.15/dns.yaml + Drive: + $ref: ../models/FA2.4/drive.yaml + FileSystem: + $ref: ../models/FA2.13/file-system.yaml + Hardware: + $ref: ../models/FA2.2/hardware.yaml + Host: + $ref: ../models/FA2.34/host.yaml + HostGroup: + $ref: ../models/FA2.34/host-group.yaml + HostGroupPerformance: + $ref: ../models/FA2.4/resource-performance.yaml + HostGroupPerformanceByArray: + $ref: ../models/FA2.4/resource-performance-by-array.yaml + HostGroupSpace: + $ref: ../models/FA2.34/resource-space-no-id.yaml + HostPerformance: + $ref: ../models/FA2.4/resource-performance.yaml + HostPerformanceBalance: + $ref: ../models/FA2.4/host-performance-balance.yaml + HostPerformanceByArray: + $ref: ../models/FA2.4/resource-performance-by-array.yaml + HostSpace: + $ref: ../models/FA2.34/resource-space-no-id.yaml + Kmip: + $ref: ../models/FA2.24/kmip.yaml + KmipTestResult: + $ref: ../models/FA2.2/kmip-test-result.yaml + LocalGroup: + $ref: ../models/FA2.21/local-group.yaml + LocalMember: + $ref: ../models/FA2.21/local-member.yaml + LocalUser: + $ref: ../models/FA2.21/local-user.yaml + LogTarget: + $ref: ../models/FA2.35/log-target.yaml + LogTargetFile: + $ref: ../models/FA2.35/log-target-file.yaml + MaintenanceWindow: + $ref: ../models/FA2.2/maintenance-window.yaml + Member: + $ref: ../models/FA2.0/member.yaml + MemberNoIdAll: + $ref: ../models/FA2.0/member-no-id-all.yaml + MemberNoIdGroup: + $ref: ../models/FA2.1/member-no-id-group.yaml + NetworkInterface: + $ref: ../models/FA2.30/network-interface.yaml + NetworkInterfaceNeighbor: + $ref: ../models/FA2.22/network-interface-neighbor.yaml + NetworkInterfacePerformance: + $ref: ../models/FA2.4/network-interface-performance.yaml + NetworkInterfacePortDetails: + $ref: ../models/FA2.16/network-interfaces-port-details.yaml + Offload: + $ref: ../models/FA2.34/offload.yaml + Pod: + $ref: ../models/FA2.34/pod.yaml + PodPerformance: + $ref: ../models/FA2.13/pod-performance.yaml + PodPerformanceByArray: + $ref: ../models/FA2.13/pod-performance-by-array.yaml + PodPerformanceReplication: + $ref: ../models/FA2.4/pod-performance-replication.yaml + PodPerformanceReplicationByArray: + $ref: ../models/FA2.4/pod-performance-replication-by-array.yaml + PodReplicaLink: + $ref: ../models/FA2.2/pod-replica-link.yaml + PodReplicaLinkLag: + $ref: ../models/FA2.2/pod-replica-link-lag.yaml + PodReplicaLinkMappingPolicy: + $ref: ../models/FA2.32/mapping-policy.yaml + PodReplicaLinkPerformance: + $ref: ../models/FA2.2/pod-replica-link-performance-replication.yaml + PodSpace: + $ref: ../models/FA2.34/resource-pod-space.yaml + Policy: + $ref: ../models/FA2.24/policy.yaml + PolicyAuditFile: + $ref: ../models/FA2.35/policy-audit-file.yaml + PolicyMember: + $ref: ../models/FA2.21/policy-member.yaml + PolicyMemberExport: + $ref: ../models/FA2.32/policy-member-export.yaml + PolicyNfs: + $ref: ../models/FA2.32/policy-nfs.yaml + PolicyPassword: + $ref: ../models/FA2.34/policy-password.yaml + PolicyRuleNfsClient: + $ref: ../models/FA2.29/policy-rule-nfs-client.yaml + PolicyRuleQuota: + $ref: ../models/FA2.21/policy-rule-quota.yaml + PolicyRuleSmbClient: + $ref: ../models/FA2.21/policy-rule-smb-client.yaml + PolicyRuleSnapshot: + $ref: ../models/FA2.21/policy-rule-snapshot.yaml + PolicySmb: + $ref: ../models/FA2.32/policy-smb.yaml + Port: + $ref: ../models/FA2.2/port.yaml + PortInitiator: + $ref: ../models/FA2.2/port-initiator.yaml + ProtectionGroup: + $ref: ../models/FA2.34/protection-group.yaml + ProtectionGroupPerformance: + $ref: ../models/FA2.26/protection-group-performance.yaml + ProtectionGroupPerformanceByArray: + $ref: ../models/FA2.26/protection-group-performance-array.yaml + ProtectionGroupSnapshot: + $ref: ../models/FA2.34/protection-group-snapshot.yaml + ProtectionGroupSpace: + $ref: ../models/FA2.34/resource-space-no-id.yaml + ProtectionGroupTarget: + $ref: ../models/FA2.1/protection-group-target.yaml + RemoteProtectionGroup: + $ref: ../models/FA2.1/remote-protection-group.yaml + RemoteProtectionGroupSnapshot: + $ref: ../models/FA2.26/remote-protection-group-snapshot.yaml + RemoteProtectionGroupSnapshotTransfer: + $ref: ../models/FA2.26/remote-protection-group-snapshot-transfer.yaml + RemoteVolumeSnapshot: + $ref: ../models/FA2.1/remote-volume-snapshot.yaml + RemoteVolumeSnapshotTransfer: + $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml + Saml2-sso: + $ref: ../models/FA2.11/saml2-sso.yaml + Session: + $ref: ../models/FA2.4/session.yaml + Smis: + $ref: ../models/FA2.2/smis.yaml + SmtpServer: + $ref: ../models/FA2.33/smtp-server.yaml + SnmpAgent: + $ref: ../models/FA2.4/snmp-agent.yaml + SnmpManager: + $ref: ../models/FA2.4/snmp-manager.yaml + Software: + $ref: ../models/FA2.9/software.yaml + SoftwareBundle: + $ref: ../models/FA2.5/software-bundle.yaml + SoftwareChecks: + $ref: ../models/FA2.9/software-check.yaml + SoftwareInstallationSteps: + $ref: ../models/FA2.2/software-installation-step.yaml + SoftwareInstallations: + $ref: ../models/FA2.9/software-installation.yaml + SoftwarePatches: + $ref: ../models/FA2.29/software-patch.yaml + SoftwareVersions: + $ref: ../models/FA2.9/software-version.yaml + Subnet: + $ref: ../models/FA2.2/subnet.yaml + Subscription: + $ref: ../models/FA2.26/subscription.yaml + SubscriptionAsset: + $ref: ../models/FA2.26/subscription-asset.yaml + Support: + $ref: ../models/FA2.35/support.yaml + SyslogServer: + $ref: ../models/FA2.35/syslog-server.yaml + SyslogServerSettings: + $ref: ../models/FA2.9/syslog-server-settings.yaml + Tag: + $ref: ../models/FA2.2/tag.yaml + TestResult: + $ref: ../models/FA2.2/test-result.yaml + TestResultWithResource: + $ref: ../models/FA2.2/test-result-with-resource.yaml + Username: + $ref: ../models/FA2.0/username.yaml + Vchost: + $ref: ../models/FA2.26/vchost.yaml + VchostCertificate: + $ref: ../models/FA2.33/vchost-certificate.yaml + VchostConnection: + $ref: ../models/FA2.33/vchost-connection.yaml + VchostEndpoint: + $ref: ../models/FA2.33/vchost-endpoint.yaml + Volume: + $ref: ../models/FA2.34/volume.yaml + VolumeDiff: + $ref: ../models/FA2.9/volume-diff.yaml + VolumeGroup: + $ref: ../models/FA2.34/volume-group.yaml + VolumeGroupPerformance: + $ref: ../models/FA2.4/volume-group-performance.yaml + VolumeGroupSpace: + $ref: ../models/FA2.34/resource-space.yaml + VolumePerformance: + $ref: ../models/FA2.4/volume-performance.yaml + VolumePerformanceByArray: + $ref: ../models/FA2.4/resource-performance-by-array.yaml + VolumeSnapshot: + $ref: ../models/FA2.34/volume-snapshot.yaml + VolumeSnapshotTransfer: + $ref: ../models/FA2.1/volume-snapshot-transfer.yaml + VolumeSpace: + $ref: ../models/FA2.34/volume-space.yaml +info: + description: "## Pure Swagger UI for FlashArray\nA light weight tool to explore\ + \ the API for FlashArray, community supported. \nFor help with this tool, use\ + \ [Pure1 Community](https://community.purestorage.com/) or the [code-purestorage\ + \ Slack](https://community.purestorage.com/discussion/9561/join-the-new-pure-code-slack-team-for-api-and-extensibility-discussions)\n\ + \n## Authenticate using API Token\nTo get an API Key, you can do POST /auth/apitoken\ + \ with your user/pass using the 1.x API, then use your API key with POST /login.\ + \ The array returns \na header with the name \"x-auth-token\". This swagger\ + \ UI tool, translates that into a cookie so the webbrowser will send on subsequent\ + \ calls. This Swagger UI tool then\ntranslates that cookie back into a header\ + \ when making the API request to the array.\n\n## Authenticate using OAuth\n###\ + \ Manually generate an id_token \n\n### \n\nIntro to how OAuth2 works with the\ + \ 2.0 version: [Intro](https://support.purestorage.com/FlashArray/PurityFA/Purity_FA_REST_API/Reference/REST_API_2.0_Authentication_Guide)" + title: FlashArray REST API + version: '2.35' +paths: + /api/2.35/active-directory: + $ref: ../paths/FA2.15/active-directory.path.yaml + /api/2.35/admins: + $ref: ../paths/FA2.32/admins.path.yaml + /api/2.35/admins/api-tokens: + $ref: ../paths/FA2.2/admins-api-tokens.path.yaml + /api/2.35/admins/cache: + $ref: ../paths/FA2.2/admins-cache.path.yaml + /api/2.35/admins/settings: + $ref: ../paths/FA2.32/admin-settings.path.yaml + /api/2.35/alert-watchers: + $ref: ../paths/FA2.4/alert-watchers.path.yaml + /api/2.35/alert-watchers/test: + $ref: ../paths/FA2.4/alert-watchers-test.path.yaml + /api/2.35/alerts: + $ref: ../paths/FA2.2/alerts.path.yaml + /api/2.35/alerts/events: + $ref: ../paths/FA2.2/alerts-events.yaml + /api/2.35/alerts/rules: + $ref: ../paths/FA2.23/alert-rules.path.yaml + /api/2.35/alerts/rules/catalog: + $ref: ../paths/FA2.23/alert-rules-catalog.path.yaml + /api/2.35/api-clients: + $ref: ../paths/FA2.1/api-clients.path.yaml + /api/2.35/apps: + $ref: ../paths/FA2.2/apps.path.yaml + /api/2.35/apps/nodes: + $ref: ../paths/FA2.2/apps-nodes.path.yaml + /api/2.35/array-connections: + $ref: ../paths/FA2.33/array-connections.path.yaml + /api/2.35/array-connections/connection-key: + $ref: ../paths/FA2.33/array-connection-key.path.yaml + /api/2.35/array-connections/path: + $ref: ../paths/FA2.33/array-connections-path.path.yaml + /api/2.35/arrays: + $ref: ../paths/FA2.34/arrays.path.yaml + /api/2.35/arrays/cloud-capacity: + $ref: ../paths/FA2.29/arrays-cloud-capacity.path.yaml + /api/2.35/arrays/cloud-capacity/supported-steps: + $ref: ../paths/FA2.29/arrays-cloud-capacity-steps.path.yaml + /api/2.35/arrays/cloud-provider-tags: + $ref: ../paths/FA2.6/arrays-cloud-provider-tags.path.yaml + /api/2.35/arrays/cloud-provider-tags/batch: + $ref: ../paths/FA2.6/arrays-cloud-provider-tags-batch.path.yaml + /api/2.35/arrays/erasures: + $ref: ../paths/FA2.34/arrays-erasures.path.yaml + /api/2.35/arrays/eula: + $ref: ../paths/FA2.30/arrays-eula.path.yaml + /api/2.35/arrays/factory-reset-token: + $ref: ../paths/FA2.4/arrays-factory-reset-token.path.yaml + /api/2.35/arrays/ntp-test: + $ref: ../paths/FA2.2/arrays-ntp-test.path.yaml + /api/2.35/arrays/performance: + $ref: ../paths/FA2.4/arrays-performance.path.yaml + /api/2.35/arrays/performance/by-link: + $ref: ../paths/FA2.19/array-performance-by-link.path.yaml + /api/2.35/arrays/space: + $ref: ../paths/FA2.34/arrays-space.path.yaml + /api/2.35/arrays/tags: + $ref: ../paths/FA2.34/arrays-tags.path.yaml + /api/2.35/arrays/tags/batch: + $ref: ../paths/FA2.34/arrays-tags-batch.path.yaml + /api/2.35/audits: + $ref: ../paths/FA2.2/audits.path.yaml + /api/2.35/certificates: + $ref: ../paths/FA2.4/certificates.path.yaml + /api/2.35/certificates/certificate-signing-requests: + $ref: ../paths/FA2.4/certificate-signing-requests.path.yaml + /api/2.35/connections: + $ref: ../paths/FA2.27/connections.path.yaml + /api/2.35/container-default-protections: + $ref: ../paths/FA2.26/container-default-protections.path.yaml + /api/2.35/controllers: + $ref: ../paths/FA2.30/controllers.path.yaml + /api/2.35/directories: + $ref: ../paths/FA2.34/directories.path.yaml + /api/2.35/directories/locks/nlm-reclamations: + $ref: ../paths/FA2.21/directories-locks-nlm-reclamations.path.yaml + /api/2.35/directories/performance: + $ref: ../paths/FA2.3/directories-performance.path.yaml + /api/2.35/directories/policies: + $ref: ../paths/FA2.21/directories-policies.path.yaml + /api/2.35/directories/policies/audit-file: + $ref: ../paths/FA2.35/directories-policies-audit-file.path.yaml + /api/2.35/directories/policies/autodir: + $ref: ../paths/FA2.24/directories-policies-autodir.path.yaml + /api/2.35/directories/policies/nfs: + $ref: ../paths/FA2.32/directories-policies-nfs.path.yaml + /api/2.35/directories/policies/quota: + $ref: ../paths/FA2.21/directories-policies-quota.path.yaml + /api/2.35/directories/policies/smb: + $ref: ../paths/FA2.32/directories-policies-smb.path.yaml + /api/2.35/directories/policies/snapshot: + $ref: ../paths/FA2.21/directories-policies-snapshot.path.yaml + /api/2.35/directories/space: + $ref: ../paths/FA2.34/directories-space.path.yaml + /api/2.35/directory-exports: + $ref: ../paths/FA2.32/directory-exports.path.yaml + /api/2.35/directory-quotas: + $ref: ../paths/FA2.7/directory-quotas.path.yaml + /api/2.35/directory-services: + $ref: ../paths/FA2.32/directory-services.path.yaml + /api/2.35/directory-services/local/groups: + $ref: ../paths/FA2.21/local-groups.path.yaml + /api/2.35/directory-services/local/groups/members: + $ref: ../paths/FA2.21/local-groups-members.path.yaml + /api/2.35/directory-services/local/users: + $ref: ../paths/FA2.21/local-users.path.yaml + /api/2.35/directory-services/local/users/members: + $ref: ../paths/FA2.21/local-users-members.path.yaml + /api/2.35/directory-services/roles: + $ref: ../paths/FA2.30/directory-services-roles.path.yaml + /api/2.35/directory-services/test: + $ref: ../paths/FA2.2/directory-services-test.path.yaml + /api/2.35/directory-snapshots: + $ref: ../paths/FA2.34/directory-snapshots.path.yaml + /api/2.35/dns: + $ref: ../paths/FA2.15/dns.path.yaml + /api/2.35/drives: + $ref: ../paths/FA2.4/drives.path.yaml + /api/2.35/file-systems: + $ref: ../paths/FA2.13/file-systems.path.yaml + /api/2.35/files: + $ref: ../paths/FA2.26/files.path.yaml + /api/2.35/hardware: + $ref: ../paths/FA2.2/hardware.path.yaml + /api/2.35/host-groups: + $ref: ../paths/FA2.34/host-groups.path.yaml + /api/2.35/host-groups/hosts: + $ref: ../paths/FA2.1/host-groups-hosts-members.path.yaml + /api/2.35/host-groups/performance: + $ref: ../paths/FA2.16/host-groups-performance.path.yaml + /api/2.35/host-groups/performance/by-array: + $ref: ../paths/FA2.16/host-groups-performance-by-array.path.yaml + /api/2.35/host-groups/protection-groups: + $ref: ../paths/FA2.26/host-groups-protection-groups-members.path.yaml + /api/2.35/host-groups/space: + $ref: ../paths/FA2.34/host-groups-space.path.yaml + /api/2.35/host-groups/tags: + $ref: ../paths/FA2.34/host-groups-tags.path.yaml + /api/2.35/host-groups/tags/batch: + $ref: ../paths/FA2.34/host-groups-tags-batch.path.yaml + /api/2.35/hosts: + $ref: ../paths/FA2.34/hosts.path.yaml + /api/2.35/hosts/host-groups: + $ref: ../paths/FA2.1/hosts-host-groups-members.path.yaml + /api/2.35/hosts/performance: + $ref: ../paths/FA2.16/hosts-performance.path.yaml + /api/2.35/hosts/performance/balance: + $ref: ../paths/FA2.4/hosts-performance-balance.path.yaml + /api/2.35/hosts/performance/by-array: + $ref: ../paths/FA2.16/hosts-performance-by-array.path.yaml + /api/2.35/hosts/protection-groups: + $ref: ../paths/FA2.26/hosts-protection-groups-members.path.yaml + /api/2.35/hosts/space: + $ref: ../paths/FA2.34/hosts-space.path.yaml + /api/2.35/hosts/tags: + $ref: ../paths/FA2.34/hosts-tags.path.yaml + /api/2.35/hosts/tags/batch: + $ref: ../paths/FA2.34/hosts-tags-batch.path.yaml + /api/2.35/kmip: + $ref: ../paths/FA2.24/kmip.path.yaml + /api/2.35/kmip/test: + $ref: ../paths/FA2.2/kmip-test.path.yaml + /api/2.35/log-targets: + $ref: ../paths/FA2.35/log-targets.path.yaml + /api/2.35/log-targets/file: + $ref: ../paths/FA2.35/log-targets-file.path.yaml + /api/2.35/log-targets/syslog: + $ref: ../paths/FA2.35/log-targets-syslog.path.yaml + /api/2.35/log-targets/syslog/settings: + $ref: ../paths/FA2.35/log-targets-syslog-settings.path.yaml + /api/2.35/log-targets/syslog/test: + $ref: ../paths/FA2.35/log-targets-syslog-test.path.yaml + /api/2.35/login: + $ref: ../paths/FA2.0/login.path.yaml + /api/2.35/logout: + $ref: ../paths/FA2.0/logout.path.yaml + /api/2.35/maintenance-windows: + $ref: ../paths/FA2.2/maintenance-windows.path.yaml + /api/2.35/network-interfaces: + $ref: ../paths/FA2.30/network-interfaces.path.yaml + /api/2.35/network-interfaces/neighbors: + $ref: ../paths/FA2.22/network-interfaces-neighbors.path.yaml + /api/2.35/network-interfaces/performance: + $ref: ../paths/FA2.4/network-interfaces-performance.path.yaml + /api/2.35/network-interfaces/port-details: + $ref: ../paths/FA2.16/network-interfaces-port-details.path.yaml + /api/2.35/offloads: + $ref: ../paths/FA2.34/offloads.path.yaml + /api/2.35/pod-replica-links: + $ref: ../paths/FA2.2/pod-replica-links.path.yaml + /api/2.35/pod-replica-links/lag: + $ref: ../paths/FA2.2/pod-replica-links-lag.path.yaml + /api/2.35/pod-replica-links/mappings/policies: + $ref: ../paths/FA2.32/pod-replica-links-mappings-policies.yaml + /api/2.35/pod-replica-links/performance/replication: + $ref: ../paths/FA2.4/pod-replica-links-performance-replication.path.yaml + /api/2.35/pods: + $ref: ../paths/FA2.34/pods.path.yaml + /api/2.35/pods/arrays: + $ref: ../paths/FA2.1/pods-arrays-members.path.yaml + /api/2.35/pods/performance: + $ref: ../paths/FA2.13/pods-performance.path.yaml + /api/2.35/pods/performance/by-array: + $ref: ../paths/FA2.13/pods-performance-by-array.path.yaml + /api/2.35/pods/performance/replication: + $ref: ../paths/FA2.4/pods-performance-replication.path.yaml + /api/2.35/pods/performance/replication/by-array: + $ref: ../paths/FA2.4/pods-performance-replication-by-array.path.yaml + /api/2.35/pods/space: + $ref: ../paths/FA2.34/pods-space.path.yaml + /api/2.35/pods/test: + $ref: ../paths/FA2.31/pods-test.path.yaml + /api/2.35/policies: + $ref: ../paths/FA2.24/policies.path.yaml + /api/2.35/policies/alert-watcher: + $ref: ../paths/FA2.33/policies-alert-watcher.path.yaml + /api/2.35/policies/alert-watcher/members: + $ref: ../paths/FA2.33/policies-alert-watcher-members.path.yaml + /api/2.35/policies/alert-watcher/rules: + $ref: ../paths/FA2.33/policies-alert-watcher-rules.path.yaml + /api/2.35/policies/alert-watcher/rules/test: + $ref: ../paths/FA2.33/policy-alert-watcher-rule-test.path.yaml + /api/2.35/policies/audit-file: + $ref: ../paths/FA2.35/policies-audit-file.path.yaml + /api/2.35/policies/audit-file/members: + $ref: ../paths/FA2.35/policies-audit-file-members.path.yaml + /api/2.35/policies/autodir: + $ref: ../paths/FA2.24/policies-autodir.path.yaml + /api/2.35/policies/autodir/members: + $ref: ../paths/FA2.24/policies-autodir-members.path.yaml + /api/2.35/policies/members: + $ref: ../paths/FA2.21/policies-members.path.yaml + /api/2.35/policies/nfs: + $ref: ../paths/FA2.32/policies-nfs.path.yaml + /api/2.35/policies/nfs/client-rules: + $ref: ../paths/FA2.29/policies-nfs-client-rules.path.yaml + /api/2.35/policies/nfs/members: + $ref: ../paths/FA2.32/policies-nfs-members.path.yaml + /api/2.35/policies/password: + $ref: ../paths/FA2.34/policies-password.path.yaml + /api/2.35/policies/quota: + $ref: ../paths/FA2.24/policies-quota.path.yaml + /api/2.35/policies/quota/members: + $ref: ../paths/FA2.21/policies-quota-members.path.yaml + /api/2.35/policies/quota/rules: + $ref: ../paths/FA2.21/policies-quota-rules.path.yaml + /api/2.35/policies/smb: + $ref: ../paths/FA2.32/policies-smb.path.yaml + /api/2.35/policies/smb/client-rules: + $ref: ../paths/FA2.21/policies-smb-client-rules.path.yaml + /api/2.35/policies/smb/members: + $ref: ../paths/FA2.32/policies-smb-members.path.yaml + /api/2.35/policies/snapshot: + $ref: ../paths/FA2.24/policies-snapshot.path.yaml + /api/2.35/policies/snapshot/members: + $ref: ../paths/FA2.21/policies-snapshot-members.path.yaml + /api/2.35/policies/snapshot/rules: + $ref: ../paths/FA2.21/policies-snapshot-rules.path.yaml + /api/2.35/ports: + $ref: ../paths/FA2.2/ports.path.yaml + /api/2.35/ports/initiators: + $ref: ../paths/FA2.2/port-initiators.path.yaml + /api/2.35/protection-group-snapshots: + $ref: ../paths/FA2.34/protection-group-snapshots.path.yaml + /api/2.35/protection-group-snapshots/replica: + $ref: ../paths/FA2.34/protection-group-snapshots-replica.path.yaml + /api/2.35/protection-group-snapshots/test: + $ref: ../paths/FA2.34/protection-group-snapshots-test.path.yaml + /api/2.35/protection-group-snapshots/transfer: + $ref: ../paths/FA2.29/protection-group-snapshots-transfer.path.yaml + /api/2.35/protection-groups: + $ref: ../paths/FA2.34/protection-groups.path.yaml + /api/2.35/protection-groups/host-groups: + $ref: ../paths/FA2.26/protection-groups-host-groups-members.path.yaml + /api/2.35/protection-groups/hosts: + $ref: ../paths/FA2.26/protection-groups-hosts-members.path.yaml + /api/2.35/protection-groups/performance/replication: + $ref: ../paths/FA2.26/protection-groups-performance-replication.path.yaml + /api/2.35/protection-groups/performance/replication/by-array: + $ref: ../paths/FA2.26/protection-groups-performance-replication-by-array.path.yaml + /api/2.35/protection-groups/space: + $ref: ../paths/FA2.34/protection-groups-space.path.yaml + /api/2.35/protection-groups/targets: + $ref: ../paths/FA2.26/protection-groups-targets.path.yaml + /api/2.35/protection-groups/volumes: + $ref: ../paths/FA2.26/protection-groups-volumes-members.path.yaml + /api/2.35/remote-pods: + $ref: ../paths/FA2.1/remote-pods.path.yaml + /api/2.35/remote-protection-group-snapshots: + $ref: ../paths/FA2.26/remote-protection-group-snapshots.path.yaml + /api/2.35/remote-protection-group-snapshots/test: + $ref: ../paths/FA2.26/remote-protection-group-snapshots-test.path.yaml + /api/2.35/remote-protection-group-snapshots/transfer: + $ref: ../paths/FA2.26/remote-protection-group-snapshots-transfer.path.yaml + /api/2.35/remote-protection-groups: + $ref: ../paths/FA2.1/remote-protection-groups.path.yaml + /api/2.35/remote-volume-snapshots: + $ref: ../paths/FA2.28/remote-volume-snapshots.path.yaml + /api/2.35/remote-volume-snapshots/transfer: + $ref: ../paths/FA2.1/remote-volume-snapshots-transfer.path.yaml + /api/2.35/sessions: + $ref: ../paths/FA2.4/sessions.path.yaml + /api/2.35/smi-s: + $ref: ../paths/FA2.2/smis.path.yaml + /api/2.35/smtp-servers: + $ref: ../paths/FA2.33/smtp-server.path.yaml + /api/2.35/snmp-agents: + $ref: ../paths/FA2.4/snmp-agent.path.yaml + /api/2.35/snmp-agents/mib: + $ref: ../paths/FA2.4/snmp-agent-mib.path.yaml + /api/2.35/snmp-managers: + $ref: ../paths/FA2.4/snmp-manager.path.yaml + /api/2.35/snmp-managers/test: + $ref: ../paths/FA2.4/snmp-manager-test.path.yaml + /api/2.35/software: + $ref: ../paths/FA2.11/software.path.yaml + /api/2.35/software-bundle: + $ref: ../paths/FA2.5/software-bundle.path.yaml + /api/2.35/software-check: + $ref: ../paths/FA2.9/software-checks.path.yaml + /api/2.35/software-installation-steps: + $ref: ../paths/FA2.4/software-installation-steps.path.yaml + /api/2.35/software-installations: + $ref: ../paths/FA2.9/software-installations.path.yaml + /api/2.35/software-patches: + $ref: ../paths/FA2.29/software-patches.path.yaml + /api/2.35/software-patches/catalog: + $ref: ../paths/FA2.29/software-patches-catalog.path.yaml + /api/2.35/software-versions: + $ref: ../paths/FA2.9/software-versions.path.yaml + /api/2.35/sso/saml2/idps: + $ref: ../paths/FA2.11/saml2-sso.path.yaml + /api/2.35/sso/saml2/idps/test: + $ref: ../paths/FA2.11/saml2-sso-test.path.yaml + /api/2.35/subnets: + $ref: ../paths/FA2.2/subnets.path.yaml + /api/2.35/subscription-assets: + $ref: ../paths/FA2.26/subscription-assets.path.yaml + /api/2.35/subscriptions: + $ref: ../paths/FA2.26/subscriptions.path.yaml + /api/2.35/support: + $ref: ../paths/FA2.35/support.path.yaml + /api/2.35/support/test: + $ref: ../paths/FA2.2/support-test.path.yaml + /api/2.35/syslog-servers: + $ref: ../paths/FA2.35/syslog-servers.path.yaml + /api/2.35/syslog-servers/settings: + $ref: ../paths/FA2.9/syslog-servers-settings.path.yaml + /api/2.35/syslog-servers/test: + $ref: ../paths/FA2.4/syslog-servers-test.path.yaml + /api/2.35/vchost-connections: + $ref: ../paths/FA2.33/vchost-connections.path.yaml + /api/2.35/vchosts: + $ref: ../paths/FA2.26/vchosts.path.yaml + /api/2.35/vchosts/certificates: + $ref: ../paths/FA2.33/vchost-certificate.path.yaml + /api/2.35/vchosts/endpoints: + $ref: ../paths/FA2.33/vchost-endpoint.path.yaml + /api/2.35/virtual-machine-snapshots: + $ref: ../paths/FA2.14/virtual-machine-snapshots.path.yaml + /api/2.35/virtual-machine-volume-snapshots: + $ref: ../paths/FA2.35/virtual-machine-volume-snapshots.path.yaml + /api/2.35/virtual-machines: + $ref: ../paths/FA2.14/virtual-machines.path.yaml + /api/2.35/volume-groups: + $ref: ../paths/FA2.34/volume-groups.path.yaml + /api/2.35/volume-groups/performance: + $ref: ../paths/FA2.4/volume-groups-performance.path.yaml + /api/2.35/volume-groups/space: + $ref: ../paths/FA2.34/volume-groups-space.path.yaml + /api/2.35/volume-groups/volumes: + $ref: ../paths/FA2.1/volume-groups-volumes-members.path.yaml + /api/2.35/volume-snapshots: + $ref: ../paths/FA2.34/volume-snapshots.path.yaml + /api/2.35/volume-snapshots/tags: + $ref: ../paths/FA2.9/volume-snapshots-tags.path.yaml + /api/2.35/volume-snapshots/tags/batch: + $ref: ../paths/FA2.2/volume-snapshots-tags-batch.path.yaml + /api/2.35/volume-snapshots/test: + $ref: ../paths/FA2.25/volume-snapshots-test.path.yaml + /api/2.35/volume-snapshots/transfer: + $ref: ../paths/FA2.29/volume-snapshots-transfer.path.yaml + /api/2.35/volumes: + $ref: ../paths/FA2.34/volumes.path.yaml + /api/2.35/volumes/batch: + $ref: ../paths/FA2.34/volumes-batch.path.yaml + /api/2.35/volumes/batch/test: + $ref: ../paths/FA2.33/volumes-batch-test.path.yaml + /api/2.35/volumes/diff: + $ref: ../paths/FA2.9/volumes-diff.path.yaml + /api/2.35/volumes/performance: + $ref: ../paths/FA2.4/volumes-performance.path.yaml + /api/2.35/volumes/performance/by-array: + $ref: ../paths/FA2.4/volumes-performance-by-array.path.yaml + /api/2.35/volumes/protection-groups: + $ref: ../paths/FA2.26/volumes-protection-groups-members.path.yaml + /api/2.35/volumes/space: + $ref: ../paths/FA2.34/volumes-space.path.yaml + /api/2.35/volumes/tags: + $ref: ../paths/FA2.9/volumes-tags.path.yaml + /api/2.35/volumes/tags/batch: + $ref: ../paths/FA2.2/volumes-tags-batch.path.yaml + /api/2.35/volumes/test: + $ref: ../paths/FA2.33/volumes-test.path.yaml + /api/2.35/volumes/volume-groups: + $ref: ../paths/FA2.1/volumes-volume-groups-members.path.yaml + /api/api_version: + $ref: ../paths/FA2.0/api_version.path.yaml + /oauth2/1.0/token: + $ref: ../paths/TEx-v2/oauth-token.path.yaml + /oauth2_pub_priv_key_pair: + get: + description: "Returns a public and private key pair, This is not part of the\ + \ FlashArray API, \nit's a helper endpoint making it easier to generate an\ + \ oauth2 token_id in this Swagger UI. \nThey keys are generated in the Docker\ + \ container running on this machine.\n\nRecommend to NOT use this API but\ + \ to use OpenSSL instead for production use cases:\n You can generate a public\ + \ and private RSA key pair like this:\n\n openssl genrsa -des3 -out private.pem\ + \ 2048\n \n That generates a 2048-bit RSA key pair, encrypts them with\ + \ a password you provide and writes them to a file. \n You need to next\ + \ extract the public key file. You will use this, for instance, on your web\ + \ server to encrypt \n content so that it can only be read with the private\ + \ key.\n \n Export the RSA Public Key to a File\n This is a command\ + \ that is\n \n openssl rsa -in private.pem -outform PEM -pubout -out\ + \ public.pem" + responses: + 200: + description: Token Generated + schema: + properties: + private_key: + description: Private key in PEM format. + type: string + public_key: + description: Public key in PEM format. + type: string + type: object + tags: + - Auth Helpers + /oauth2_token_from_private_key: + post: + consumes: + - text/plain + description: "Authenticates to Flasharray, This returns a token_id (think session\ + \ id), from an existing API Client, \nThis is not part of the FlashArray API,\ + \ it's a helper endpoint making it easy to generate an \noauth2 token_id in\ + \ this Swagger UI. The private key is being passed into the Docker container\ + \ in\norder to sign the JWT token. Take a look at the Docker container output\ + \ to see more details \nof what is happening.\n\nCopy the output value, Authorization\ + \ header, and then click on the green Authorize button at the \ntop of the\ + \ page. Paste in the value into " + parameters: + - description: Issuer value displayed in the FlashArray API Registration page + or pureapiclient list ) by default it's the same name as API Client + in: header + name: issuer_name + type: string + - description: Client Id value displayed in the FlashArray API Registration + page or pureapiclient list + in: header + name: client_id + type: string + - description: Key Id value displayed in the FlashArray API Registration page + or pureapiclient list + in: header + name: key_id + type: string + - description: The name of a valid user on the FlashArray that will be authenticated + to. + in: header + name: username + type: string + - description: Private key in PEM format that was used to create the Public + key for this API Client specified as the issuer in this call. + in: body + name: private_key + required: true + schema: + type: string + produces: + - application/json + responses: + 200: + description: Token Generated + schema: + example: + username: pureuser + properties: + Authorization: + description: An OAuth bearer token to be used in the Authorization + header for authorization to API endpoints. + type: string + description: + desciption: How to use token + type: string + type: object + tags: + - Auth Helpers +produces: +- application/json +security: +- OAuth2-Bearer-Token: [] +- X-Auth-Token: [] +securityDefinitions: + OAuth2-Bearer-Token: + in: header + name: Authorization + type: apiKey + X-Auth-Token: + in: header + name: x-auth-token + type: apiKey +swagger: '2.0' +tags: +- description: A set of endpoints not in the Purity API, but to make OAuth using this + tool simple and easy to understand. + name: Auth Helpers +- description: Pure Storage uses the OAuth 2.0 Token Exchange authorization grant + and JSON Web Tokens (JWTs) to authenticate to the Pure Storage REST API. Before + you can exchange the ID token for an access token, create and enable the API client + to generate the `key_id`, `id`, and `issuer` values. These values will be used + as JWT claims for the `subject_token` parameter. + name: Authorization +- 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. + name: Active Directory +- description: The FlashArray has a single default administrative account named pureuser. + The administrator can add, delete, and modify administrators on the array. Administrator + roles may be assigned to user accounts including `array_admin`, `storage_admin`, + and `readonly`. + name: Administrators +- description: Alerts indicate significant events that occur on an array, including + whenever a component degrades or the capacity threshold of the component is reached. + name: Alerts +- description: Alert watchers receive email notifications when alerts occur on an + array. + name: Alert Watchers +- description: An API client represents an identity type. API clients are created + on the array. To create an API client, register and then enable it on the array. + After the API client has been created, the user name (`sub`) and identity tokens + (`kid` and `aud` tokens) that are issued by the API client are used as claims + for the JSON Web Token that you create to authenticate into the REST API. + name: API Clients +- description: Apps that extend array functionality can be integrated into the Purity//FA + operating system. + name: Apps +- description: Array features provide the ability to configure settings that affect + the operation of the array as a whole and monitor array I/O performance. + name: Arrays +- description: Manages connections between arrays. + name: Array Connections +- description: Audit trail records describe administrative actions performed by a + user to modify the configuration of an array. + name: Audits +- description: Purity//FA creates a self-signed certificate and private key when you + start the system for the first time. You can use the default certificate, change + the certificate attributes, create a new self-signed certificate, or import an + SSL certificate signed by a certificate authority. + name: Certificates +- description: A connection gives hosts access to volumes on the array. + name: Connections +- description: Default protection is a list of protection groups that are applied + to newly created volumes. Volumes can opt out of the default protection at creation. + The pod's `default_protections` defaults to the array's `default_protections` + at pod creation. Default protection can be configured on the array and the pod. + name: Container Default Protections +- description: Controller data includes the name, mode, FlashArray model, Purity//FA + software version, and status of each controller in the array. + name: Controllers +- description: Important file system directories should be set up as managed directories. + Managed directories can have policies attached to them. Managed directories differ + from standard directories in that they provide space reporting and metrics. + name: Directories +- description: Managed directory exports are created by adding NFS or SMB export policies + to managed directories. + name: Directory Exports +- description: Directory quotas provide the ability to set capacity limits on managed + directories. + name: Directory Quotas +- description: Manages directory service configurations for integration with LDAP + servers (e.g. Active Directory and OpenLDAP) in order to support various array + services. + name: Directory Services +- description: Directory snapshots are created manually or by adding snapshot policies + to managed directories. Each snapshot policy can be re-used for multiple directories. + name: Directory Snapshots +- description: DNS attributes include the domain suffix, static name servers, mode + (static or DHCP), and search domain. The configured attributes can be listed. + name: DNS +- description: Drive data includes the name, type, status, capacity, protocol and + other information for all flash, NVRAM, and cache modules in an array. + name: Drives +- description: A FlashArray can contain up to 24 separate file systems, each with + a number of directories that can be exported via supported protocols. Clients, + using Active Directory or LDAP, can connect and access these exports using SMB + or NFS. + name: File Systems +- description: Operational status is reported by most of the hardware components in + an array, including the chassis, controller, and storage shelf. + name: Hardware +- description: Host groups implement consistent connections between a set of hosts + and one or more volumes. Connections are consistent in the sense that all hosts + associated with a host group address a volume connected to the group by the same + LUN. Host groups are typically used to provide a common view of storage volumes + to the hosts in a clustered application. + name: Host Groups +- description: Hosts organize the storage network addresses (iSCSI Qualified Names, + NVMe qualified names, or Fibre Channel world wide names) of client computers to + identify the host's intiators. Hosts also control communications between clients + and volumes. After a volume has been created, establish a host-volume connection + so that the host can read data from and write data to the volume. + name: Hosts +- description: The Key Management Interoperability Protocol (KMIP) server is used + in combination with the Pure Storage Rapid Data Locking (RDL) feature and EncryptReduce + feature to further secure the encrypted data on a FlashArray. + name: KMIP +- description: Log Targets to be used to send management or data audit logs. + name: Log Targets +- description: During a maintenance window, alerts are suppressed that are related + to connections, paths, ports, and other resources that are down during maintenance. + name: Maintenance Windows +- description: Manages the interfaces and the network connection attributes of the + array. + name: Network Interfaces +- description: The offload feature enables system administrators to replicate point-in-time + volume snapshots from the array to an external storage system for long-term retention. + Each offload target represents an external storage system, such as an Azure Blob + container, NFS device, or S3 bucket, to where Purity//FA volume snapshots can + be replicated. + name: Offloads +- description: Synchronous replication is managed through pods. A pod representing + a collection of protection groups and volumes is created on one array and stretched + to another array, resulting in fully synchronized writes between the two arrays. + A pod can contain a mix of volumes, and protection groups with member volumes. + Writes to the pod coming into either array are immediately synchronized and seen + on both arrays. + name: Pods +- description: Pod replica links are created by associating a source pod with a demoted + pod, making the demoted pod the target pod of the source pod. The direction of + the replica link is from the promoted source pod to the demoted target pod. Replica + links can be created in either direction between the same two FlashArrays. The + target pod of a replica link cannot be on the same FlashArray as the source pod. + name: Pod Replica Links +- description: Policies are used to create exports (i.e., shares) and schedule snapshots. + NFS and SMB policies can be created and have one or more rules applied to them. + Each policy can be reused, creating exports for a number of managed directories. + name: Policies +- description: The ports on a FlashArray are assigned iSCSI Qualified Names (IQNs), + NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs). + name: Ports +- description: A protection group defines a set of volumes, hosts, or host groups + (called members) that are protected together through snapshots with point-in-time + consistency across the member volumes. The members within the protection group + have common data protection requirements and the same snapshot, replication, and + retention schedules. + name: Protection Groups +- description: Protection group snapshots capture the content of all volumes on the + source array for the specified protection group at a single point in time. + name: Protection Group Snapshots +- description: A remote pod represents a pod that is on a connected array but not + stretched to this array. + name: Remote Pods +- description: A remote protection group represents a protection group that resides + on an offload target with the source side of the remote protection group being + another array that is connected to the local array. The local array can only see + the remote protection groups of other arrays if the two arrays are connected. + name: Remote Protection Groups +- description: A remote protection group snapshot represents a protection group snapshot + that resides on an offload target with the source side of the remote protection + group snapshot being another array that is connected to the local array. The local + array can only see the remote protection group snapshots of other arrays if the + two arrays are connected. + name: Remote Protection Group Snapshots +- description: A remote volume snapshot represents a volume snapshot that resides + on an offload target with the source side of the remote volume snapshot being + another array that is connected to the local array. The local array can only see + the remote volume snapshots of other arrays if the two arrays are connected. + name: Remote Volume Snapshots +- description: SAML2 SSO allows customers to configure settings of SAML2 service provider + and identity provider. It provides a multi-factor authentication (MFA) mechanism + for customers to log in to FlashArray. + name: SAML2 SSO +- description: Manages Purity//FA login and user session data. + name: Sessions +- description: Manages the Pure Storage Storage Management Initiative Specification + (SMI-S). + name: SMI-S +- description: Manages connections to Simple Network Management Protocol (SMTP) managers. + name: SMTP +- description: Manages connections to Simple Network Management Protocol (SNMP) agents. + name: SNMP Agents +- description: Manages connections to Simple Network Management Protocol (SNMP) managers. + name: SNMP Managers +- description: Software to be installed on the array. + name: Software +- description: Manages the subnets and VLANs used to organize the network interfaces. + name: Subnets +- description: Provides information about subscription offerings. + name: Subscriptions +- description: Provides information about subscription assets. + name: Subscription Assets +- description: Enables Support to fix bugs and help customers solve problems. Support + tools include proxy, phonehome, and remote assist. + name: Support +- description: Copied to Log Targets/Syslog for more organized way to handle all log + targets. Both endpoints are identical. We encourage our users to use Log Targets/Syslog. + name: Syslog +- description: A vchost connection is between a protocol endpoint and vchost. In the + context of vchost-connection, the vchost represents a vCenter, and the protocol + endpoint is used to represent a storage container. Creating a vchost connection + gives the vCenter access to the storage container. If `all_vchosts` is set to + `true`, the container will be accessible to all vchosts. + name: Vchost Connections +- description: A volume represents a container that manages the storage space on the + array. After a volume has been created, host-volume connections must be established + so that the host can read data from and write data to the volume. Volume data + should be protected using asynchronous replication to a remote array, synchronous + replication between remote arrays, and replication to external storage systems. + name: Volumes +- description: Volume groups organize volumes into logical groupings. If virtual volumes + are configured, each volume group on the FlashArray array represents its associated + virtual machine, and inside each of those volumes groups are the FlashArray volumes + that are assigned to the virtual machine. Volume groups that are associated with + virtual machines have names that begin with `vvol-` and end with the virtual machine + name. + name: Volume Groups +- description: Volume snapshots are immutable, point-in-time images of the contents + of one or more volumes. There are two types of volume snapshots: volume snapshots + and protection group volume snapshots. A volume snapshot is a snapshot that captures + the contents of a single volume. A protection group volume snapshot is a volume + snapshot that is created from a group of volumes that are part of the same protection + group. All of the volume snapshots created from a protection group snapshot are + point-in-time consistent with each other. + name: Volume Snapshots diff --git a/html/specs/FA2.36.spec.yaml b/html/specs/FA2.36.spec.yaml new file mode 100644 index 00000000..654e2996 --- /dev/null +++ b/html/specs/FA2.36.spec.yaml @@ -0,0 +1,1100 @@ +consumes: +- application/json +definitions: + ActiveDirectory: + $ref: ../models/FA2.15/active-directory.yaml + Admin: + $ref: ../models/FA2.36/admin.yaml + AdminApiToken: + $ref: ../models/FA2.2/admin-api-token.yaml + AdminCache: + $ref: ../models/FA2.36/admin-cache.yaml + AdminSettings: + $ref: ../models/FA2.32/admin-settings.yaml + Alert: + $ref: ../models/FA2.2/alert.yaml + AlertEvent: + $ref: ../models/FA2.2/alert-event.yaml + AlertRules: + $ref: ../models/FA2.23/alert-rules.yaml + AlertWatcher: + $ref: ../models/FA2.4/alert-watcher.yaml + ApiClient: + $ref: ../models/FA2.36/api-client.yaml + App: + $ref: ../models/FA2.2/app.yaml + AppNode: + $ref: ../models/FA2.2/app-node.yaml + Array: + $ref: ../models/FA2.34/arrays.yaml + ArrayConnection: + $ref: ../models/FA2.33/array-connection.yaml + ArrayConnectionKey: + $ref: ../models/FA2.4/array-connection-key.yaml + ArrayConnectionPath: + $ref: ../models/FA2.33/array-connection-path.yaml + ArrayErasures: + $ref: ../models/FA2.34/array-erasure.yaml + ArrayFactoryResetToken: + $ref: ../models/FA2.4/array-factory-reset-token.yaml + ArrayPerformance: + $ref: ../models/FA2.4/array-performance.yaml + ArrayPerformanceByLink: + $ref: ../models/FA2.19/array-performance-by-link.yaml + ArraySpace: + $ref: ../models/FA2.34/space.yaml + Audit: + $ref: ../models/FA2.2/audit.yaml + Certificate: + $ref: ../models/FA2.4/certificate.yaml + CloudCapacityStatus: + $ref: ../models/FA2.29/cloud-capacity-status.yaml + CloudCapacityStep: + $ref: ../models/FA2.29/cloud-capacity-step.yaml + CloudProviderTag: + $ref: ../models/FA2.6/cloud-provider-tag.yaml + Connection: + $ref: ../models/FA2.27/connection.yaml + ContainerDefaultProtection: + $ref: ../models/FA2.26/container-default-protection.yaml + Controllers: + $ref: ../models/FA2.30/controller.yaml + Directory: + $ref: ../models/FA2.34/directory.yaml + DirectoryExport: + $ref: ../models/FA2.32/directory-export.yaml + DirectoryLockNLMReclamation: + $ref: ../models/FA2.21/directory-lock-nlm-reclamation.yaml + DirectoryPerformance: + $ref: ../models/FA2.3/directory-performance.yaml + DirectoryQuota: + $ref: ../models/FA2.7/directory-quota.yaml + DirectoryService: + $ref: ../models/FA2.32/directory-service.yaml + DirectoryServiceRole: + $ref: ../models/FA2.36/directory-service-role.yaml + DirectorySnapshot: + $ref: ../models/FA2.34/directory-snapshot.yaml + DirectorySpace: + $ref: ../models/FA2.34/resource-directory-space.yaml + Dns: + $ref: ../models/FA2.15/dns.yaml + Drive: + $ref: ../models/FA2.4/drive.yaml + FileSystem: + $ref: ../models/FA2.13/file-system.yaml + Fleet: + $ref: ../models/FA2.36/fleet.yaml + FleetKey: + $ref: ../models/FA2.36/fleet-key.yaml + FleetMember: + $ref: ../models/FA2.36/fleet-member.yaml + Hardware: + $ref: ../models/FA2.2/hardware.yaml + Host: + $ref: ../models/FA2.36/host.yaml + HostGroup: + $ref: ../models/FA2.36/host-group.yaml + HostGroupPerformance: + $ref: ../models/FA2.4/resource-performance.yaml + HostGroupPerformanceByArray: + $ref: ../models/FA2.4/resource-performance-by-array.yaml + HostGroupSpace: + $ref: ../models/FA2.34/resource-space-no-id.yaml + HostPerformance: + $ref: ../models/FA2.4/resource-performance.yaml + HostPerformanceBalance: + $ref: ../models/FA2.4/host-performance-balance.yaml + HostPerformanceByArray: + $ref: ../models/FA2.4/resource-performance-by-array.yaml + HostSpace: + $ref: ../models/FA2.34/resource-space-no-id.yaml + Kmip: + $ref: ../models/FA2.24/kmip.yaml + KmipTestResult: + $ref: ../models/FA2.2/kmip-test-result.yaml + LocalGroup: + $ref: ../models/FA2.21/local-group.yaml + LocalMember: + $ref: ../models/FA2.21/local-member.yaml + LocalUser: + $ref: ../models/FA2.21/local-user.yaml + LogTarget: + $ref: ../models/FA2.35/log-target.yaml + LogTargetFile: + $ref: ../models/FA2.35/log-target-file.yaml + MaintenanceWindow: + $ref: ../models/FA2.2/maintenance-window.yaml + Member: + $ref: ../models/FA2.0/member.yaml + MemberNoIdAll: + $ref: ../models/FA2.0/member-no-id-all.yaml + MemberNoIdGroup: + $ref: ../models/FA2.1/member-no-id-group.yaml + NetworkInterface: + $ref: ../models/FA2.30/network-interface.yaml + NetworkInterfaceNeighbor: + $ref: ../models/FA2.22/network-interface-neighbor.yaml + NetworkInterfacePerformance: + $ref: ../models/FA2.36/network-interface-performance.yaml + NetworkInterfacePortDetails: + $ref: ../models/FA2.16/network-interfaces-port-details.yaml + Offload: + $ref: ../models/FA2.34/offload.yaml + Pod: + $ref: ../models/FA2.36/pod.yaml + PodPerformance: + $ref: ../models/FA2.13/pod-performance.yaml + PodPerformanceByArray: + $ref: ../models/FA2.13/pod-performance-by-array.yaml + PodPerformanceReplication: + $ref: ../models/FA2.4/pod-performance-replication.yaml + PodPerformanceReplicationByArray: + $ref: ../models/FA2.4/pod-performance-replication-by-array.yaml + PodReplicaLink: + $ref: ../models/FA2.2/pod-replica-link.yaml + PodReplicaLinkLag: + $ref: ../models/FA2.2/pod-replica-link-lag.yaml + PodReplicaLinkMappingPolicy: + $ref: ../models/FA2.32/mapping-policy.yaml + PodReplicaLinkPerformance: + $ref: ../models/FA2.2/pod-replica-link-performance-replication.yaml + PodSpace: + $ref: ../models/FA2.34/resource-pod-space.yaml + Policy: + $ref: ../models/FA2.24/policy.yaml + PolicyAuditFile: + $ref: ../models/FA2.35/policy-audit-file.yaml + PolicyManagementAccess: + $ref: ../models/FA2.36/policy-management-access.yaml + PolicyManagementAccessEffective: + $ref: ../models/FA2.36/policy-management-access-effective.yaml + PolicyMember: + $ref: ../models/FA2.21/policy-member.yaml + PolicyMemberExport: + $ref: ../models/FA2.32/policy-member-export.yaml + PolicyNfs: + $ref: ../models/FA2.32/policy-nfs.yaml + PolicyPassword: + $ref: ../models/FA2.34/policy-password.yaml + PolicyRuleNfsClient: + $ref: ../models/FA2.29/policy-rule-nfs-client.yaml + PolicyRuleQuota: + $ref: ../models/FA2.21/policy-rule-quota.yaml + PolicyRuleSmbClient: + $ref: ../models/FA2.21/policy-rule-smb-client.yaml + PolicyRuleSnapshot: + $ref: ../models/FA2.21/policy-rule-snapshot.yaml + PolicySmb: + $ref: ../models/FA2.32/policy-smb.yaml + Port: + $ref: ../models/FA2.2/port.yaml + PortInitiator: + $ref: ../models/FA2.2/port-initiator.yaml + ProtectionGroup: + $ref: ../models/FA2.34/protection-group.yaml + ProtectionGroupPerformance: + $ref: ../models/FA2.26/protection-group-performance.yaml + ProtectionGroupPerformanceByArray: + $ref: ../models/FA2.26/protection-group-performance-array.yaml + ProtectionGroupSnapshot: + $ref: ../models/FA2.34/protection-group-snapshot.yaml + ProtectionGroupSpace: + $ref: ../models/FA2.34/resource-space-no-id.yaml + ProtectionGroupTarget: + $ref: ../models/FA2.1/protection-group-target.yaml + Realm: + $ref: ../models/FA2.36/realm.yaml + RealmPerformance: + $ref: ../models/FA2.36/container-performance.yaml + RealmSpace: + $ref: ../models/FA2.36/resource-realm-space.yaml + RemoteArray: + $ref: ../models/FA2.36/remote-array.yaml + RemoteProtectionGroup: + $ref: ../models/FA2.1/remote-protection-group.yaml + RemoteProtectionGroupSnapshot: + $ref: ../models/FA2.26/remote-protection-group-snapshot.yaml + RemoteProtectionGroupSnapshotTransfer: + $ref: ../models/FA2.26/remote-protection-group-snapshot-transfer.yaml + RemoteVolumeSnapshot: + $ref: ../models/FA2.1/remote-volume-snapshot.yaml + RemoteVolumeSnapshotTransfer: + $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml + Saml2-sso: + $ref: ../models/FA2.11/saml2-sso.yaml + Session: + $ref: ../models/FA2.4/session.yaml + Smis: + $ref: ../models/FA2.2/smis.yaml + SmtpServer: + $ref: ../models/FA2.33/smtp-server.yaml + SnmpAgent: + $ref: ../models/FA2.4/snmp-agent.yaml + SnmpManager: + $ref: ../models/FA2.4/snmp-manager.yaml + Software: + $ref: ../models/FA2.9/software.yaml + SoftwareBundle: + $ref: ../models/FA2.5/software-bundle.yaml + SoftwareChecks: + $ref: ../models/FA2.9/software-check.yaml + SoftwareInstallationSteps: + $ref: ../models/FA2.2/software-installation-step.yaml + SoftwareInstallations: + $ref: ../models/FA2.9/software-installation.yaml + SoftwarePatches: + $ref: ../models/FA2.29/software-patch.yaml + SoftwareVersions: + $ref: ../models/FA2.9/software-version.yaml + Subnet: + $ref: ../models/FA2.2/subnet.yaml + Subscription: + $ref: ../models/FA2.26/subscription.yaml + SubscriptionAsset: + $ref: ../models/FA2.26/subscription-asset.yaml + Support: + $ref: ../models/FA2.35/support.yaml + SupportDiagnosticsDetails: + $ref: ../models/FA2.36/support-diagnostics-details.yaml + SupportDiagnosticsSettings: + $ref: ../models/FA2.36/support-diagnostics-settings.yaml + SyslogServer: + $ref: ../models/FA2.35/syslog-server.yaml + SyslogServerSettings: + $ref: ../models/FA2.9/syslog-server-settings.yaml + Tag: + $ref: ../models/FA2.2/tag.yaml + TestResult: + $ref: ../models/FA2.2/test-result.yaml + TestResultWithResource: + $ref: ../models/FA2.2/test-result-with-resource.yaml + Username: + $ref: ../models/FA2.0/username.yaml + Vchost: + $ref: ../models/FA2.26/vchost.yaml + VchostCertificate: + $ref: ../models/FA2.33/vchost-certificate.yaml + VchostConnection: + $ref: ../models/FA2.33/vchost-connection.yaml + VchostEndpoint: + $ref: ../models/FA2.33/vchost-endpoint.yaml + Volume: + $ref: ../models/FA2.34/volume.yaml + VolumeDiff: + $ref: ../models/FA2.9/volume-diff.yaml + VolumeGroup: + $ref: ../models/FA2.34/volume-group.yaml + VolumeGroupPerformance: + $ref: ../models/FA2.4/volume-group-performance.yaml + VolumeGroupSpace: + $ref: ../models/FA2.34/resource-space.yaml + VolumePerformance: + $ref: ../models/FA2.4/volume-performance.yaml + VolumePerformanceByArray: + $ref: ../models/FA2.4/resource-performance-by-array.yaml + VolumeSnapshot: + $ref: ../models/FA2.34/volume-snapshot.yaml + VolumeSnapshotTransfer: + $ref: ../models/FA2.1/volume-snapshot-transfer.yaml + VolumeSpace: + $ref: ../models/FA2.34/volume-space.yaml +info: + description: "## Pure Swagger UI for FlashArray\nA light weight tool to explore\ + \ the API for FlashArray, community supported. \nFor help with this tool, use\ + \ [Pure1 Community](https://community.purestorage.com/) or the [code-purestorage\ + \ Slack](https://community.purestorage.com/discussion/9561/join-the-new-pure-code-slack-team-for-api-and-extensibility-discussions)\n\ + \n## Authenticate using API Token\nTo get an API Key, you can do POST /auth/apitoken\ + \ with your user/pass using the 1.x API, then use your API key with POST /login.\ + \ The array returns \na header with the name \"x-auth-token\". This swagger\ + \ UI tool, translates that into a cookie so the webbrowser will send on subsequent\ + \ calls. This Swagger UI tool then\ntranslates that cookie back into a header\ + \ when making the API request to the array.\n\n## Authenticate using OAuth\n###\ + \ Manually generate an id_token \n\n### \n\nIntro to how OAuth2 works with the\ + \ 2.0 version: [Intro](https://support.purestorage.com/FlashArray/PurityFA/Purity_FA_REST_API/Reference/REST_API_2.0_Authentication_Guide)" + title: FlashArray REST API + version: '2.36' +paths: + /api/2.36/active-directory: + $ref: ../paths/FA2.15/active-directory.path.yaml + /api/2.36/admins: + $ref: ../paths/FA2.36/admins.path.yaml + /api/2.36/admins/api-tokens: + $ref: ../paths/FA2.2/admins-api-tokens.path.yaml + /api/2.36/admins/cache: + $ref: ../paths/FA2.36/admins-cache.path.yaml + /api/2.36/admins/policies/management-access: + $ref: ../paths/FA2.36/admin-policies-access.path.yaml + /api/2.36/admins/settings: + $ref: ../paths/FA2.32/admin-settings.path.yaml + /api/2.36/alert-watchers: + $ref: ../paths/FA2.4/alert-watchers.path.yaml + /api/2.36/alert-watchers/test: + $ref: ../paths/FA2.4/alert-watchers-test.path.yaml + /api/2.36/alerts: + $ref: ../paths/FA2.2/alerts.path.yaml + /api/2.36/alerts/events: + $ref: ../paths/FA2.2/alerts-events.yaml + /api/2.36/alerts/rules: + $ref: ../paths/FA2.23/alert-rules.path.yaml + /api/2.36/alerts/rules/catalog: + $ref: ../paths/FA2.23/alert-rules-catalog.path.yaml + /api/2.36/api-clients: + $ref: ../paths/FA2.36/api-clients.path.yaml + /api/2.36/apps: + $ref: ../paths/FA2.2/apps.path.yaml + /api/2.36/apps/nodes: + $ref: ../paths/FA2.2/apps-nodes.path.yaml + /api/2.36/array-connections: + $ref: ../paths/FA2.33/array-connections.path.yaml + /api/2.36/array-connections/connection-key: + $ref: ../paths/FA2.33/array-connection-key.path.yaml + /api/2.36/array-connections/path: + $ref: ../paths/FA2.33/array-connections-path.path.yaml + /api/2.36/arrays: + $ref: ../paths/FA2.34/arrays.path.yaml + /api/2.36/arrays/cloud-capacity: + $ref: ../paths/FA2.29/arrays-cloud-capacity.path.yaml + /api/2.36/arrays/cloud-capacity/supported-steps: + $ref: ../paths/FA2.29/arrays-cloud-capacity-steps.path.yaml + /api/2.36/arrays/cloud-provider-tags: + $ref: ../paths/FA2.6/arrays-cloud-provider-tags.path.yaml + /api/2.36/arrays/cloud-provider-tags/batch: + $ref: ../paths/FA2.6/arrays-cloud-provider-tags-batch.path.yaml + /api/2.36/arrays/erasures: + $ref: ../paths/FA2.34/arrays-erasures.path.yaml + /api/2.36/arrays/eula: + $ref: ../paths/FA2.30/arrays-eula.path.yaml + /api/2.36/arrays/factory-reset-token: + $ref: ../paths/FA2.4/arrays-factory-reset-token.path.yaml + /api/2.36/arrays/ntp-test: + $ref: ../paths/FA2.2/arrays-ntp-test.path.yaml + /api/2.36/arrays/performance: + $ref: ../paths/FA2.4/arrays-performance.path.yaml + /api/2.36/arrays/performance/by-link: + $ref: ../paths/FA2.19/array-performance-by-link.path.yaml + /api/2.36/arrays/space: + $ref: ../paths/FA2.34/arrays-space.path.yaml + /api/2.36/arrays/tags: + $ref: ../paths/FA2.34/arrays-tags.path.yaml + /api/2.36/arrays/tags/batch: + $ref: ../paths/FA2.34/arrays-tags-batch.path.yaml + /api/2.36/audits: + $ref: ../paths/FA2.2/audits.path.yaml + /api/2.36/certificate-groups: + $ref: ../paths/FA2.36/certificate-groups.path.yaml + /api/2.36/certificate-groups/certificates: + $ref: ../paths/FA2.36/certificate-groups-certificates.path.yaml + /api/2.36/certificates: + $ref: ../paths/FA2.4/certificates.path.yaml + /api/2.36/certificates/certificate-groups: + $ref: ../paths/FA2.36/certificates-certificate-groups.path.yaml + /api/2.36/certificates/certificate-signing-requests: + $ref: ../paths/FA2.4/certificate-signing-requests.path.yaml + /api/2.36/connections: + $ref: ../paths/FA2.27/connections.path.yaml + /api/2.36/container-default-protections: + $ref: ../paths/FA2.26/container-default-protections.path.yaml + /api/2.36/controllers: + $ref: ../paths/FA2.30/controllers.path.yaml + /api/2.36/directories: + $ref: ../paths/FA2.34/directories.path.yaml + /api/2.36/directories/locks/nlm-reclamations: + $ref: ../paths/FA2.21/directories-locks-nlm-reclamations.path.yaml + /api/2.36/directories/performance: + $ref: ../paths/FA2.3/directories-performance.path.yaml + /api/2.36/directories/policies: + $ref: ../paths/FA2.21/directories-policies.path.yaml + /api/2.36/directories/policies/audit-file: + $ref: ../paths/FA2.35/directories-policies-audit-file.path.yaml + /api/2.36/directories/policies/autodir: + $ref: ../paths/FA2.24/directories-policies-autodir.path.yaml + /api/2.36/directories/policies/nfs: + $ref: ../paths/FA2.32/directories-policies-nfs.path.yaml + /api/2.36/directories/policies/quota: + $ref: ../paths/FA2.21/directories-policies-quota.path.yaml + /api/2.36/directories/policies/smb: + $ref: ../paths/FA2.32/directories-policies-smb.path.yaml + /api/2.36/directories/policies/snapshot: + $ref: ../paths/FA2.21/directories-policies-snapshot.path.yaml + /api/2.36/directories/space: + $ref: ../paths/FA2.34/directories-space.path.yaml + /api/2.36/directory-exports: + $ref: ../paths/FA2.32/directory-exports.path.yaml + /api/2.36/directory-quotas: + $ref: ../paths/FA2.7/directory-quotas.path.yaml + /api/2.36/directory-services: + $ref: ../paths/FA2.32/directory-services.path.yaml + /api/2.36/directory-services/local/groups: + $ref: ../paths/FA2.21/local-groups.path.yaml + /api/2.36/directory-services/local/groups/members: + $ref: ../paths/FA2.21/local-groups-members.path.yaml + /api/2.36/directory-services/local/users: + $ref: ../paths/FA2.21/local-users.path.yaml + /api/2.36/directory-services/local/users/members: + $ref: ../paths/FA2.21/local-users-members.path.yaml + /api/2.36/directory-services/roles: + $ref: ../paths/FA2.36/directory-services-roles.path.yaml + /api/2.36/directory-services/roles/policies/management-access: + $ref: ../paths/FA2.36/directory-services-roles-policies.path.yaml + /api/2.36/directory-services/test: + $ref: ../paths/FA2.2/directory-services-test.path.yaml + /api/2.36/directory-snapshots: + $ref: ../paths/FA2.34/directory-snapshots.path.yaml + /api/2.36/dns: + $ref: ../paths/FA2.15/dns.path.yaml + /api/2.36/drives: + $ref: ../paths/FA2.4/drives.path.yaml + /api/2.36/file-systems: + $ref: ../paths/FA2.13/file-systems.path.yaml + /api/2.36/files: + $ref: ../paths/FA2.26/files.path.yaml + /api/2.36/fleets: + $ref: ../paths/FA2.36/fleets.path.yaml + /api/2.36/fleets/fleet-key: + $ref: ../paths/FA2.36/fleet-key.path.yaml + /api/2.36/fleets/members: + $ref: ../paths/FA2.36/fleet-members.path.yaml + /api/2.36/hardware: + $ref: ../paths/FA2.2/hardware.path.yaml + /api/2.36/host-groups: + $ref: ../paths/FA2.36/host-groups.path.yaml + /api/2.36/host-groups/hosts: + $ref: ../paths/FA2.1/host-groups-hosts-members.path.yaml + /api/2.36/host-groups/performance: + $ref: ../paths/FA2.16/host-groups-performance.path.yaml + /api/2.36/host-groups/performance/by-array: + $ref: ../paths/FA2.16/host-groups-performance-by-array.path.yaml + /api/2.36/host-groups/protection-groups: + $ref: ../paths/FA2.26/host-groups-protection-groups-members.path.yaml + /api/2.36/host-groups/space: + $ref: ../paths/FA2.34/host-groups-space.path.yaml + /api/2.36/host-groups/tags: + $ref: ../paths/FA2.34/host-groups-tags.path.yaml + /api/2.36/host-groups/tags/batch: + $ref: ../paths/FA2.34/host-groups-tags-batch.path.yaml + /api/2.36/hosts: + $ref: ../paths/FA2.36/hosts.path.yaml + /api/2.36/hosts/host-groups: + $ref: ../paths/FA2.1/hosts-host-groups-members.path.yaml + /api/2.36/hosts/performance: + $ref: ../paths/FA2.16/hosts-performance.path.yaml + /api/2.36/hosts/performance/balance: + $ref: ../paths/FA2.4/hosts-performance-balance.path.yaml + /api/2.36/hosts/performance/by-array: + $ref: ../paths/FA2.16/hosts-performance-by-array.path.yaml + /api/2.36/hosts/protection-groups: + $ref: ../paths/FA2.26/hosts-protection-groups-members.path.yaml + /api/2.36/hosts/space: + $ref: ../paths/FA2.34/hosts-space.path.yaml + /api/2.36/hosts/tags: + $ref: ../paths/FA2.34/hosts-tags.path.yaml + /api/2.36/hosts/tags/batch: + $ref: ../paths/FA2.34/hosts-tags-batch.path.yaml + /api/2.36/kmip: + $ref: ../paths/FA2.24/kmip.path.yaml + /api/2.36/kmip/test: + $ref: ../paths/FA2.2/kmip-test.path.yaml + /api/2.36/log-targets: + $ref: ../paths/FA2.35/log-targets.path.yaml + /api/2.36/log-targets/file: + $ref: ../paths/FA2.35/log-targets-file.path.yaml + /api/2.36/log-targets/syslog: + $ref: ../paths/FA2.35/log-targets-syslog.path.yaml + /api/2.36/log-targets/syslog/settings: + $ref: ../paths/FA2.35/log-targets-syslog-settings.path.yaml + /api/2.36/log-targets/syslog/test: + $ref: ../paths/FA2.35/log-targets-syslog-test.path.yaml + /api/2.36/login: + $ref: ../paths/FA2.0/login.path.yaml + /api/2.36/logout: + $ref: ../paths/FA2.0/logout.path.yaml + /api/2.36/maintenance-windows: + $ref: ../paths/FA2.2/maintenance-windows.path.yaml + /api/2.36/network-interfaces: + $ref: ../paths/FA2.30/network-interfaces.path.yaml + /api/2.36/network-interfaces/neighbors: + $ref: ../paths/FA2.22/network-interfaces-neighbors.path.yaml + /api/2.36/network-interfaces/performance: + $ref: ../paths/FA2.36/network-interfaces-performance.path.yaml + /api/2.36/network-interfaces/port-details: + $ref: ../paths/FA2.16/network-interfaces-port-details.path.yaml + /api/2.36/offloads: + $ref: ../paths/FA2.34/offloads.path.yaml + /api/2.36/pod-replica-links: + $ref: ../paths/FA2.2/pod-replica-links.path.yaml + /api/2.36/pod-replica-links/lag: + $ref: ../paths/FA2.2/pod-replica-links-lag.path.yaml + /api/2.36/pod-replica-links/mappings/policies: + $ref: ../paths/FA2.32/pod-replica-links-mappings-policies.yaml + /api/2.36/pod-replica-links/performance/replication: + $ref: ../paths/FA2.4/pod-replica-links-performance-replication.path.yaml + /api/2.36/pods: + $ref: ../paths/FA2.36/pods.path.yaml + /api/2.36/pods/arrays: + $ref: ../paths/FA2.36/pods-arrays-members.path.yaml + /api/2.36/pods/members: + $ref: ../paths/FA2.36/pods-members.path.yaml + /api/2.36/pods/performance: + $ref: ../paths/FA2.36/pods-performance.path.yaml + /api/2.36/pods/performance/by-array: + $ref: ../paths/FA2.13/pods-performance-by-array.path.yaml + /api/2.36/pods/performance/replication: + $ref: ../paths/FA2.4/pods-performance-replication.path.yaml + /api/2.36/pods/performance/replication/by-array: + $ref: ../paths/FA2.4/pods-performance-replication-by-array.path.yaml + /api/2.36/pods/space: + $ref: ../paths/FA2.34/pods-space.path.yaml + /api/2.36/pods/test: + $ref: ../paths/FA2.31/pods-test.path.yaml + /api/2.36/policies: + $ref: ../paths/FA2.24/policies.path.yaml + /api/2.36/policies/alert-watcher: + $ref: ../paths/FA2.33/policies-alert-watcher.path.yaml + /api/2.36/policies/alert-watcher/members: + $ref: ../paths/FA2.33/policies-alert-watcher-members.path.yaml + /api/2.36/policies/alert-watcher/rules: + $ref: ../paths/FA2.33/policies-alert-watcher-rules.path.yaml + /api/2.36/policies/alert-watcher/rules/test: + $ref: ../paths/FA2.33/policy-alert-watcher-rule-test.path.yaml + /api/2.36/policies/audit-file: + $ref: ../paths/FA2.35/policies-audit-file.path.yaml + /api/2.36/policies/audit-file/members: + $ref: ../paths/FA2.35/policies-audit-file-members.path.yaml + /api/2.36/policies/autodir: + $ref: ../paths/FA2.24/policies-autodir.path.yaml + /api/2.36/policies/autodir/members: + $ref: ../paths/FA2.24/policies-autodir-members.path.yaml + /api/2.36/policies/management-access: + $ref: ../paths/FA2.36/policies-management-access.path.yaml + /api/2.36/policies/management-access/members: + $ref: ../paths/FA2.36/policies-management-access-members.path.yaml + /api/2.36/policies/members: + $ref: ../paths/FA2.21/policies-members.path.yaml + /api/2.36/policies/nfs: + $ref: ../paths/FA2.32/policies-nfs.path.yaml + /api/2.36/policies/nfs/client-rules: + $ref: ../paths/FA2.29/policies-nfs-client-rules.path.yaml + /api/2.36/policies/nfs/members: + $ref: ../paths/FA2.32/policies-nfs-members.path.yaml + /api/2.36/policies/password: + $ref: ../paths/FA2.34/policies-password.path.yaml + /api/2.36/policies/quota: + $ref: ../paths/FA2.24/policies-quota.path.yaml + /api/2.36/policies/quota/members: + $ref: ../paths/FA2.21/policies-quota-members.path.yaml + /api/2.36/policies/quota/rules: + $ref: ../paths/FA2.21/policies-quota-rules.path.yaml + /api/2.36/policies/smb: + $ref: ../paths/FA2.32/policies-smb.path.yaml + /api/2.36/policies/smb/client-rules: + $ref: ../paths/FA2.21/policies-smb-client-rules.path.yaml + /api/2.36/policies/smb/members: + $ref: ../paths/FA2.32/policies-smb-members.path.yaml + /api/2.36/policies/snapshot: + $ref: ../paths/FA2.24/policies-snapshot.path.yaml + /api/2.36/policies/snapshot/members: + $ref: ../paths/FA2.21/policies-snapshot-members.path.yaml + /api/2.36/policies/snapshot/rules: + $ref: ../paths/FA2.21/policies-snapshot-rules.path.yaml + /api/2.36/ports: + $ref: ../paths/FA2.2/ports.path.yaml + /api/2.36/ports/initiators: + $ref: ../paths/FA2.2/port-initiators.path.yaml + /api/2.36/protection-group-snapshots: + $ref: ../paths/FA2.34/protection-group-snapshots.path.yaml + /api/2.36/protection-group-snapshots/replica: + $ref: ../paths/FA2.34/protection-group-snapshots-replica.path.yaml + /api/2.36/protection-group-snapshots/test: + $ref: ../paths/FA2.34/protection-group-snapshots-test.path.yaml + /api/2.36/protection-group-snapshots/transfer: + $ref: ../paths/FA2.29/protection-group-snapshots-transfer.path.yaml + /api/2.36/protection-groups: + $ref: ../paths/FA2.34/protection-groups.path.yaml + /api/2.36/protection-groups/host-groups: + $ref: ../paths/FA2.26/protection-groups-host-groups-members.path.yaml + /api/2.36/protection-groups/hosts: + $ref: ../paths/FA2.26/protection-groups-hosts-members.path.yaml + /api/2.36/protection-groups/performance/replication: + $ref: ../paths/FA2.26/protection-groups-performance-replication.path.yaml + /api/2.36/protection-groups/performance/replication/by-array: + $ref: ../paths/FA2.26/protection-groups-performance-replication-by-array.path.yaml + /api/2.36/protection-groups/space: + $ref: ../paths/FA2.34/protection-groups-space.path.yaml + /api/2.36/protection-groups/targets: + $ref: ../paths/FA2.26/protection-groups-targets.path.yaml + /api/2.36/protection-groups/volumes: + $ref: ../paths/FA2.26/protection-groups-volumes-members.path.yaml + /api/2.36/realms: + $ref: ../paths/FA2.36/realms.path.yaml + /api/2.36/realms/performance: + $ref: ../paths/FA2.36/realms-performance.path.yaml + /api/2.36/realms/space: + $ref: ../paths/FA2.36/realms-space.path.yaml + /api/2.36/remote-arrays: + $ref: ../paths/FA2.36/remote-arrays.path.yaml + /api/2.36/remote-pods: + $ref: ../paths/FA2.1/remote-pods.path.yaml + /api/2.36/remote-protection-group-snapshots: + $ref: ../paths/FA2.26/remote-protection-group-snapshots.path.yaml + /api/2.36/remote-protection-group-snapshots/test: + $ref: ../paths/FA2.26/remote-protection-group-snapshots-test.path.yaml + /api/2.36/remote-protection-group-snapshots/transfer: + $ref: ../paths/FA2.26/remote-protection-group-snapshots-transfer.path.yaml + /api/2.36/remote-protection-groups: + $ref: ../paths/FA2.1/remote-protection-groups.path.yaml + /api/2.36/remote-volume-snapshots: + $ref: ../paths/FA2.28/remote-volume-snapshots.path.yaml + /api/2.36/remote-volume-snapshots/transfer: + $ref: ../paths/FA2.1/remote-volume-snapshots-transfer.path.yaml + /api/2.36/sessions: + $ref: ../paths/FA2.4/sessions.path.yaml + /api/2.36/smi-s: + $ref: ../paths/FA2.2/smis.path.yaml + /api/2.36/smtp-servers: + $ref: ../paths/FA2.33/smtp-server.path.yaml + /api/2.36/snmp-agents: + $ref: ../paths/FA2.4/snmp-agent.path.yaml + /api/2.36/snmp-agents/mib: + $ref: ../paths/FA2.4/snmp-agent-mib.path.yaml + /api/2.36/snmp-managers: + $ref: ../paths/FA2.4/snmp-manager.path.yaml + /api/2.36/snmp-managers/test: + $ref: ../paths/FA2.4/snmp-manager-test.path.yaml + /api/2.36/software: + $ref: ../paths/FA2.11/software.path.yaml + /api/2.36/software-bundle: + $ref: ../paths/FA2.5/software-bundle.path.yaml + /api/2.36/software-check: + $ref: ../paths/FA2.9/software-checks.path.yaml + /api/2.36/software-installation-steps: + $ref: ../paths/FA2.4/software-installation-steps.path.yaml + /api/2.36/software-installations: + $ref: ../paths/FA2.9/software-installations.path.yaml + /api/2.36/software-patches: + $ref: ../paths/FA2.29/software-patches.path.yaml + /api/2.36/software-patches/catalog: + $ref: ../paths/FA2.29/software-patches-catalog.path.yaml + /api/2.36/software-versions: + $ref: ../paths/FA2.9/software-versions.path.yaml + /api/2.36/sso/saml2/idps: + $ref: ../paths/FA2.11/saml2-sso.path.yaml + /api/2.36/sso/saml2/idps/test: + $ref: ../paths/FA2.11/saml2-sso-test.path.yaml + /api/2.36/subnets: + $ref: ../paths/FA2.2/subnets.path.yaml + /api/2.36/subscription-assets: + $ref: ../paths/FA2.26/subscription-assets.path.yaml + /api/2.36/subscriptions: + $ref: ../paths/FA2.26/subscriptions.path.yaml + /api/2.36/support: + $ref: ../paths/FA2.35/support.path.yaml + /api/2.36/support-diagnostics/details: + $ref: ../paths/FA2.36/support-diagnostics-details.path.yaml + /api/2.36/support-diagnostics/settings: + $ref: ../paths/FA2.36/support-diagnostics-settings.path.yaml + /api/2.36/support/test: + $ref: ../paths/FA2.2/support-test.path.yaml + /api/2.36/syslog-servers: + $ref: ../paths/FA2.35/syslog-servers.path.yaml + /api/2.36/syslog-servers/settings: + $ref: ../paths/FA2.9/syslog-servers-settings.path.yaml + /api/2.36/syslog-servers/test: + $ref: ../paths/FA2.4/syslog-servers-test.path.yaml + /api/2.36/vchost-connections: + $ref: ../paths/FA2.33/vchost-connections.path.yaml + /api/2.36/vchosts: + $ref: ../paths/FA2.26/vchosts.path.yaml + /api/2.36/vchosts/certificates: + $ref: ../paths/FA2.33/vchost-certificate.path.yaml + /api/2.36/vchosts/endpoints: + $ref: ../paths/FA2.33/vchost-endpoint.path.yaml + /api/2.36/virtual-machine-snapshots: + $ref: ../paths/FA2.14/virtual-machine-snapshots.path.yaml + /api/2.36/virtual-machine-volume-snapshots: + $ref: ../paths/FA2.35/virtual-machine-volume-snapshots.path.yaml + /api/2.36/virtual-machines: + $ref: ../paths/FA2.14/virtual-machines.path.yaml + /api/2.36/volume-groups: + $ref: ../paths/FA2.36/volume-groups.path.yaml + /api/2.36/volume-groups/performance: + $ref: ../paths/FA2.4/volume-groups-performance.path.yaml + /api/2.36/volume-groups/space: + $ref: ../paths/FA2.34/volume-groups-space.path.yaml + /api/2.36/volume-groups/volumes: + $ref: ../paths/FA2.1/volume-groups-volumes-members.path.yaml + /api/2.36/volume-snapshots: + $ref: ../paths/FA2.34/volume-snapshots.path.yaml + /api/2.36/volume-snapshots/tags: + $ref: ../paths/FA2.9/volume-snapshots-tags.path.yaml + /api/2.36/volume-snapshots/tags/batch: + $ref: ../paths/FA2.2/volume-snapshots-tags-batch.path.yaml + /api/2.36/volume-snapshots/test: + $ref: ../paths/FA2.25/volume-snapshots-test.path.yaml + /api/2.36/volume-snapshots/transfer: + $ref: ../paths/FA2.29/volume-snapshots-transfer.path.yaml + /api/2.36/volumes: + $ref: ../paths/FA2.34/volumes.path.yaml + /api/2.36/volumes/batch: + $ref: ../paths/FA2.34/volumes-batch.path.yaml + /api/2.36/volumes/batch/test: + $ref: ../paths/FA2.33/volumes-batch-test.path.yaml + /api/2.36/volumes/diff: + $ref: ../paths/FA2.9/volumes-diff.path.yaml + /api/2.36/volumes/performance: + $ref: ../paths/FA2.4/volumes-performance.path.yaml + /api/2.36/volumes/performance/by-array: + $ref: ../paths/FA2.4/volumes-performance-by-array.path.yaml + /api/2.36/volumes/protection-groups: + $ref: ../paths/FA2.26/volumes-protection-groups-members.path.yaml + /api/2.36/volumes/space: + $ref: ../paths/FA2.34/volumes-space.path.yaml + /api/2.36/volumes/tags: + $ref: ../paths/FA2.9/volumes-tags.path.yaml + /api/2.36/volumes/tags/batch: + $ref: ../paths/FA2.2/volumes-tags-batch.path.yaml + /api/2.36/volumes/test: + $ref: ../paths/FA2.33/volumes-test.path.yaml + /api/2.36/volumes/volume-groups: + $ref: ../paths/FA2.1/volumes-volume-groups-members.path.yaml + /api/api_version: + $ref: ../paths/FA2.0/api_version.path.yaml + /oauth2/1.0/token: + $ref: ../paths/TEx-v2/oauth-token.path.yaml + /oauth2_pub_priv_key_pair: + get: + description: "Returns a public and private key pair, This is not part of the\ + \ FlashArray API, \nit's a helper endpoint making it easier to generate an\ + \ oauth2 token_id in this Swagger UI. \nThey keys are generated in the Docker\ + \ container running on this machine.\n\nRecommend to NOT use this API but\ + \ to use OpenSSL instead for production use cases:\n You can generate a public\ + \ and private RSA key pair like this:\n\n openssl genrsa -des3 -out private.pem\ + \ 2048\n \n That generates a 2048-bit RSA key pair, encrypts them with\ + \ a password you provide and writes them to a file. \n You need to next\ + \ extract the public key file. You will use this, for instance, on your web\ + \ server to encrypt \n content so that it can only be read with the private\ + \ key.\n \n Export the RSA Public Key to a File\n This is a command\ + \ that is\n \n openssl rsa -in private.pem -outform PEM -pubout -out\ + \ public.pem" + responses: + 200: + description: Token Generated + schema: + properties: + private_key: + description: Private key in PEM format. + type: string + public_key: + description: Public key in PEM format. + type: string + type: object + tags: + - Auth Helpers + /oauth2_token_from_private_key: + post: + consumes: + - text/plain + description: "Authenticates to Flasharray, This returns a token_id (think session\ + \ id), from an existing API Client, \nThis is not part of the FlashArray API,\ + \ it's a helper endpoint making it easy to generate an \noauth2 token_id in\ + \ this Swagger UI. The private key is being passed into the Docker container\ + \ in\norder to sign the JWT token. Take a look at the Docker container output\ + \ to see more details \nof what is happening.\n\nCopy the output value, Authorization\ + \ header, and then click on the green Authorize button at the \ntop of the\ + \ page. Paste in the value into " + parameters: + - description: Issuer value displayed in the FlashArray API Registration page + or pureapiclient list ) by default it's the same name as API Client + in: header + name: issuer_name + type: string + - description: Client Id value displayed in the FlashArray API Registration + page or pureapiclient list + in: header + name: client_id + type: string + - description: Key Id value displayed in the FlashArray API Registration page + or pureapiclient list + in: header + name: key_id + type: string + - description: The name of a valid user on the FlashArray that will be authenticated + to. + in: header + name: username + type: string + - description: Private key in PEM format that was used to create the Public + key for this API Client specified as the issuer in this call. + in: body + name: private_key + required: true + schema: + type: string + produces: + - application/json + responses: + 200: + description: Token Generated + schema: + example: + username: pureuser + properties: + Authorization: + description: An OAuth bearer token to be used in the Authorization + header for authorization to API endpoints. + type: string + description: + desciption: How to use token + type: string + type: object + tags: + - Auth Helpers +produces: +- application/json +security: +- OAuth2-Bearer-Token: [] +- X-Auth-Token: [] +securityDefinitions: + OAuth2-Bearer-Token: + in: header + name: Authorization + type: apiKey + X-Auth-Token: + in: header + name: x-auth-token + type: apiKey +swagger: '2.0' +tags: +- description: A set of endpoints not in the Purity API, but to make OAuth using this + tool simple and easy to understand. + name: Auth Helpers +- description: Pure Storage uses the OAuth 2.0 Token Exchange authorization grant + and JSON Web Tokens (JWTs) to authenticate to the Pure Storage REST API. Before + you can exchange the ID token for an access token, create and enable the API client + to generate the `key_id`, `id`, and `issuer` values. These values will be used + as JWT claims for the `subject_token` parameter. + name: Authorization +- 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. + name: Active Directory +- description: The FlashArray has a single default administrative account named pureuser. + The administrator can add, delete, and modify administrators on the array. Administrators + are assigned management access policies to give different levels of permissions. + name: Administrators +- description: Alerts indicate significant events that occur on an array, including + whenever a component degrades or the capacity threshold of the component is reached. + name: Alerts +- description: Alert watchers receive email notifications when alerts occur on an + array. + name: Alert Watchers +- description: An API client represents an identity type. API clients are created + on the array. To create an API client, register and then enable it on the array. + After the API client has been created, the user name (`sub`) and identity tokens + (`kid` and `aud` tokens) that are issued by the API client are used as claims + for the JSON Web Token that you create to authenticate into the REST API. + name: API Clients +- description: Apps that extend array functionality can be integrated into the Purity//FA + operating system. + name: Apps +- description: Array features provide the ability to configure settings that affect + the operation of the array as a whole and monitor array I/O performance. + name: Arrays +- description: Manages connections between arrays. + name: Array Connections +- description: Audit trail records describe administrative actions performed by a + user to modify the configuration of an array. + name: Audits +- description: Purity//FA creates a self-signed certificate and private key when you + start the system for the first time. You can use the default certificate, change + the certificate attributes, create a new self-signed certificate, or import an + SSL certificate signed by a certificate authority. + name: Certificates +- description: Certificate groups, also known as certificate bundles, are collections + of digital certificates. Each certificate can belong to one or more groups in + order to serve different purposes. + name: Certificate Groups +- description: A connection gives hosts access to volumes on the array. + name: Connections +- description: Default protection is a list of protection groups that are applied + to newly created volumes. Volumes can opt out of the default protection at creation. + The pod's `default_protections` defaults to the array's `default_protections` + at pod creation. Default protection can be configured on the array and the pod. + name: Container Default Protections +- description: Controller data includes the name, mode, FlashArray model, Purity//FA + software version, and status of each controller in the array. + name: Controllers +- description: Important file system directories should be set up as managed directories. + Managed directories can have policies attached to them. Managed directories differ + from standard directories in that they provide space reporting and metrics. + name: Directories +- description: Managed directory exports are created by adding NFS or SMB export policies + to managed directories. + name: Directory Exports +- description: Directory quotas provide the ability to set capacity limits on managed + directories. + name: Directory Quotas +- description: Manages directory service configurations for integration with LDAP + servers (e.g. Active Directory and OpenLDAP) in order to support various array + services. + name: Directory Services +- description: Directory snapshots are created manually or by adding snapshot policies + to managed directories. Each snapshot policy can be re-used for multiple directories. + name: Directory Snapshots +- description: DNS attributes include the domain suffix, static name servers, mode + (static or DHCP), and search domain. The configured attributes can be listed. + name: DNS +- description: Drive data includes the name, type, status, capacity, protocol and + other information for all flash, NVRAM, and cache modules in an array. + name: Drives +- description: A FlashArray can contain up to 24 separate file systems, each with + a number of directories that can be exported via supported protocols. Clients, + using Active Directory or LDAP, can connect and access these exports using SMB + or NFS. + name: File Systems +- description: A fleet is a collection of Arrays. + name: Fleets +- description: Operational status is reported by most of the hardware components in + an array, including the chassis, controller, and storage shelf. + name: Hardware +- description: Host groups implement consistent connections between a set of hosts + and one or more volumes. Connections are consistent in the sense that all hosts + associated with a host group address a volume connected to the group by the same + LUN. Host groups are typically used to provide a common view of storage volumes + to the hosts in a clustered application. + name: Host Groups +- description: Hosts organize the storage network addresses (iSCSI Qualified Names, + NVMe qualified names, or Fibre Channel world wide names) of client computers to + identify the host's intiators. Hosts also control communications between clients + and volumes. After a volume has been created, establish a host-volume connection + so that the host can read data from and write data to the volume. + name: Hosts +- description: The Key Management Interoperability Protocol (KMIP) server is used + in combination with the Pure Storage Rapid Data Locking (RDL) feature and EncryptReduce + feature to further secure the encrypted data on a FlashArray. + name: KMIP +- description: Log Targets to be used to send management or data audit logs. + name: Log Targets +- description: During a maintenance window, alerts are suppressed that are related + to connections, paths, ports, and other resources that are down during maintenance. + name: Maintenance Windows +- description: Manages the interfaces and the network connection attributes of the + array. + name: Network Interfaces +- description: The offload feature enables system administrators to replicate point-in-time + volume snapshots from the array to an external storage system for long-term retention. + Each offload target represents an external storage system, such as an Azure Blob + container, NFS device, or S3 bucket, to where Purity//FA volume snapshots can + be replicated. + name: Offloads +- description: Synchronous replication is managed through pods. A pod representing + a collection of protection groups and volumes is created on one array and stretched + to another array, resulting in fully synchronized writes between the two arrays. + A pod can contain a mix of volumes, and protection groups with member volumes. + Writes to the pod coming into either array are immediately synchronized and seen + on both arrays. + name: Pods +- description: Pod replica links are created by associating a source pod with a demoted + pod, making the demoted pod the target pod of the source pod. The direction of + the replica link is from the promoted source pod to the demoted target pod. Replica + links can be created in either direction between the same two FlashArrays. The + target pod of a replica link cannot be on the same FlashArray as the source pod. + name: Pod Replica Links +- description: Policies are used to create exports (i.e., shares) and schedule snapshots. + NFS and SMB policies can be created and have one or more rules applied to them. + Each policy can be reused, creating exports for a number of managed directories. + name: Policies +- description: The ports on a FlashArray are assigned iSCSI Qualified Names (IQNs), + NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs). + name: Ports +- description: A protection group defines a set of volumes, hosts, or host groups + (called members) that are protected together through snapshots with point-in-time + consistency across the member volumes. The members within the protection group + have common data protection requirements and the same snapshot, replication, and + retention schedules. + name: Protection Groups +- description: Protection group snapshots capture the content of all volumes on the + source array for the specified protection group at a single point in time. + name: Protection Group Snapshots +- description: A realm is an administrative domain, a data container, and a namespace + for pods, hosts, and host groups. + name: Realms +- description: Remote arrays provide the ability to list and manage all the remote + arrays known to an array. + name: Remote Arrays +- description: A remote pod represents a pod that is on a connected array but not + stretched to this array. + name: Remote Pods +- description: A remote protection group represents a protection group that resides + on an offload target with the source side of the remote protection group being + another array that is connected to the local array. The local array can only see + the remote protection groups of other arrays if the two arrays are connected. + name: Remote Protection Groups +- description: A remote protection group snapshot represents a protection group snapshot + that resides on an offload target with the source side of the remote protection + group snapshot being another array that is connected to the local array. The local + array can only see the remote protection group snapshots of other arrays if the + two arrays are connected. + name: Remote Protection Group Snapshots +- description: A remote volume snapshot represents a volume snapshot that resides + on an offload target with the source side of the remote volume snapshot being + another array that is connected to the local array. The local array can only see + the remote volume snapshots of other arrays if the two arrays are connected. + name: Remote Volume Snapshots +- description: SAML2 SSO allows customers to configure settings of SAML2 service provider + and identity provider. It provides a multi-factor authentication (MFA) mechanism + for customers to log in to FlashArray. + name: SAML2 SSO +- description: Manages Purity//FA login and user session data. + name: Sessions +- description: Manages the Pure Storage Storage Management Initiative Specification + (SMI-S). + name: SMI-S +- description: Manages connections to Simple Network Management Protocol (SMTP) managers. + name: SMTP +- description: Manages connections to Simple Network Management Protocol (SNMP) agents. + name: SNMP Agents +- description: Manages connections to Simple Network Management Protocol (SNMP) managers. + name: SNMP Managers +- description: Software to be installed on the array. + name: Software +- description: Manages the subnets and VLANs used to organize the network interfaces. + name: Subnets +- description: Provides information about subscription offerings. + name: Subscriptions +- description: Provides information about subscription assets. + name: Subscription Assets +- description: Enables Support to fix bugs and help customers solve problems. Support + tools include proxy, phonehome, and remote assist. + name: Support +- description: Copied to Log Targets/Syslog for more organized way to handle all log + targets. Both endpoints are identical. We encourage our users to use Log Targets/Syslog. + name: Syslog +- description: A vchost connection is between a protocol endpoint and vchost. In the + context of vchost-connection, the vchost represents a vCenter, and the protocol + endpoint is used to represent a storage container. Creating a vchost connection + gives the vCenter access to the storage container. If `all_vchosts` is set to + `true`, the container will be accessible to all vchosts. + name: Vchost Connections +- description: A volume represents a container that manages the storage space on the + array. After a volume has been created, host-volume connections must be established + so that the host can read data from and write data to the volume. Volume data + should be protected using asynchronous replication to a remote array, synchronous + replication between remote arrays, and replication to external storage systems. + name: Volumes +- description: Volume groups organize volumes into logical groupings. If virtual volumes + are configured, each volume group on the FlashArray array represents its associated + virtual machine, and inside each of those volumes groups are the FlashArray volumes + that are assigned to the virtual machine. Volume groups that are associated with + virtual machines have names that begin with `vvol-` and end with the virtual machine + name. + name: Volume Groups +- description: Volume snapshots are immutable, point-in-time images of the contents + of one or more volumes. There are two types of volume snapshots: volume snapshots + and protection group volume snapshots. A volume snapshot is a snapshot that captures + the contents of a single volume. A protection group volume snapshot is a volume + snapshot that is created from a group of volumes that are part of the same protection + group. All of the volume snapshots created from a protection group snapshot are + point-in-time consistent with each other. + name: Volume Snapshots diff --git a/html/specs/FA2.37.spec.yaml b/html/specs/FA2.37.spec.yaml new file mode 100644 index 00000000..09e655ad --- /dev/null +++ b/html/specs/FA2.37.spec.yaml @@ -0,0 +1,1100 @@ +consumes: +- application/json +definitions: + ActiveDirectory: + $ref: ../models/FA2.15/active-directory.yaml + Admin: + $ref: ../models/FA2.36/admin.yaml + AdminApiToken: + $ref: ../models/FA2.2/admin-api-token.yaml + AdminCache: + $ref: ../models/FA2.36/admin-cache.yaml + AdminSettings: + $ref: ../models/FA2.32/admin-settings.yaml + Alert: + $ref: ../models/FA2.2/alert.yaml + AlertEvent: + $ref: ../models/FA2.2/alert-event.yaml + AlertRules: + $ref: ../models/FA2.23/alert-rules.yaml + AlertWatcher: + $ref: ../models/FA2.4/alert-watcher.yaml + ApiClient: + $ref: ../models/FA2.36/api-client.yaml + App: + $ref: ../models/FA2.2/app.yaml + AppNode: + $ref: ../models/FA2.2/app-node.yaml + Array: + $ref: ../models/FA2.34/arrays.yaml + ArrayConnection: + $ref: ../models/FA2.33/array-connection.yaml + ArrayConnectionKey: + $ref: ../models/FA2.4/array-connection-key.yaml + ArrayConnectionPath: + $ref: ../models/FA2.33/array-connection-path.yaml + ArrayErasures: + $ref: ../models/FA2.34/array-erasure.yaml + ArrayFactoryResetToken: + $ref: ../models/FA2.4/array-factory-reset-token.yaml + ArrayPerformance: + $ref: ../models/FA2.4/array-performance.yaml + ArrayPerformanceByLink: + $ref: ../models/FA2.19/array-performance-by-link.yaml + ArraySpace: + $ref: ../models/FA2.34/space.yaml + Audit: + $ref: ../models/FA2.2/audit.yaml + Certificate: + $ref: ../models/FA2.4/certificate.yaml + CloudCapacityStatus: + $ref: ../models/FA2.29/cloud-capacity-status.yaml + CloudCapacityStep: + $ref: ../models/FA2.29/cloud-capacity-step.yaml + CloudProviderTag: + $ref: ../models/FA2.6/cloud-provider-tag.yaml + Connection: + $ref: ../models/FA2.27/connection.yaml + ContainerDefaultProtection: + $ref: ../models/FA2.26/container-default-protection.yaml + Controllers: + $ref: ../models/FA2.30/controller.yaml + Directory: + $ref: ../models/FA2.34/directory.yaml + DirectoryExport: + $ref: ../models/FA2.32/directory-export.yaml + DirectoryLockNLMReclamation: + $ref: ../models/FA2.21/directory-lock-nlm-reclamation.yaml + DirectoryPerformance: + $ref: ../models/FA2.3/directory-performance.yaml + DirectoryQuota: + $ref: ../models/FA2.7/directory-quota.yaml + DirectoryService: + $ref: ../models/FA2.37/directory-service.yaml + DirectoryServiceRole: + $ref: ../models/FA2.36/directory-service-role.yaml + DirectorySnapshot: + $ref: ../models/FA2.34/directory-snapshot.yaml + DirectorySpace: + $ref: ../models/FA2.34/resource-directory-space.yaml + Dns: + $ref: ../models/FA2.15/dns.yaml + Drive: + $ref: ../models/FA2.4/drive.yaml + FileSystem: + $ref: ../models/FA2.13/file-system.yaml + Fleet: + $ref: ../models/FA2.36/fleet.yaml + FleetKey: + $ref: ../models/FA2.36/fleet-key.yaml + FleetMember: + $ref: ../models/FA2.36/fleet-member.yaml + Hardware: + $ref: ../models/FA2.2/hardware.yaml + Host: + $ref: ../models/FA2.36/host.yaml + HostGroup: + $ref: ../models/FA2.36/host-group.yaml + HostGroupPerformance: + $ref: ../models/FA2.4/resource-performance.yaml + HostGroupPerformanceByArray: + $ref: ../models/FA2.4/resource-performance-by-array.yaml + HostGroupSpace: + $ref: ../models/FA2.34/resource-space-no-id.yaml + HostPerformance: + $ref: ../models/FA2.4/resource-performance.yaml + HostPerformanceBalance: + $ref: ../models/FA2.4/host-performance-balance.yaml + HostPerformanceByArray: + $ref: ../models/FA2.4/resource-performance-by-array.yaml + HostSpace: + $ref: ../models/FA2.34/resource-space-no-id.yaml + Kmip: + $ref: ../models/FA2.24/kmip.yaml + KmipTestResult: + $ref: ../models/FA2.2/kmip-test-result.yaml + LocalGroup: + $ref: ../models/FA2.21/local-group.yaml + LocalMember: + $ref: ../models/FA2.21/local-member.yaml + LocalUser: + $ref: ../models/FA2.21/local-user.yaml + LogTarget: + $ref: ../models/FA2.35/log-target.yaml + LogTargetFile: + $ref: ../models/FA2.35/log-target-file.yaml + MaintenanceWindow: + $ref: ../models/FA2.2/maintenance-window.yaml + Member: + $ref: ../models/FA2.0/member.yaml + MemberNoIdAll: + $ref: ../models/FA2.0/member-no-id-all.yaml + MemberNoIdGroup: + $ref: ../models/FA2.1/member-no-id-group.yaml + NetworkInterface: + $ref: ../models/FA2.30/network-interface.yaml + NetworkInterfaceNeighbor: + $ref: ../models/FA2.22/network-interface-neighbor.yaml + NetworkInterfacePerformance: + $ref: ../models/FA2.36/network-interface-performance.yaml + NetworkInterfacePortDetails: + $ref: ../models/FA2.16/network-interfaces-port-details.yaml + Offload: + $ref: ../models/FA2.34/offload.yaml + Pod: + $ref: ../models/FA2.36/pod.yaml + PodPerformance: + $ref: ../models/FA2.13/pod-performance.yaml + PodPerformanceByArray: + $ref: ../models/FA2.13/pod-performance-by-array.yaml + PodPerformanceReplication: + $ref: ../models/FA2.4/pod-performance-replication.yaml + PodPerformanceReplicationByArray: + $ref: ../models/FA2.4/pod-performance-replication-by-array.yaml + PodReplicaLink: + $ref: ../models/FA2.2/pod-replica-link.yaml + PodReplicaLinkLag: + $ref: ../models/FA2.2/pod-replica-link-lag.yaml + PodReplicaLinkMappingPolicy: + $ref: ../models/FA2.32/mapping-policy.yaml + PodReplicaLinkPerformance: + $ref: ../models/FA2.2/pod-replica-link-performance-replication.yaml + PodSpace: + $ref: ../models/FA2.34/resource-pod-space.yaml + Policy: + $ref: ../models/FA2.24/policy.yaml + PolicyAuditFile: + $ref: ../models/FA2.35/policy-audit-file.yaml + PolicyManagementAccess: + $ref: ../models/FA2.36/policy-management-access.yaml + PolicyManagementAccessEffective: + $ref: ../models/FA2.36/policy-management-access-effective.yaml + PolicyMember: + $ref: ../models/FA2.21/policy-member.yaml + PolicyMemberExport: + $ref: ../models/FA2.32/policy-member-export.yaml + PolicyNfs: + $ref: ../models/FA2.32/policy-nfs.yaml + PolicyPassword: + $ref: ../models/FA2.34/policy-password.yaml + PolicyRuleNfsClient: + $ref: ../models/FA2.29/policy-rule-nfs-client.yaml + PolicyRuleQuota: + $ref: ../models/FA2.21/policy-rule-quota.yaml + PolicyRuleSmbClient: + $ref: ../models/FA2.21/policy-rule-smb-client.yaml + PolicyRuleSnapshot: + $ref: ../models/FA2.21/policy-rule-snapshot.yaml + PolicySmb: + $ref: ../models/FA2.32/policy-smb.yaml + Port: + $ref: ../models/FA2.2/port.yaml + PortInitiator: + $ref: ../models/FA2.2/port-initiator.yaml + ProtectionGroup: + $ref: ../models/FA2.34/protection-group.yaml + ProtectionGroupPerformance: + $ref: ../models/FA2.26/protection-group-performance.yaml + ProtectionGroupPerformanceByArray: + $ref: ../models/FA2.26/protection-group-performance-array.yaml + ProtectionGroupSnapshot: + $ref: ../models/FA2.34/protection-group-snapshot.yaml + ProtectionGroupSpace: + $ref: ../models/FA2.34/resource-space-no-id.yaml + ProtectionGroupTarget: + $ref: ../models/FA2.1/protection-group-target.yaml + Realm: + $ref: ../models/FA2.36/realm.yaml + RealmPerformance: + $ref: ../models/FA2.36/container-performance.yaml + RealmSpace: + $ref: ../models/FA2.36/resource-realm-space.yaml + RemoteArray: + $ref: ../models/FA2.36/remote-array.yaml + RemoteProtectionGroup: + $ref: ../models/FA2.1/remote-protection-group.yaml + RemoteProtectionGroupSnapshot: + $ref: ../models/FA2.26/remote-protection-group-snapshot.yaml + RemoteProtectionGroupSnapshotTransfer: + $ref: ../models/FA2.26/remote-protection-group-snapshot-transfer.yaml + RemoteVolumeSnapshot: + $ref: ../models/FA2.1/remote-volume-snapshot.yaml + RemoteVolumeSnapshotTransfer: + $ref: ../models/FA2.1/remote-volume-snapshot-transfer.yaml + Saml2-sso: + $ref: ../models/FA2.11/saml2-sso.yaml + Session: + $ref: ../models/FA2.4/session.yaml + Smis: + $ref: ../models/FA2.2/smis.yaml + SmtpServer: + $ref: ../models/FA2.33/smtp-server.yaml + SnmpAgent: + $ref: ../models/FA2.4/snmp-agent.yaml + SnmpManager: + $ref: ../models/FA2.4/snmp-manager.yaml + Software: + $ref: ../models/FA2.9/software.yaml + SoftwareBundle: + $ref: ../models/FA2.5/software-bundle.yaml + SoftwareChecks: + $ref: ../models/FA2.9/software-check.yaml + SoftwareInstallationSteps: + $ref: ../models/FA2.2/software-installation-step.yaml + SoftwareInstallations: + $ref: ../models/FA2.37/software-installation.yaml + SoftwarePatches: + $ref: ../models/FA2.29/software-patch.yaml + SoftwareVersions: + $ref: ../models/FA2.9/software-version.yaml + Subnet: + $ref: ../models/FA2.2/subnet.yaml + Subscription: + $ref: ../models/FA2.26/subscription.yaml + SubscriptionAsset: + $ref: ../models/FA2.26/subscription-asset.yaml + Support: + $ref: ../models/FA2.35/support.yaml + SupportDiagnosticsDetails: + $ref: ../models/FA2.36/support-diagnostics-details.yaml + SupportDiagnosticsSettings: + $ref: ../models/FA2.36/support-diagnostics-settings.yaml + SyslogServer: + $ref: ../models/FA2.35/syslog-server.yaml + SyslogServerSettings: + $ref: ../models/FA2.9/syslog-server-settings.yaml + Tag: + $ref: ../models/FA2.2/tag.yaml + TestResult: + $ref: ../models/FA2.2/test-result.yaml + TestResultWithResource: + $ref: ../models/FA2.2/test-result-with-resource.yaml + Username: + $ref: ../models/FA2.0/username.yaml + Vchost: + $ref: ../models/FA2.26/vchost.yaml + VchostCertificate: + $ref: ../models/FA2.33/vchost-certificate.yaml + VchostConnection: + $ref: ../models/FA2.33/vchost-connection.yaml + VchostEndpoint: + $ref: ../models/FA2.33/vchost-endpoint.yaml + Volume: + $ref: ../models/FA2.34/volume.yaml + VolumeDiff: + $ref: ../models/FA2.9/volume-diff.yaml + VolumeGroup: + $ref: ../models/FA2.34/volume-group.yaml + VolumeGroupPerformance: + $ref: ../models/FA2.4/volume-group-performance.yaml + VolumeGroupSpace: + $ref: ../models/FA2.34/resource-space.yaml + VolumePerformance: + $ref: ../models/FA2.4/volume-performance.yaml + VolumePerformanceByArray: + $ref: ../models/FA2.4/resource-performance-by-array.yaml + VolumeSnapshot: + $ref: ../models/FA2.34/volume-snapshot.yaml + VolumeSnapshotTransfer: + $ref: ../models/FA2.1/volume-snapshot-transfer.yaml + VolumeSpace: + $ref: ../models/FA2.34/volume-space.yaml +info: + description: "## Pure Swagger UI for FlashArray\nA light weight tool to explore\ + \ the API for FlashArray, community supported. \nFor help with this tool, use\ + \ [Pure1 Community](https://community.purestorage.com/) or the [code-purestorage\ + \ Slack](https://community.purestorage.com/discussion/9561/join-the-new-pure-code-slack-team-for-api-and-extensibility-discussions)\n\ + \n## Authenticate using API Token\nTo get an API Key, you can do POST /auth/apitoken\ + \ with your user/pass using the 1.x API, then use your API key with POST /login.\ + \ The array returns \na header with the name \"x-auth-token\". This swagger\ + \ UI tool, translates that into a cookie so the webbrowser will send on subsequent\ + \ calls. This Swagger UI tool then\ntranslates that cookie back into a header\ + \ when making the API request to the array.\n\n## Authenticate using OAuth\n###\ + \ Manually generate an id_token \n\n### \n\nIntro to how OAuth2 works with the\ + \ 2.0 version: [Intro](https://support.purestorage.com/FlashArray/PurityFA/Purity_FA_REST_API/Reference/REST_API_2.0_Authentication_Guide)" + title: FlashArray REST API + version: '2.37' +paths: + /api/2.37/active-directory: + $ref: ../paths/FA2.15/active-directory.path.yaml + /api/2.37/admins: + $ref: ../paths/FA2.36/admins.path.yaml + /api/2.37/admins/api-tokens: + $ref: ../paths/FA2.2/admins-api-tokens.path.yaml + /api/2.37/admins/cache: + $ref: ../paths/FA2.36/admins-cache.path.yaml + /api/2.37/admins/policies/management-access: + $ref: ../paths/FA2.36/admin-policies-access.path.yaml + /api/2.37/admins/settings: + $ref: ../paths/FA2.32/admin-settings.path.yaml + /api/2.37/alert-watchers: + $ref: ../paths/FA2.4/alert-watchers.path.yaml + /api/2.37/alert-watchers/test: + $ref: ../paths/FA2.4/alert-watchers-test.path.yaml + /api/2.37/alerts: + $ref: ../paths/FA2.2/alerts.path.yaml + /api/2.37/alerts/events: + $ref: ../paths/FA2.2/alerts-events.yaml + /api/2.37/alerts/rules: + $ref: ../paths/FA2.23/alert-rules.path.yaml + /api/2.37/alerts/rules/catalog: + $ref: ../paths/FA2.23/alert-rules-catalog.path.yaml + /api/2.37/api-clients: + $ref: ../paths/FA2.36/api-clients.path.yaml + /api/2.37/apps: + $ref: ../paths/FA2.2/apps.path.yaml + /api/2.37/apps/nodes: + $ref: ../paths/FA2.2/apps-nodes.path.yaml + /api/2.37/array-connections: + $ref: ../paths/FA2.33/array-connections.path.yaml + /api/2.37/array-connections/connection-key: + $ref: ../paths/FA2.33/array-connection-key.path.yaml + /api/2.37/array-connections/path: + $ref: ../paths/FA2.33/array-connections-path.path.yaml + /api/2.37/arrays: + $ref: ../paths/FA2.34/arrays.path.yaml + /api/2.37/arrays/cloud-capacity: + $ref: ../paths/FA2.29/arrays-cloud-capacity.path.yaml + /api/2.37/arrays/cloud-capacity/supported-steps: + $ref: ../paths/FA2.29/arrays-cloud-capacity-steps.path.yaml + /api/2.37/arrays/cloud-provider-tags: + $ref: ../paths/FA2.6/arrays-cloud-provider-tags.path.yaml + /api/2.37/arrays/cloud-provider-tags/batch: + $ref: ../paths/FA2.6/arrays-cloud-provider-tags-batch.path.yaml + /api/2.37/arrays/erasures: + $ref: ../paths/FA2.34/arrays-erasures.path.yaml + /api/2.37/arrays/eula: + $ref: ../paths/FA2.30/arrays-eula.path.yaml + /api/2.37/arrays/factory-reset-token: + $ref: ../paths/FA2.4/arrays-factory-reset-token.path.yaml + /api/2.37/arrays/ntp-test: + $ref: ../paths/FA2.2/arrays-ntp-test.path.yaml + /api/2.37/arrays/performance: + $ref: ../paths/FA2.4/arrays-performance.path.yaml + /api/2.37/arrays/performance/by-link: + $ref: ../paths/FA2.19/array-performance-by-link.path.yaml + /api/2.37/arrays/space: + $ref: ../paths/FA2.34/arrays-space.path.yaml + /api/2.37/arrays/tags: + $ref: ../paths/FA2.34/arrays-tags.path.yaml + /api/2.37/arrays/tags/batch: + $ref: ../paths/FA2.34/arrays-tags-batch.path.yaml + /api/2.37/audits: + $ref: ../paths/FA2.2/audits.path.yaml + /api/2.37/certificate-groups: + $ref: ../paths/FA2.36/certificate-groups.path.yaml + /api/2.37/certificate-groups/certificates: + $ref: ../paths/FA2.36/certificate-groups-certificates.path.yaml + /api/2.37/certificates: + $ref: ../paths/FA2.4/certificates.path.yaml + /api/2.37/certificates/certificate-groups: + $ref: ../paths/FA2.36/certificates-certificate-groups.path.yaml + /api/2.37/certificates/certificate-signing-requests: + $ref: ../paths/FA2.4/certificate-signing-requests.path.yaml + /api/2.37/connections: + $ref: ../paths/FA2.27/connections.path.yaml + /api/2.37/container-default-protections: + $ref: ../paths/FA2.26/container-default-protections.path.yaml + /api/2.37/controllers: + $ref: ../paths/FA2.30/controllers.path.yaml + /api/2.37/directories: + $ref: ../paths/FA2.34/directories.path.yaml + /api/2.37/directories/locks/nlm-reclamations: + $ref: ../paths/FA2.21/directories-locks-nlm-reclamations.path.yaml + /api/2.37/directories/performance: + $ref: ../paths/FA2.3/directories-performance.path.yaml + /api/2.37/directories/policies: + $ref: ../paths/FA2.21/directories-policies.path.yaml + /api/2.37/directories/policies/audit-file: + $ref: ../paths/FA2.35/directories-policies-audit-file.path.yaml + /api/2.37/directories/policies/autodir: + $ref: ../paths/FA2.24/directories-policies-autodir.path.yaml + /api/2.37/directories/policies/nfs: + $ref: ../paths/FA2.32/directories-policies-nfs.path.yaml + /api/2.37/directories/policies/quota: + $ref: ../paths/FA2.21/directories-policies-quota.path.yaml + /api/2.37/directories/policies/smb: + $ref: ../paths/FA2.32/directories-policies-smb.path.yaml + /api/2.37/directories/policies/snapshot: + $ref: ../paths/FA2.21/directories-policies-snapshot.path.yaml + /api/2.37/directories/space: + $ref: ../paths/FA2.34/directories-space.path.yaml + /api/2.37/directory-exports: + $ref: ../paths/FA2.32/directory-exports.path.yaml + /api/2.37/directory-quotas: + $ref: ../paths/FA2.7/directory-quotas.path.yaml + /api/2.37/directory-services: + $ref: ../paths/FA2.37/directory-services.path.yaml + /api/2.37/directory-services/local/groups: + $ref: ../paths/FA2.21/local-groups.path.yaml + /api/2.37/directory-services/local/groups/members: + $ref: ../paths/FA2.21/local-groups-members.path.yaml + /api/2.37/directory-services/local/users: + $ref: ../paths/FA2.21/local-users.path.yaml + /api/2.37/directory-services/local/users/members: + $ref: ../paths/FA2.21/local-users-members.path.yaml + /api/2.37/directory-services/roles: + $ref: ../paths/FA2.36/directory-services-roles.path.yaml + /api/2.37/directory-services/roles/policies/management-access: + $ref: ../paths/FA2.36/directory-services-roles-policies.path.yaml + /api/2.37/directory-services/test: + $ref: ../paths/FA2.2/directory-services-test.path.yaml + /api/2.37/directory-snapshots: + $ref: ../paths/FA2.34/directory-snapshots.path.yaml + /api/2.37/dns: + $ref: ../paths/FA2.15/dns.path.yaml + /api/2.37/drives: + $ref: ../paths/FA2.4/drives.path.yaml + /api/2.37/file-systems: + $ref: ../paths/FA2.13/file-systems.path.yaml + /api/2.37/files: + $ref: ../paths/FA2.26/files.path.yaml + /api/2.37/fleets: + $ref: ../paths/FA2.36/fleets.path.yaml + /api/2.37/fleets/fleet-key: + $ref: ../paths/FA2.36/fleet-key.path.yaml + /api/2.37/fleets/members: + $ref: ../paths/FA2.36/fleet-members.path.yaml + /api/2.37/hardware: + $ref: ../paths/FA2.2/hardware.path.yaml + /api/2.37/host-groups: + $ref: ../paths/FA2.36/host-groups.path.yaml + /api/2.37/host-groups/hosts: + $ref: ../paths/FA2.1/host-groups-hosts-members.path.yaml + /api/2.37/host-groups/performance: + $ref: ../paths/FA2.16/host-groups-performance.path.yaml + /api/2.37/host-groups/performance/by-array: + $ref: ../paths/FA2.16/host-groups-performance-by-array.path.yaml + /api/2.37/host-groups/protection-groups: + $ref: ../paths/FA2.26/host-groups-protection-groups-members.path.yaml + /api/2.37/host-groups/space: + $ref: ../paths/FA2.34/host-groups-space.path.yaml + /api/2.37/host-groups/tags: + $ref: ../paths/FA2.34/host-groups-tags.path.yaml + /api/2.37/host-groups/tags/batch: + $ref: ../paths/FA2.34/host-groups-tags-batch.path.yaml + /api/2.37/hosts: + $ref: ../paths/FA2.36/hosts.path.yaml + /api/2.37/hosts/host-groups: + $ref: ../paths/FA2.1/hosts-host-groups-members.path.yaml + /api/2.37/hosts/performance: + $ref: ../paths/FA2.16/hosts-performance.path.yaml + /api/2.37/hosts/performance/balance: + $ref: ../paths/FA2.4/hosts-performance-balance.path.yaml + /api/2.37/hosts/performance/by-array: + $ref: ../paths/FA2.16/hosts-performance-by-array.path.yaml + /api/2.37/hosts/protection-groups: + $ref: ../paths/FA2.26/hosts-protection-groups-members.path.yaml + /api/2.37/hosts/space: + $ref: ../paths/FA2.34/hosts-space.path.yaml + /api/2.37/hosts/tags: + $ref: ../paths/FA2.34/hosts-tags.path.yaml + /api/2.37/hosts/tags/batch: + $ref: ../paths/FA2.34/hosts-tags-batch.path.yaml + /api/2.37/kmip: + $ref: ../paths/FA2.24/kmip.path.yaml + /api/2.37/kmip/test: + $ref: ../paths/FA2.2/kmip-test.path.yaml + /api/2.37/log-targets: + $ref: ../paths/FA2.35/log-targets.path.yaml + /api/2.37/log-targets/file: + $ref: ../paths/FA2.35/log-targets-file.path.yaml + /api/2.37/log-targets/syslog: + $ref: ../paths/FA2.35/log-targets-syslog.path.yaml + /api/2.37/log-targets/syslog/settings: + $ref: ../paths/FA2.35/log-targets-syslog-settings.path.yaml + /api/2.37/log-targets/syslog/test: + $ref: ../paths/FA2.35/log-targets-syslog-test.path.yaml + /api/2.37/login: + $ref: ../paths/FA2.0/login.path.yaml + /api/2.37/logout: + $ref: ../paths/FA2.0/logout.path.yaml + /api/2.37/maintenance-windows: + $ref: ../paths/FA2.2/maintenance-windows.path.yaml + /api/2.37/network-interfaces: + $ref: ../paths/FA2.30/network-interfaces.path.yaml + /api/2.37/network-interfaces/neighbors: + $ref: ../paths/FA2.22/network-interfaces-neighbors.path.yaml + /api/2.37/network-interfaces/performance: + $ref: ../paths/FA2.36/network-interfaces-performance.path.yaml + /api/2.37/network-interfaces/port-details: + $ref: ../paths/FA2.16/network-interfaces-port-details.path.yaml + /api/2.37/offloads: + $ref: ../paths/FA2.34/offloads.path.yaml + /api/2.37/pod-replica-links: + $ref: ../paths/FA2.2/pod-replica-links.path.yaml + /api/2.37/pod-replica-links/lag: + $ref: ../paths/FA2.2/pod-replica-links-lag.path.yaml + /api/2.37/pod-replica-links/mappings/policies: + $ref: ../paths/FA2.32/pod-replica-links-mappings-policies.yaml + /api/2.37/pod-replica-links/performance/replication: + $ref: ../paths/FA2.4/pod-replica-links-performance-replication.path.yaml + /api/2.37/pods: + $ref: ../paths/FA2.36/pods.path.yaml + /api/2.37/pods/arrays: + $ref: ../paths/FA2.36/pods-arrays-members.path.yaml + /api/2.37/pods/members: + $ref: ../paths/FA2.36/pods-members.path.yaml + /api/2.37/pods/performance: + $ref: ../paths/FA2.36/pods-performance.path.yaml + /api/2.37/pods/performance/by-array: + $ref: ../paths/FA2.13/pods-performance-by-array.path.yaml + /api/2.37/pods/performance/replication: + $ref: ../paths/FA2.4/pods-performance-replication.path.yaml + /api/2.37/pods/performance/replication/by-array: + $ref: ../paths/FA2.4/pods-performance-replication-by-array.path.yaml + /api/2.37/pods/space: + $ref: ../paths/FA2.34/pods-space.path.yaml + /api/2.37/pods/test: + $ref: ../paths/FA2.31/pods-test.path.yaml + /api/2.37/policies: + $ref: ../paths/FA2.24/policies.path.yaml + /api/2.37/policies/alert-watcher: + $ref: ../paths/FA2.33/policies-alert-watcher.path.yaml + /api/2.37/policies/alert-watcher/members: + $ref: ../paths/FA2.33/policies-alert-watcher-members.path.yaml + /api/2.37/policies/alert-watcher/rules: + $ref: ../paths/FA2.33/policies-alert-watcher-rules.path.yaml + /api/2.37/policies/alert-watcher/rules/test: + $ref: ../paths/FA2.33/policy-alert-watcher-rule-test.path.yaml + /api/2.37/policies/audit-file: + $ref: ../paths/FA2.35/policies-audit-file.path.yaml + /api/2.37/policies/audit-file/members: + $ref: ../paths/FA2.35/policies-audit-file-members.path.yaml + /api/2.37/policies/autodir: + $ref: ../paths/FA2.24/policies-autodir.path.yaml + /api/2.37/policies/autodir/members: + $ref: ../paths/FA2.24/policies-autodir-members.path.yaml + /api/2.37/policies/management-access: + $ref: ../paths/FA2.36/policies-management-access.path.yaml + /api/2.37/policies/management-access/members: + $ref: ../paths/FA2.36/policies-management-access-members.path.yaml + /api/2.37/policies/members: + $ref: ../paths/FA2.21/policies-members.path.yaml + /api/2.37/policies/nfs: + $ref: ../paths/FA2.32/policies-nfs.path.yaml + /api/2.37/policies/nfs/client-rules: + $ref: ../paths/FA2.29/policies-nfs-client-rules.path.yaml + /api/2.37/policies/nfs/members: + $ref: ../paths/FA2.32/policies-nfs-members.path.yaml + /api/2.37/policies/password: + $ref: ../paths/FA2.34/policies-password.path.yaml + /api/2.37/policies/quota: + $ref: ../paths/FA2.24/policies-quota.path.yaml + /api/2.37/policies/quota/members: + $ref: ../paths/FA2.21/policies-quota-members.path.yaml + /api/2.37/policies/quota/rules: + $ref: ../paths/FA2.21/policies-quota-rules.path.yaml + /api/2.37/policies/smb: + $ref: ../paths/FA2.32/policies-smb.path.yaml + /api/2.37/policies/smb/client-rules: + $ref: ../paths/FA2.21/policies-smb-client-rules.path.yaml + /api/2.37/policies/smb/members: + $ref: ../paths/FA2.32/policies-smb-members.path.yaml + /api/2.37/policies/snapshot: + $ref: ../paths/FA2.24/policies-snapshot.path.yaml + /api/2.37/policies/snapshot/members: + $ref: ../paths/FA2.21/policies-snapshot-members.path.yaml + /api/2.37/policies/snapshot/rules: + $ref: ../paths/FA2.21/policies-snapshot-rules.path.yaml + /api/2.37/ports: + $ref: ../paths/FA2.2/ports.path.yaml + /api/2.37/ports/initiators: + $ref: ../paths/FA2.2/port-initiators.path.yaml + /api/2.37/protection-group-snapshots: + $ref: ../paths/FA2.34/protection-group-snapshots.path.yaml + /api/2.37/protection-group-snapshots/replica: + $ref: ../paths/FA2.34/protection-group-snapshots-replica.path.yaml + /api/2.37/protection-group-snapshots/test: + $ref: ../paths/FA2.34/protection-group-snapshots-test.path.yaml + /api/2.37/protection-group-snapshots/transfer: + $ref: ../paths/FA2.29/protection-group-snapshots-transfer.path.yaml + /api/2.37/protection-groups: + $ref: ../paths/FA2.34/protection-groups.path.yaml + /api/2.37/protection-groups/host-groups: + $ref: ../paths/FA2.26/protection-groups-host-groups-members.path.yaml + /api/2.37/protection-groups/hosts: + $ref: ../paths/FA2.26/protection-groups-hosts-members.path.yaml + /api/2.37/protection-groups/performance/replication: + $ref: ../paths/FA2.26/protection-groups-performance-replication.path.yaml + /api/2.37/protection-groups/performance/replication/by-array: + $ref: ../paths/FA2.26/protection-groups-performance-replication-by-array.path.yaml + /api/2.37/protection-groups/space: + $ref: ../paths/FA2.34/protection-groups-space.path.yaml + /api/2.37/protection-groups/targets: + $ref: ../paths/FA2.37/protection-groups-targets.path.yaml + /api/2.37/protection-groups/volumes: + $ref: ../paths/FA2.26/protection-groups-volumes-members.path.yaml + /api/2.37/realms: + $ref: ../paths/FA2.36/realms.path.yaml + /api/2.37/realms/performance: + $ref: ../paths/FA2.36/realms-performance.path.yaml + /api/2.37/realms/space: + $ref: ../paths/FA2.36/realms-space.path.yaml + /api/2.37/remote-arrays: + $ref: ../paths/FA2.36/remote-arrays.path.yaml + /api/2.37/remote-pods: + $ref: ../paths/FA2.1/remote-pods.path.yaml + /api/2.37/remote-protection-group-snapshots: + $ref: ../paths/FA2.26/remote-protection-group-snapshots.path.yaml + /api/2.37/remote-protection-group-snapshots/test: + $ref: ../paths/FA2.26/remote-protection-group-snapshots-test.path.yaml + /api/2.37/remote-protection-group-snapshots/transfer: + $ref: ../paths/FA2.26/remote-protection-group-snapshots-transfer.path.yaml + /api/2.37/remote-protection-groups: + $ref: ../paths/FA2.1/remote-protection-groups.path.yaml + /api/2.37/remote-volume-snapshots: + $ref: ../paths/FA2.28/remote-volume-snapshots.path.yaml + /api/2.37/remote-volume-snapshots/transfer: + $ref: ../paths/FA2.1/remote-volume-snapshots-transfer.path.yaml + /api/2.37/sessions: + $ref: ../paths/FA2.4/sessions.path.yaml + /api/2.37/smi-s: + $ref: ../paths/FA2.2/smis.path.yaml + /api/2.37/smtp-servers: + $ref: ../paths/FA2.33/smtp-server.path.yaml + /api/2.37/snmp-agents: + $ref: ../paths/FA2.4/snmp-agent.path.yaml + /api/2.37/snmp-agents/mib: + $ref: ../paths/FA2.4/snmp-agent-mib.path.yaml + /api/2.37/snmp-managers: + $ref: ../paths/FA2.4/snmp-manager.path.yaml + /api/2.37/snmp-managers/test: + $ref: ../paths/FA2.4/snmp-manager-test.path.yaml + /api/2.37/software: + $ref: ../paths/FA2.11/software.path.yaml + /api/2.37/software-bundle: + $ref: ../paths/FA2.5/software-bundle.path.yaml + /api/2.37/software-check: + $ref: ../paths/FA2.9/software-checks.path.yaml + /api/2.37/software-installation-steps: + $ref: ../paths/FA2.4/software-installation-steps.path.yaml + /api/2.37/software-installations: + $ref: ../paths/FA2.37/software-installations.path.yaml + /api/2.37/software-patches: + $ref: ../paths/FA2.29/software-patches.path.yaml + /api/2.37/software-patches/catalog: + $ref: ../paths/FA2.29/software-patches-catalog.path.yaml + /api/2.37/software-versions: + $ref: ../paths/FA2.9/software-versions.path.yaml + /api/2.37/sso/saml2/idps: + $ref: ../paths/FA2.11/saml2-sso.path.yaml + /api/2.37/sso/saml2/idps/test: + $ref: ../paths/FA2.11/saml2-sso-test.path.yaml + /api/2.37/subnets: + $ref: ../paths/FA2.2/subnets.path.yaml + /api/2.37/subscription-assets: + $ref: ../paths/FA2.26/subscription-assets.path.yaml + /api/2.37/subscriptions: + $ref: ../paths/FA2.26/subscriptions.path.yaml + /api/2.37/support: + $ref: ../paths/FA2.35/support.path.yaml + /api/2.37/support-diagnostics/details: + $ref: ../paths/FA2.36/support-diagnostics-details.path.yaml + /api/2.37/support-diagnostics/settings: + $ref: ../paths/FA2.36/support-diagnostics-settings.path.yaml + /api/2.37/support/test: + $ref: ../paths/FA2.2/support-test.path.yaml + /api/2.37/syslog-servers: + $ref: ../paths/FA2.35/syslog-servers.path.yaml + /api/2.37/syslog-servers/settings: + $ref: ../paths/FA2.9/syslog-servers-settings.path.yaml + /api/2.37/syslog-servers/test: + $ref: ../paths/FA2.4/syslog-servers-test.path.yaml + /api/2.37/vchost-connections: + $ref: ../paths/FA2.33/vchost-connections.path.yaml + /api/2.37/vchosts: + $ref: ../paths/FA2.26/vchosts.path.yaml + /api/2.37/vchosts/certificates: + $ref: ../paths/FA2.33/vchost-certificate.path.yaml + /api/2.37/vchosts/endpoints: + $ref: ../paths/FA2.33/vchost-endpoint.path.yaml + /api/2.37/virtual-machine-snapshots: + $ref: ../paths/FA2.14/virtual-machine-snapshots.path.yaml + /api/2.37/virtual-machine-volume-snapshots: + $ref: ../paths/FA2.35/virtual-machine-volume-snapshots.path.yaml + /api/2.37/virtual-machines: + $ref: ../paths/FA2.14/virtual-machines.path.yaml + /api/2.37/volume-groups: + $ref: ../paths/FA2.36/volume-groups.path.yaml + /api/2.37/volume-groups/performance: + $ref: ../paths/FA2.4/volume-groups-performance.path.yaml + /api/2.37/volume-groups/space: + $ref: ../paths/FA2.34/volume-groups-space.path.yaml + /api/2.37/volume-groups/volumes: + $ref: ../paths/FA2.1/volume-groups-volumes-members.path.yaml + /api/2.37/volume-snapshots: + $ref: ../paths/FA2.34/volume-snapshots.path.yaml + /api/2.37/volume-snapshots/tags: + $ref: ../paths/FA2.9/volume-snapshots-tags.path.yaml + /api/2.37/volume-snapshots/tags/batch: + $ref: ../paths/FA2.2/volume-snapshots-tags-batch.path.yaml + /api/2.37/volume-snapshots/test: + $ref: ../paths/FA2.25/volume-snapshots-test.path.yaml + /api/2.37/volume-snapshots/transfer: + $ref: ../paths/FA2.29/volume-snapshots-transfer.path.yaml + /api/2.37/volumes: + $ref: ../paths/FA2.34/volumes.path.yaml + /api/2.37/volumes/batch: + $ref: ../paths/FA2.34/volumes-batch.path.yaml + /api/2.37/volumes/batch/test: + $ref: ../paths/FA2.33/volumes-batch-test.path.yaml + /api/2.37/volumes/diff: + $ref: ../paths/FA2.9/volumes-diff.path.yaml + /api/2.37/volumes/performance: + $ref: ../paths/FA2.4/volumes-performance.path.yaml + /api/2.37/volumes/performance/by-array: + $ref: ../paths/FA2.4/volumes-performance-by-array.path.yaml + /api/2.37/volumes/protection-groups: + $ref: ../paths/FA2.26/volumes-protection-groups-members.path.yaml + /api/2.37/volumes/space: + $ref: ../paths/FA2.34/volumes-space.path.yaml + /api/2.37/volumes/tags: + $ref: ../paths/FA2.9/volumes-tags.path.yaml + /api/2.37/volumes/tags/batch: + $ref: ../paths/FA2.2/volumes-tags-batch.path.yaml + /api/2.37/volumes/test: + $ref: ../paths/FA2.33/volumes-test.path.yaml + /api/2.37/volumes/volume-groups: + $ref: ../paths/FA2.1/volumes-volume-groups-members.path.yaml + /api/api_version: + $ref: ../paths/FA2.0/api_version.path.yaml + /oauth2/1.0/token: + $ref: ../paths/TEx-v2/oauth-token.path.yaml + /oauth2_pub_priv_key_pair: + get: + description: "Returns a public and private key pair, This is not part of the\ + \ FlashArray API, \nit's a helper endpoint making it easier to generate an\ + \ oauth2 token_id in this Swagger UI. \nThey keys are generated in the Docker\ + \ container running on this machine.\n\nRecommend to NOT use this API but\ + \ to use OpenSSL instead for production use cases:\n You can generate a public\ + \ and private RSA key pair like this:\n\n openssl genrsa -des3 -out private.pem\ + \ 2048\n \n That generates a 2048-bit RSA key pair, encrypts them with\ + \ a password you provide and writes them to a file. \n You need to next\ + \ extract the public key file. You will use this, for instance, on your web\ + \ server to encrypt \n content so that it can only be read with the private\ + \ key.\n \n Export the RSA Public Key to a File\n This is a command\ + \ that is\n \n openssl rsa -in private.pem -outform PEM -pubout -out\ + \ public.pem" + responses: + 200: + description: Token Generated + schema: + properties: + private_key: + description: Private key in PEM format. + type: string + public_key: + description: Public key in PEM format. + type: string + type: object + tags: + - Auth Helpers + /oauth2_token_from_private_key: + post: + consumes: + - text/plain + description: "Authenticates to Flasharray, This returns a token_id (think session\ + \ id), from an existing API Client, \nThis is not part of the FlashArray API,\ + \ it's a helper endpoint making it easy to generate an \noauth2 token_id in\ + \ this Swagger UI. The private key is being passed into the Docker container\ + \ in\norder to sign the JWT token. Take a look at the Docker container output\ + \ to see more details \nof what is happening.\n\nCopy the output value, Authorization\ + \ header, and then click on the green Authorize button at the \ntop of the\ + \ page. Paste in the value into " + parameters: + - description: Issuer value displayed in the FlashArray API Registration page + or pureapiclient list ) by default it's the same name as API Client + in: header + name: issuer_name + type: string + - description: Client Id value displayed in the FlashArray API Registration + page or pureapiclient list + in: header + name: client_id + type: string + - description: Key Id value displayed in the FlashArray API Registration page + or pureapiclient list + in: header + name: key_id + type: string + - description: The name of a valid user on the FlashArray that will be authenticated + to. + in: header + name: username + type: string + - description: Private key in PEM format that was used to create the Public + key for this API Client specified as the issuer in this call. + in: body + name: private_key + required: true + schema: + type: string + produces: + - application/json + responses: + 200: + description: Token Generated + schema: + example: + username: pureuser + properties: + Authorization: + description: An OAuth bearer token to be used in the Authorization + header for authorization to API endpoints. + type: string + description: + desciption: How to use token + type: string + type: object + tags: + - Auth Helpers +produces: +- application/json +security: +- OAuth2-Bearer-Token: [] +- X-Auth-Token: [] +securityDefinitions: + OAuth2-Bearer-Token: + in: header + name: Authorization + type: apiKey + X-Auth-Token: + in: header + name: x-auth-token + type: apiKey +swagger: '2.0' +tags: +- description: A set of endpoints not in the Purity API, but to make OAuth using this + tool simple and easy to understand. + name: Auth Helpers +- description: Pure Storage uses the OAuth 2.0 Token Exchange authorization grant + and JSON Web Tokens (JWTs) to authenticate to the Pure Storage REST API. Before + you can exchange the ID token for an access token, create and enable the API client + to generate the `key_id`, `id`, and `issuer` values. These values will be used + as JWT claims for the `subject_token` parameter. + name: Authorization +- 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. + name: Active Directory +- description: The FlashArray has a single default administrative account named pureuser. + The administrator can add, delete, and modify administrators on the array. Administrators + are assigned management access policies to give different levels of permissions. + name: Administrators +- description: Alerts indicate significant events that occur on an array, including + whenever a component degrades or the capacity threshold of the component is reached. + name: Alerts +- description: Alert watchers receive email notifications when alerts occur on an + array. + name: Alert Watchers +- description: An API client represents an identity type. API clients are created + on the array. To create an API client, register and then enable it on the array. + After the API client has been created, the user name (`sub`) and identity tokens + (`kid` and `aud` tokens) that are issued by the API client are used as claims + for the JSON Web Token that you create to authenticate into the REST API. + name: API Clients +- description: Apps that extend array functionality can be integrated into the Purity//FA + operating system. + name: Apps +- description: Array features provide the ability to configure settings that affect + the operation of the array as a whole and monitor array I/O performance. + name: Arrays +- description: Manages connections between arrays. + name: Array Connections +- description: Audit trail records describe administrative actions performed by a + user to modify the configuration of an array. + name: Audits +- description: Purity//FA creates a self-signed certificate and private key when you + start the system for the first time. You can use the default certificate, change + the certificate attributes, create a new self-signed certificate, or import an + SSL certificate signed by a certificate authority. + name: Certificates +- description: Certificate groups, also known as certificate bundles, are collections + of digital certificates. Each certificate can belong to one or more groups in + order to serve different purposes. + name: Certificate Groups +- description: A connection gives hosts access to volumes on the array. + name: Connections +- description: Default protection is a list of protection groups that are applied + to newly created volumes. Volumes can opt out of the default protection at creation. + The pod's `default_protections` defaults to the array's `default_protections` + at pod creation. Default protection can be configured on the array and the pod. + name: Container Default Protections +- description: Controller data includes the name, mode, FlashArray model, Purity//FA + software version, and status of each controller in the array. + name: Controllers +- description: Important file system directories should be set up as managed directories. + Managed directories can have policies attached to them. Managed directories differ + from standard directories in that they provide space reporting and metrics. + name: Directories +- description: Managed directory exports are created by adding NFS or SMB export policies + to managed directories. + name: Directory Exports +- description: Directory quotas provide the ability to set capacity limits on managed + directories. + name: Directory Quotas +- description: Manages directory service configurations for integration with LDAP + servers (e.g. Active Directory and OpenLDAP) in order to support various array + services. + name: Directory Services +- description: Directory snapshots are created manually or by adding snapshot policies + to managed directories. Each snapshot policy can be re-used for multiple directories. + name: Directory Snapshots +- description: DNS attributes include the domain suffix, static name servers, mode + (static or DHCP), and search domain. The configured attributes can be listed. + name: DNS +- description: Drive data includes the name, type, status, capacity, protocol and + other information for all flash, NVRAM, and cache modules in an array. + name: Drives +- description: A FlashArray can contain up to 24 separate file systems, each with + a number of directories that can be exported via supported protocols. Clients, + using Active Directory or LDAP, can connect and access these exports using SMB + or NFS. + name: File Systems +- description: A fleet is a collection of Arrays. + name: Fleets +- description: Operational status is reported by most of the hardware components in + an array, including the chassis, controller, and storage shelf. + name: Hardware +- description: Host groups implement consistent connections between a set of hosts + and one or more volumes. Connections are consistent in the sense that all hosts + associated with a host group address a volume connected to the group by the same + LUN. Host groups are typically used to provide a common view of storage volumes + to the hosts in a clustered application. + name: Host Groups +- description: Hosts organize the storage network addresses (iSCSI Qualified Names, + NVMe qualified names, or Fibre Channel world wide names) of client computers to + identify the host's intiators. Hosts also control communications between clients + and volumes. After a volume has been created, establish a host-volume connection + so that the host can read data from and write data to the volume. + name: Hosts +- description: The Key Management Interoperability Protocol (KMIP) server is used + in combination with the Pure Storage Rapid Data Locking (RDL) feature and EncryptReduce + feature to further secure the encrypted data on a FlashArray. + name: KMIP +- description: Log Targets to be used to send management or data audit logs. + name: Log Targets +- description: During a maintenance window, alerts are suppressed that are related + to connections, paths, ports, and other resources that are down during maintenance. + name: Maintenance Windows +- description: Manages the interfaces and the network connection attributes of the + array. + name: Network Interfaces +- description: The offload feature enables system administrators to replicate point-in-time + volume snapshots from the array to an external storage system for long-term retention. + Each offload target represents an external storage system, such as an Azure Blob + container, NFS device, or S3 bucket, to where Purity//FA volume snapshots can + be replicated. + name: Offloads +- description: Synchronous replication is managed through pods. A pod representing + a collection of protection groups and volumes is created on one array and stretched + to another array, resulting in fully synchronized writes between the two arrays. + A pod can contain a mix of volumes, and protection groups with member volumes. + Writes to the pod coming into either array are immediately synchronized and seen + on both arrays. + name: Pods +- description: Pod replica links are created by associating a source pod with a demoted + pod, making the demoted pod the target pod of the source pod. The direction of + the replica link is from the promoted source pod to the demoted target pod. Replica + links can be created in either direction between the same two FlashArrays. The + target pod of a replica link cannot be on the same FlashArray as the source pod. + name: Pod Replica Links +- description: Policies are used to create exports (i.e., shares) and schedule snapshots. + NFS and SMB policies can be created and have one or more rules applied to them. + Each policy can be reused, creating exports for a number of managed directories. + name: Policies +- description: The ports on a FlashArray are assigned iSCSI Qualified Names (IQNs), + NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs). + name: Ports +- description: A protection group defines a set of volumes, hosts, or host groups + (called members) that are protected together through snapshots with point-in-time + consistency across the member volumes. The members within the protection group + have common data protection requirements and the same snapshot, replication, and + retention schedules. + name: Protection Groups +- description: Protection group snapshots capture the content of all volumes on the + source array for the specified protection group at a single point in time. + name: Protection Group Snapshots +- description: A realm is an administrative domain, a data container, and a namespace + for pods, hosts, and host groups. + name: Realms +- description: Remote arrays provide the ability to list and manage all the remote + arrays known to an array. + name: Remote Arrays +- description: A remote pod represents a pod that is on a connected array but not + stretched to this array. + name: Remote Pods +- description: A remote protection group represents a protection group that resides + on an offload target with the source side of the remote protection group being + another array that is connected to the local array. The local array can only see + the remote protection groups of other arrays if the two arrays are connected. + name: Remote Protection Groups +- description: A remote protection group snapshot represents a protection group snapshot + that resides on an offload target with the source side of the remote protection + group snapshot being another array that is connected to the local array. The local + array can only see the remote protection group snapshots of other arrays if the + two arrays are connected. + name: Remote Protection Group Snapshots +- description: A remote volume snapshot represents a volume snapshot that resides + on an offload target with the source side of the remote volume snapshot being + another array that is connected to the local array. The local array can only see + the remote volume snapshots of other arrays if the two arrays are connected. + name: Remote Volume Snapshots +- description: SAML2 SSO allows customers to configure settings of SAML2 service provider + and identity provider. It provides a multi-factor authentication (MFA) mechanism + for customers to log in to FlashArray. + name: SAML2 SSO +- description: Manages Purity//FA login and user session data. + name: Sessions +- description: Manages the Pure Storage Storage Management Initiative Specification + (SMI-S). + name: SMI-S +- description: Manages connections to Simple Network Management Protocol (SMTP) managers. + name: SMTP +- description: Manages connections to Simple Network Management Protocol (SNMP) agents. + name: SNMP Agents +- description: Manages connections to Simple Network Management Protocol (SNMP) managers. + name: SNMP Managers +- description: Software to be installed on the array. + name: Software +- description: Manages the subnets and VLANs used to organize the network interfaces. + name: Subnets +- description: Provides information about subscription offerings. + name: Subscriptions +- description: Provides information about subscription assets. + name: Subscription Assets +- description: Enables Support to fix bugs and help customers solve problems. Support + tools include proxy, phonehome, and remote assist. + name: Support +- description: Copied to Log Targets/Syslog for more organized way to handle all log + targets. Both endpoints are identical. We encourage our users to use Log Targets/Syslog. + name: Syslog +- description: A vchost connection is between a protocol endpoint and vchost. In the + context of vchost-connection, the vchost represents a vCenter, and the protocol + endpoint is used to represent a storage container. Creating a vchost connection + gives the vCenter access to the storage container. If `all_vchosts` is set to + `true`, the container will be accessible to all vchosts. + name: Vchost Connections +- description: A volume represents a container that manages the storage space on the + array. After a volume has been created, host-volume connections must be established + so that the host can read data from and write data to the volume. Volume data + should be protected using asynchronous replication to a remote array, synchronous + replication between remote arrays, and replication to external storage systems. + name: Volumes +- description: Volume groups organize volumes into logical groupings. If virtual volumes + are configured, each volume group on the FlashArray array represents its associated + virtual machine, and inside each of those volumes groups are the FlashArray volumes + that are assigned to the virtual machine. Volume groups that are associated with + virtual machines have names that begin with `vvol-` and end with the virtual machine + name. + name: Volume Groups +- description: Volume snapshots are immutable, point-in-time images of the contents + of one or more volumes. There are two types of volume snapshots: volume snapshots + and protection group volume snapshots. A volume snapshot is a snapshot that captures + the contents of a single volume. A protection group volume snapshot is a volume + snapshot that is created from a group of volumes that are part of the same protection + group. All of the volume snapshots created from a protection group snapshot are + point-in-time consistent with each other. + name: Volume Snapshots diff --git a/html/specs/FA2.4.spec.yaml b/html/specs/FA2.4.spec.yaml index 517d995e..595c2740 100644 --- a/html/specs/FA2.4.spec.yaml +++ b/html/specs/FA2.4.spec.yaml @@ -163,11 +163,11 @@ definitions: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.4/software.yaml diff --git a/html/specs/FA2.5.spec.yaml b/html/specs/FA2.5.spec.yaml index a654b538..09a1d35b 100644 --- a/html/specs/FA2.5.spec.yaml +++ b/html/specs/FA2.5.spec.yaml @@ -163,11 +163,11 @@ definitions: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.4/software.yaml diff --git a/html/specs/FA2.6.spec.yaml b/html/specs/FA2.6.spec.yaml index 0f4aed5c..abbb1266 100644 --- a/html/specs/FA2.6.spec.yaml +++ b/html/specs/FA2.6.spec.yaml @@ -165,11 +165,11 @@ definitions: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.4/software.yaml diff --git a/html/specs/FA2.7.spec.yaml b/html/specs/FA2.7.spec.yaml index af116edf..11672c2c 100644 --- a/html/specs/FA2.7.spec.yaml +++ b/html/specs/FA2.7.spec.yaml @@ -169,11 +169,11 @@ definitions: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.4/software.yaml diff --git a/html/specs/FA2.8.spec.yaml b/html/specs/FA2.8.spec.yaml index 19f5fbbf..881d4823 100644 --- a/html/specs/FA2.8.spec.yaml +++ b/html/specs/FA2.8.spec.yaml @@ -169,11 +169,11 @@ definitions: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.4/software.yaml diff --git a/html/specs/FA2.9.spec.yaml b/html/specs/FA2.9.spec.yaml index a4083fb8..6418a109 100644 --- a/html/specs/FA2.9.spec.yaml +++ b/html/specs/FA2.9.spec.yaml @@ -169,11 +169,11 @@ definitions: $ref: ../models/FA2.4/session.yaml Smis: $ref: ../models/FA2.2/smis.yaml - Smtp: + SmtpServer: $ref: ../models/FA2.4/smtp-server.yaml SnmpAgent: $ref: ../models/FA2.4/snmp-agent.yaml - SnmpManagers: + SnmpManager: $ref: ../models/FA2.4/snmp-manager.yaml Software: $ref: ../models/FA2.9/software.yaml diff --git a/html/specs/FB2.15.spec.yaml b/html/specs/FB2.15.spec.yaml index 5aff1601..0fc58cf8 100644 --- a/html/specs/FB2.15.spec.yaml +++ b/html/specs/FB2.15.spec.yaml @@ -2,7 +2,7 @@ consumes: - application/json definitions: ActiveDirectory: - $ref: ../models/FB2.15/active-directory.yaml + $ref: ../models/FB2.12/active-directory.yaml Admin: $ref: ../models/FB2.3/admin.yaml AdminApiToken: @@ -44,7 +44,7 @@ definitions: Blade: $ref: ../models/FB2.0/blade.yaml Bucket: - $ref: ../models/FB2.14/bucket.yaml + $ref: ../models/FB2.15/bucket.yaml BucketAccessPolicy: $ref: ../models/FB2.15/bucket-access-policy.yaml BucketAccessPolicyRule: @@ -74,7 +74,7 @@ definitions: DirectoryServiceRole: $ref: ../models/FB2.14/directory-service-role.yaml Dns: - $ref: ../models/FB2.15/dns.yaml + $ref: ../models/FB2.0/dns.yaml Drive: $ref: ../models/FB2.9/drive.yaml EULA: @@ -85,8 +85,6 @@ definitions: $ref: ../models/FB2.10/file-session.yaml FileSystem: $ref: ../models/FB2.15/file-system.yaml - FileSystemExport: - $ref: ../models/FB2.15/file-system-export.yaml FileSystemGroupPerformance: $ref: ../models/FB2.0/file-system-group-performance.yaml FileSystemLockNLMReclamation: @@ -110,7 +108,7 @@ definitions: HardwareConnectorPerformance: $ref: ../models/FB2.3/hardware-connector-performance.yaml Keytab: - $ref: ../models/FB2.15/keytab.yaml + $ref: ../models/FB2.0/keytab.yaml KeytabFileBase64: $ref: ../models/FB2.0/keytab-file-base64.yaml KeytabFileBinary: @@ -130,7 +128,7 @@ definitions: NetworkAccessPolicyRule: $ref: ../models/FB2.13/network-access-policy-rule.yaml NetworkInterface: - $ref: ../models/FB2.15/network-interface.yaml + $ref: ../models/FB2.0/network-interface.yaml NetworkInterfacePing: $ref: ../models/FB2.6/network-interface-ping.yaml NetworkInterfaceTrace: @@ -148,7 +146,7 @@ definitions: ObjectStoreAccessPolicyRule: $ref: ../models/FB2.11/policy-rule-object-access.yaml ObjectStoreAccount: - $ref: ../models/FB2.12/object-store-account.yaml + $ref: ../models/FB2.15/object-store-account.yaml ObjectStoreRemoteCredentials: $ref: ../models/FB2.0/object-store-remote-credentials.yaml ObjectStoreUser: @@ -189,8 +187,6 @@ definitions: $ref: ../models/FB2.15/ssh-certificate-authority-policy.yaml Saml2Sso: $ref: ../models/FB2.15/saml2-sso.yaml - Server: - $ref: ../models/FB2.15/server.yaml Session: $ref: ../models/FB2.14/session.yaml SmbClientPolicy: @@ -247,7 +243,7 @@ info: x-pure-description-ref: ../custom_descriptions/FB-api-introduction.md paths: /api/2.15/active-directory: - $ref: ../paths/FB2.15/active-directory.path.yaml + $ref: ../paths/FB2.14/active-directory.path.yaml /api/2.15/active-directory/test: $ref: ../paths/FB2.14/active-directory-test.path.yaml /api/2.15/admins: @@ -311,7 +307,7 @@ paths: /api/2.15/bucket-replica-links: $ref: ../paths/FB2.14/bucket-replica-links.path.yaml /api/2.15/buckets: - $ref: ../paths/FB2.14/buckets.path.yaml + $ref: ../paths/FB2.15/buckets.path.yaml /api/2.15/buckets/bucket-access-policies: $ref: ../paths/FB2.15/bucket-access-policies.path.yaml /api/2.15/buckets/bucket-access-policies/rules: @@ -343,11 +339,9 @@ paths: /api/2.15/directory-services/test: $ref: ../paths/FB2.14/directory-service-test.path.yaml /api/2.15/dns: - $ref: ../paths/FB2.15/dns.path.yaml + $ref: ../paths/FB2.14/dns.path.yaml /api/2.15/drives: $ref: ../paths/FB2.14/drives.path.yaml - /api/2.15/file-system-exports: - $ref: ../paths/FB2.15/file-system-exports.path.yaml /api/2.15/file-system-replica-links: $ref: ../paths/FB2.14/file-system-replica-links.path.yaml /api/2.15/file-system-replica-links/policies: @@ -391,7 +385,7 @@ paths: /api/2.15/hardware-connectors/performance: $ref: ../paths/FB2.14/hardware-connectors-performance.path.yaml /api/2.15/keytabs: - $ref: ../paths/FB2.15/keytabs.path.yaml + $ref: ../paths/FB2.14/keytabs.path.yaml /api/2.15/keytabs/download: $ref: ../paths/FB2.14/keytabs-download.path.yaml /api/2.15/keytabs/upload: @@ -417,7 +411,7 @@ paths: /api/2.15/network-access-policies/rules: $ref: ../paths/FB2.14/network-access-policies-rules.path.yaml /api/2.15/network-interfaces: - $ref: ../paths/FB2.15/network-interfaces.path.yaml + $ref: ../paths/FB2.14/network-interfaces.path.yaml /api/2.15/network-interfaces/ping: $ref: ../paths/FB2.14/network-interfaces-ping.path.yaml /api/2.15/network-interfaces/trace: @@ -437,7 +431,7 @@ paths: /api/2.15/object-store-access-policy-actions: $ref: ../paths/FB2.14/object-store-access-policy-actions.path.yaml /api/2.15/object-store-accounts: - $ref: ../paths/FB2.14/object-store-accounts.path.yaml + $ref: ../paths/FB2.15/object-store-accounts.path.yaml /api/2.15/object-store-remote-credentials: $ref: ../paths/FB2.14/object-store-remote-credentials.path.yaml /api/2.15/object-store-users: @@ -478,8 +472,6 @@ paths: $ref: ../paths/FB2.14/rapid-data-locking-test.path.yaml /api/2.15/roles: $ref: ../paths/FB2.14/roles.path.yaml - /api/2.15/servers: - $ref: ../paths/FB2.15/servers.path.yaml /api/2.15/sessions: $ref: ../paths/FB2.14/sessions.path.yaml /api/2.15/smb-client-policies: @@ -684,7 +676,7 @@ tags: to generate the `key_id`, `id`, and `issuer` values. These values will be used as JWT claims for the `subject_token` parameter. name: Authorization -- description: Active Directory configuration joins a server to the domain and manages +- description: Active Directory configuration joins the array to the domain and manages its computer account. Authentication for NFS or SMB is performed using Kerberos. This configuration is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries. @@ -751,10 +743,6 @@ tags: - description: Manages the creation, attributes, and deletion of file systems on the array. name: File Systems -- description: Manages the creation, attributes, and deletion of file system exports. - Exports link either an NFS Export Policy or a SMB Client Policy, a file system, - and a server. - name: File System Exports - description: File system replication requires a replica link that connects a source array to a remote target. The configuration of a replica link includes policies, file system names, remote names, and replication status information. @@ -837,6 +825,9 @@ tags: that they require be encoded in certificates to authenticate. These policies can be applied to one or more users, or as a default for all users. name: Policies - SSH Certificate Authority +- description: Manages WORM data for file systems. These policies are composed of + retention periods, lock type, and auto-commit status. + name: Policies - WORM Data - description: Public Keys can be configured for reference in other configurations as signing keys are used to verify cryptographic signatures. name: Public Keys @@ -858,9 +849,6 @@ tags: and identity provider. It provides a multi-factor authentication (MFA) mechanism for customers to log in to FlashBlade. name: SAML2 SSO -- description: Manages the properties of servers. Servers are network and identity - management access points for data. - name: Servers - description: Displays Purity//FB login and user session data. name: Sessions - description: Manages Simple Mail Transfer Protocol (SMTP) settings. SMTP allows diff --git a/html/specs/FB2.8.spec.yaml b/html/specs/FB2.8.spec.yaml index 3555c9aa..9619b0c6 100644 --- a/html/specs/FB2.8.spec.yaml +++ b/html/specs/FB2.8.spec.yaml @@ -155,7 +155,7 @@ definitions: $ref: ../models/FB2.2/resource-performance-replication.yaml Role: $ref: ../models/FB2.0/role.yaml - SMPT: + SMTP: $ref: ../models/FB2.0/smtp-server.yaml SNMPManager: $ref: ../models/FB2.0/snmp-manager.yaml diff --git a/html/specs/Pure1-1.0.spec.yaml b/html/specs/Pure1-1.0.spec.yaml index 0a095c48..59947d47 100644 --- a/html/specs/Pure1-1.0.spec.yaml +++ b/html/specs/Pure1-1.0.spec.yaml @@ -201,8 +201,8 @@ tags: name: Hardware - description: Provides information about FlashBlade hardware connectors. name: Hardware Connectors -- description: Provides information about historical metrics for arrays, volumes, - file systems and pods. +- description: Provides information about historical metrics for arrays, buckets, + directories, file systems, pods, subscription licenses, and volumes. name: Metrics - description: Provides information about network interfaces available on arrays. name: Network Interfaces diff --git a/html/specs/Pure1-1.1.spec.yaml b/html/specs/Pure1-1.1.spec.yaml index 1046ccc1..0a99a752 100644 --- a/html/specs/Pure1-1.1.spec.yaml +++ b/html/specs/Pure1-1.1.spec.yaml @@ -215,8 +215,8 @@ tags: name: Hardware Connectors - description: Provides information about Pure1 subscription invoices. name: Invoices -- description: Provides information about historical metrics for arrays, volumes, - file systems and pods. +- description: Provides information about historical metrics for arrays, buckets, + directories, file systems, pods, subscription licenses, and volumes. name: Metrics - description: Provides information about network interfaces available on arrays. name: Network Interfaces diff --git a/html/specs/Pure1-1.2.spec.yaml b/html/specs/Pure1-1.2.spec.yaml index eed31abc..55ca4093 100644 --- a/html/specs/Pure1-1.2.spec.yaml +++ b/html/specs/Pure1-1.2.spec.yaml @@ -219,8 +219,8 @@ tags: name: Hardware Connectors - description: Provides information about Pure1 subscription invoices. name: Invoices -- description: Provides information about historical metrics for arrays, volumes, - file systems and pods. +- description: Provides information about historical metrics for arrays, buckets, + directories, file systems, pods, subscription licenses, and volumes. name: Metrics - description: Provides information about network interfaces available on arrays. name: Network Interfaces