openapi: 3.0.1 info: title: FlashArray REST Active Directory Software API version: '2.52' description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries. ' servers: - url: / tags: - name: Software description: 'Software to be installed on the array. ' paths: /api/2.52/software: get: tags: - Software summary: Pure Storage List Software Packages description: 'Displays a list of available software packages. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Versions' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareGetResponse' post: tags: - Software summary: Pure Storage Create a Software Package description: 'Creates a software package download. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SoftwarePost' required: true x-codegen-request-body-name: software responses: '200': description: 'The software package download was initiated. The download will start soon. ' content: application/json: schema: $ref: '#/components/schemas/SoftwareResponse' x-codegen-request-body-name: software delete: tags: - Software summary: Pure Storage Delete a Software Package description: 'Deletes a software package specified by software name and version. A software package being used for an installation can be deleted if the installation is `downloading`, `downloaded`, `aborted`, or `finished`. If the software package is currently `downloading`, the download will be cancelled. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Software_versions' responses: '200': description: OK content: {} /api/2.52/software-bundle: get: tags: - Software summary: Pure Storage List Software-bundle description: 'Displays a list of software bundles. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareBundleGetResponse' post: tags: - Software summary: Pure Storage Create Software-bundle description: 'Creates and initiates a software bundle download. ' parameters: - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SoftwareBundlePost' required: true x-codegen-request-body-name: source responses: '200': description: 'The software bundle has started downloading successfully. ' content: application/json: schema: $ref: '#/components/schemas/SoftwareBundleResponse' x-codegen-request-body-name: source /api/2.52/software-check: get: tags: - Software summary: Pure Storage List Software Check Tasks description: Displays a list of software check tasks. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Software_versions' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareChecksGetResponse' post: tags: - Software summary: Pure Storage Create a Software Check Task description: 'Creates a software check task. If there are no previously queued or running software check tasks, the new task immediately starts. Otherwise, it is queued and starts once all previously queued or running software check tasks finish. To create a task, use a software name and version. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Software_versions' responses: '200': description: 'The software check record was created successfully. ' content: application/json: schema: $ref: '#/components/schemas/SoftwareChecksResponse' delete: tags: - Software summary: Pure Storage Delete a Software Check Task description: 'Deletes a software check task specified by software name and version. The check task must be queued. If the check task is running or passed/failed then the task cannot be deleted. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Software_versions' responses: '200': description: OK content: {} /api/2.52/software-installations: get: tags: - Software summary: Pure Storage List Software Upgrades description: 'Displays a list of software upgrades, including currently running and past upgrades. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Software_ids' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationsGetResponse' post: tags: - Software summary: Pure Storage Create a Software Upgrade description: 'Creates and initiates a software upgrade. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Software_idsRequired' requestBody: content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationPost' required: true x-codegen-request-body-name: software-installations responses: '200': description: 'The software upgrade record was created successfully. ' content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationsResponse' x-codegen-request-body-name: software-installations patch: tags: - Software summary: Pure Storage 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: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Software_installation_command_required' - $ref: '#/components/parameters/Software_installation_current_step_idRequired' requestBody: content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationPatch' required: false x-codegen-request-body-name: software-installations responses: '200': description: 'The `command` was issued and/or `override_checks` was updated. ' content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationsResponse' x-codegen-request-body-name: software-installations /api/2.52/software-installation-steps: get: tags: - Software summary: Pure Storage List Software Upgrade Steps description: Displays a list of currently running and completed software upgrade steps. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Software_installation_ids' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareInstallationStepsGetResponse' /api/2.52/software-patches: get: tags: - Software summary: Pure Storage List Software Patches description: 'Displays a list of software patches. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwarePatchesGetResponse' post: tags: - Software summary: Pure Storage Create a Software Patch description: 'Creates software patch download and installation. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - name: allow_ha_reduction in: query description: 'If Software Patch has ha_reduction_required set to true, `allow_ha_reduction` must be set to `true` for Software Patch installation. ' schema: type: boolean - name: name in: query description: Name of software patch to install required: true schema: type: string responses: '200': description: 'The software patch download was initiated. The download and installation will start soon. ' content: application/json: schema: $ref: '#/components/schemas/SoftwarePatchesResponse' /api/2.52/software-patches/catalog: get: tags: - Software summary: Pure Storage List Available Software Patches description: 'Displays a list of available software patches. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwarePatchesGetResponse' /api/2.52/software-versions: get: tags: - Software summary: Pure Storage List Software Versions description: 'Displays a list of software versions. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareVersionsGetResponse' /api/2.26/software-bundle: get: x-pure-block-remote-execution: true tags: - Software summary: Pure Storage List Software-bundle description: 'Displays a list of software bundles including the downloads which did not succeed. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SoftwareBundleGetResponse' post: x-pure-block-remote-execution: true tags: - Software summary: Pure Storage Create Software-bundle description: 'Creates and initiates a software bundle download. The upgrade won''t start automatically after the download finishes. Only one software is being downloaded at a time. Any previous currently running download will be cancelled. The endpoint is not idempotent. ' parameters: - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SoftwareBundlePost_2' required: true x-codegen-request-body-name: source responses: '200': description: 'The software bundle has started downloading successfully. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/SoftwareBundleResponse' x-codegen-request-body-name: source /api/2.26/software-check: get: tags: - Software summary: Pure Storage List Software Check Tasks description: Displays a list of software check tasks. parameters: - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Software_versions' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwareChecksGetResponse' post: tags: - Software summary: Pure Storage Create a Software Check Task description: 'Creates a software check task. To create a task, use a software name and version. If a task is already running, an error is returned. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Software_names' - $ref: '#/components/parameters/Software_versions' responses: '200': description: 'The software check record was created successfully. ' content: application/json: schema: $ref: '#/components/schemas/SoftwareChecksResponse' '403': description: Another instance is already running content: {} /api/2.26/software-patches: get: tags: - Software summary: Pure Storage List Software Patches description: 'Displays a list of software patches. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SoftwarePatchesGetResponse' post: tags: - Software summary: Pure Storage Create a Software Patch description: 'Creates software patch download and installation. ' parameters: - $ref: '#/components/parameters/XRequestId' - name: allow_ha_reduction in: query description: 'If Software Patch has ha_reduction_required set to true, `allow_ha_reduction` must be set to `true` for Software Patch installation. ' schema: type: boolean - name: name in: query description: Name of software patch to install required: true schema: type: string responses: '200': description: 'The software patch download was initiated. The download and installation will start soon. ' content: application/json: schema: $ref: '#/components/schemas/SoftwarePatchesResponse' components: schemas: SoftwareInstallationStepsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareInstallationStep' SoftwareBundlePost: description: The source of the software bundle. type: object properties: source: description: The source of the software bundle. Accepts HTTP, HTTPS or FTP, and paths. type: string example: ftp://local/upgrade_bundle.sh _override_check: type: object properties: args: description: 'The name of the specific check within the override check to ignore so that the system can continue with the software upgrade. The `name` parameter of the override check must be specified with the `args` parameter. For example, if the HostIOCheck check fails on hosts host01 and host02, the system displays a list of these host names in the failed check. To override the HostIOCheck checks for host01 and host02, set `name=HostIOCheck`, and set `args=host01,host02`. Enter multiple `args` in comma-separated format. Note that not all checks have `args` values. ' type: string example: host1,host2,host3 name: description: 'The name of the upgrade check to be overridden so the software upgrade can continue if the check failed or is anticipated to fail during the upgrade process. Overriding the check forces the system to ignore the check failure and continue with the upgrade. If the check includes more specific checks that failed or are anticipated to fail, set them using the `args` parameter. For example, the HostIOCheck check may include a list of hosts that have failed or are anticipated to fail the upgrade check. ' type: string example: HostIOCheck persistent: description: 'If set to `true`, the system always ignores the failure of the specified upgrade check and continues with the upgrade process. If set to `false`, the system ignores the failure of the specified upgrade check until the upgrade check finishes and the upgrade process is continued. For example, the `continue` command is successfully issued in an `interactive` mode, or the first upgrade check step successfully finishes in a `one-click` mode. ' type: boolean SoftwareVersion: description: Version candidates for software upgrade. type: object properties: details: description: 'The description of the version. ' type: string name: description: 'The name of the software. ' type: string example: Purity//FA release_family: description: 'The major and minor release number of the version. ' type: string example: 6.2.0 upgrade_hops: description: 'The list of software versions the upgrade will go through. ' type: array items: type: string description: 'A software version in the upgrade path. ' example: - 6.1.3 - 6.2.0 version: description: 'The version of the software. ' type: string example: 6.2.0 SoftwareChecksResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareCheck' SoftwareInstallationPatch: type: object properties: add_override_checks: description: 'Adds the specified checks to the current list of override checks. ' type: array items: $ref: '#/components/schemas/_override_check' SoftwareBundle: allOf: - $ref: '#/components/schemas/_builtInRelationship' - description: The software bundle to be installed on the array. type: object properties: bytes_downloaded: description: 'The number of bytes downloaded. ' type: integer format: int64 bytes_total: description: 'The total number of bytes to download. ' type: integer format: int64 created: description: 'The creation time in milliseconds since the UNIX epoch. ' type: number format: integer details: description: 'The detailed reason for the `status`. ' type: string download_progress: description: 'The download progress in decimal format. ' type: number format: float software_name: description: 'The name of the software to be tested by the upgrade checks. ' type: string example: Purity//FA software_version: description: 'The version of the software to be tested by the upgrade checks. ' type: string example: 6.2.0 source: description: 'The location of the upgrade bundle. ' type: string example: ftp://local/upgrade_bundle.sh status: description: 'The status of the software bundle. Valid values are `downloading`, `failed`, `ready`, and `verifying`. A status of `downloading` indicates that the array is downloading the upgrade bundle. A status of `failed` indicates that the array has failed to download the upgrade bundle. A status of `ready` indicates that the upgrade bundle is ready to be installed. A status of `verifying` indicates that the array is verifying the upgrade bundle. ' type: string example: downloading SoftwareInstallationsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareInstallation' _reference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string x-aliases: - _referenceWithoutType _start_end_time: description: A resource with a start time and end time. type: object properties: end_time: description: End time in milliseconds since the UNIX epoch. type: integer format: int64 example: 1567026888000 x-minimum: 0 start_time: description: Start time in milliseconds since the UNIX epoch. type: integer format: int64 example: 1567026779000 x-minimum: 0 SoftwareInstallationPost: description: Software upgrade attempt. type: object properties: mode: description: 'Mode that the upgrade is in. Valid values are `check-only`, `interactive`, `semi-interactive`, and `one-click`. The `check_only` mode is deprecated. Use `/software-checks`. In this mode, the upgrade only runs pre-upgrade checks and returns. In `interactive` mode, the upgrade pauses at several points, at which users must enter certain commands to proceed. In `semi-interactive` mode, the upgrade pauses if there are any upgrade check failures and functions like `one-click` mode otherwise. In `one-click` mode, the upgrade proceeds automatically without pausing. ' type: string example: interactive override_checks: description: 'A list of upgrade checks whose failures are overridden during the upgrade. If any optional `args` are provided, they are validated later when the corresponding check script runs. ' type: array items: $ref: '#/components/schemas/_override_check' 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: '#/components/schemas/_upgrade_parameters' SoftwareChecksGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareChecksResponse' SoftwareInstallationStepsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareInstallationStepsResponse' SoftwareVersionsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareVersionsResponse' SoftwareInstallationStep: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - $ref: '#/components/schemas/_start_end_time' - description: 'Step needed to complete an upgrade. ' type: object properties: checks: description: 'A list of checks in this upgrade step. ' type: array items: $ref: '#/components/schemas/_softwareInstallationStepsChecks' description: description: 'Detailed description of the step. ' type: string details: description: 'Detailed result of the step used to diagnose step failures. ' type: string hop_version: description: The version to which the current hop is upgrading. type: string example: 99.9.9 installation: description: 'Referenced `software-installation` to which the step belongs. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' status: description: 'Status of the step. Valid values are `running` and `finished`. A status of `running` indicates that the step has not finished. A status of `finished` indicates that the check has finished. ' type: string Software: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - description: Software to be installed on the array. type: object properties: details: description: 'The detailed reason for the `status`. ' type: string payload_id: description: 'A checksum hash referring to the update bundle. ' type: string example: 4f7b319106401d072ff94808535cb3ce progress: description: 'The progress of the software upgrade. Displayed in decimal format. ' type: number format: float status: description: 'The status of the software package. Valid values are `available`, `downloaded`, `downloading`, `download_failed`, `checking`, `installing`, `new`, `paused`, `aborting`, `abort`, `canceled`, `partially_installed`, and `installed`. A status of `available` indicates that the package is available for download. This only applies if `automatic-download` is not enabled. A status of `downloaded` indicates that the package is downloaded and ready for installation. A status of `downloading` indicates that the package is currently downloading. A status of `download_failed` indicates that the download of the package failed. A status of `checking` indicates that the package is currently running in `check-only` mode. A status of `installing` indicates that the package is currently installing. A status of `new` indicates that Pure1 cloud is still building the package. A status of `paused` indicates that the upgrade is paused and waiting for user input to proceed. A status of `aborting` indicates that the upgrade is being aborted, due to an unrecoverable error or an `abort` command issued by the user. A status of `canceled` indicates that the upgrade has been canceled. A status of `partially_installed` indicates that the upgrade has been partially installed due to an `abort`. The array has been upgraded to an intermediate version and the `software` is no longer available for installation. A status of `installed` indicates that the upgrade has finished. ' type: string example: Available upgrade_hops: description: 'The plan by which the upgrade will be conducted. The first element is the current version, the last element is the destination version, and the elements in between are intermediate versions. ' type: array uniqueItems: true items: type: string example: - 5.0.0 - 5.1.6 - 5.2.3 upgrade_plan: description: 'A list of steps that are planned to run during the upgrade in an optimal scenario (i.e., all upgrade checks pass, no step is retried, and the upgrade is not aborted). Steps are listed in the order that they should occur. ' type: array items: $ref: '#/components/schemas/_softwareUpgradePlan' version: description: 'The version of the software package. ' type: string example: 5.2.3 _upgrade_parameters: 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 SoftwareGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareResponse' SoftwareBundleGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareBundleResponse' SoftwarePatch: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - description: Software patch to be installed on the array. type: object properties: alert_code: description: 'Alert code for the Software Patch. This code is used to uniquely identify the Software Patch. ' type: integer format: int64 example: 5200 description: description: The detailed description of the patch. type: string details: description: The detailed reason for the `status`. type: string ha_reduction_required: description: 'If set to `true`, indicates reduction in high availability is required for Software Patch installation. If set to `false`, indicates such a reduction is not required. ' type: boolean example: false progress: description: The progress of the software patch installation, displayed in decimal format. type: number format: float status: description: 'The status of the software patch installation. Valid values are `available`, `downloaded`, `downloading`, `download_failed`, `installing`, `installed`, `failed`, and `not_applicable`. A status of `available` indicates that the patch is available for download. A status of `downloaded` indicates that the patch has been downloaded and will be installed. A status of `downloading` indicates that the patch is currently downloading. A status of `download_failed` indicates that the download of the patch failed. A status of `installing` indicates that the patch is currently being installed. A status of `installed` indicates that the patch has been installed. A status of `failed` indicates that the patch failed to be installed. A status of `not_applicable` indicates the patch does not need to be installed on the array. ' type: string example: installed SoftwareResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Software' _softwareUpgradePlan: type: object properties: description: description: Description of the upgrade step. type: string hop_version: description: The version to which the step is upgrading. type: string example: 99.9.9 step_name: description: Name of the upgrade step. type: string example: Pre-upgrade check _resourceFixedNonUniqueName: description: 'A resource with a non-unique name. ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'Name of the resource. The name cannot be modified. ' type: string readOnly: true SoftwareVersionsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareVersion' SoftwareInstallationsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwareInstallationsResponse' SoftwareCheck: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - $ref: '#/components/schemas/_start_end_time' - description: Software upgrade check task to be run on the array. type: object properties: checks: description: 'A list of checks in this check task. ' type: array items: $ref: '#/components/schemas/_softwareChecksChecks' details: description: 'The detailed reason for the `status`. ' type: string software_name: description: 'The name of the software the upgrade checks will test. ' type: string software_upgrade_hops: description: 'The list of software versions the upgrade goes through. The upgrade checks also test this particular path. ' type: array items: type: string description: 'A software version in the upgrade path. ' example: - 6.1.3 - 6.2.0 software_version: description: 'The version of the software that the upgrade checks will test. ' type: string example: 6.2.0 status: description: 'The status of the check task. Valid values are `queued`, `running`, `passed`, and `failed`. A status of `queued` indicates that the task is queued to run and is waiting for other check tasks to complete. A status of `running` indicates that the task is currently running. A status of `passed` indicates that all upgrade checks in the task are complete. A status of `failed` indicates that at least one upgrade check in the task has failed. ' type: string example: running SoftwareInstallation: allOf: - $ref: '#/components/schemas/_resourceFixedNonUniqueName' - $ref: '#/components/schemas/_start_end_time' - description: 'Interactive software upgrade attempt that contains information about the current upgrade instance, including the current step, status of the upgrade attempt, etc. ' type: object properties: current_step_id: description: The `id` of the current step or `null` if the upgrade is not active. type: string details: description: The detailed reason for the `status`. type: string mode: description: 'Mode that the upgrade is in. Valid values are `check-only`, `interactive`, `semi-interactive`, and `one-click`. The `check_only` mode is deprecated. Use `/software-checks`. In this mode, the upgrade only runs pre-upgrade checks and returns. In `interactive` mode, the upgrade pauses at several points, at which users must enter certain commands to proceed. In `semi-interactive` mode, the upgrade pauses if there are any upgrade check failures, and functions like `one-click` mode otherwise. In `one-click` mode, the upgrade proceeds automatically without pausing. ' type: string example: interactive override_checks: description: 'A list of upgrade checks whose failure is overridden during the upgrade. If any optional `args` are provided, they are validated later when the corresponding check script runs. ' type: array items: $ref: '#/components/schemas/_override_check' software: description: 'Referenced `software` to which the upgrade belongs. ' title: Reference allOf: - $ref: '#/components/schemas/_reference' status: description: 'Status of the upgrade. Valid values are `installing`, `paused`, `aborting`, `aborted`, and `finished`. A status of `installing` indicates that the upgrade is running. A status of `paused` indicates that the upgrade is paused and waiting for user input. A status of `aborting` indicates that the upgrade is being aborted. A status of `aborted` indicates that the upgrade has stopped due to an abort. A status of `finished` indicates that the upgrade has finished successfully. ' type: string example: Installing 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: '#/components/schemas/_upgrade_parameters' SoftwarePatchesGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/SoftwarePatchesResponse' SoftwareBundleResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwareBundle' _softwareInstallationStepsChecks: type: object properties: details: description: 'Detailed result of the check used to diagnose check failures. ' type: string name: description: Name of the upgrade check. type: string example: HostIOCheck overridable: description: 'Whether the check failure can be overridden. ' type: boolean status: description: 'Status of the check. Valid values are `running`, `failed`, `passed`, and `overridden`. A status of `running` indicates that the check has not finished. A status of `failed` indicates that the check has failed. A status of `passed` indicates that the check has passed. A status of `overridden` indicates that the check has failed, but the failure has been overridden. ' type: string SoftwarePatchesResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/SoftwarePatch' SoftwareBundlePost_2: description: The source location of the software bundle. type: object required: - source properties: source: description: The source of the software bundle. Accepts HTTP, HTTPS, FTP or SFTP and paths. type: string example: ftp://local/upgrade_bundle.sh SoftwarePost: description: Software to be installed on the array. type: object properties: name: description: 'The name of the software. ' type: string example: Purity//FA version: description: 'The version of the software. ' type: string example: 5.2.3 _builtInRelationship: type: object properties: id: description: 'A non-modifiable, globally unique ID chosen by the system. ' type: string readOnly: true _softwareChecksChecks: type: object properties: details: description: 'Detailed result of the check used to diagnose check failures. ' type: string name: description: Name of the upgrade check. type: string example: HostIOCheck status: description: 'Status of the check. Valid values are `running`, `failed`, and `passed`. A status of `running` indicates that the check has not finished. A status of `failed` indicates that the check has failed. A status of `passed` indicates that the check has passed. ' type: string PageInfo: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string more_items_remaining: description: 'Returns a value of `true` if subsequent items can be retrieved. ' type: boolean example: false total_item_count: description: 'The total number of records after applying all filter query parameters. The `total_item_count` will be calculated if and only if the corresponding query parameter `total_item_count` is set to `true`. If this query parameter is not set or set to `false`, a value of `null` will be returned. ' type: integer format: int32 parameters: Versions: name: versions in: query description: 'A comma-separated list of versions. ' style: form explode: false schema: type: array items: type: string Offset: name: offset in: query description: 'The starting position based on the results of the query in relation to the full set of response objects returned. ' schema: type: integer format: int32 minimum: 0 example: 10 Filter: name: filter in: query description: 'Narrows down the results to only the response objects that satisfy the filter criteria. ' schema: type: string Software_installation_current_step_idRequired: name: current_step_id in: query description: 'The current step `id` of the installation. ' required: true schema: type: string Software_installation_ids: name: software_installation_ids in: query description: 'A comma-separated list of software installation IDs. ' style: form explode: false schema: type: array items: type: string Continuation_token: name: continuation_token in: query description: 'A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters. ' schema: type: string Offset_2: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 example: 10 Software_versions: name: software_versions in: query description: 'A comma-separated list of target software versions. ' style: form explode: false schema: type: array items: type: string XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string Limit: name: limit in: query description: 'Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. ' schema: type: integer format: int32 minimum: 0 example: 10 Authorization: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) ' schema: type: string Names: name: names in: query description: 'Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources. ' style: form explode: false schema: type: array items: type: string Sort_2: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). NOTE: If you provide a sort you will not get a `continuation_token` in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Software_installation_command_required: name: command in: query description: 'A user command that interacts with the upgrade. Commands may only be issued when the upgrade is paused. Valid values are `continue`, `retry`, and `abort`. The `continue` command continues a `paused` upgrade. The `retry` command retries the previous step. The `abort` command aborts the upgrade. ' required: true schema: type: string Ids: name: ids in: query description: "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" style: form explode: false schema: type: array items: type: string Software_idsRequired: name: software_ids in: query description: 'A comma-separated list of software IDs. ' required: true style: form explode: false schema: type: array items: type: string Ids_2: name: ids in: query description: 'A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of `ids`, then an error is returned. This cannot be provided together with the `name` or `names` query parameters. ' style: form explode: false schema: type: array items: type: string Total_item_count: name: total_item_count in: query description: 'If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`. ' schema: type: boolean Software_names: name: software_names in: query description: 'A comma-separated list of software names. ' style: form explode: false schema: type: array items: type: string Software_ids: name: software_ids in: query description: 'A comma-separated list of software IDs. ' style: form explode: false schema: type: array items: type: string Sort: name: sort in: query description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string