Skip to main content

Upgrade client and client group software​

Select

SaaS
Customer Managed

Upgrade software for client and client group.

Request Body
  • rebootIfRequired boolean

    Boolean which determines whether to reboot if required.

  • runDBMaintenance boolean

    Boolean which determines whether or not to run a database maintenance.

  • notifyWhenJobCompletes boolean

    Boolean which determines whether to notify when software is upgraded.

  • installOSUpdates boolean

    Boolean which determines whether to install operating system updates.

  • installStorageUpdates string

    Possible values: [DISRUPTIVE, NON_DISRUPTIVE]

    Enum which specifies the type of storage update

  • waitForDownloadJobToComplete boolean

    Boolean which determines whether to wait for Download software job to complete before software is upgraded.

  • entities object[]

    List of all the client and client groups on which UpgradeSoftware should be run

  • id int32
  • name string
  • GUID string
  • type string
Responses

Success

Schema
  • jobId int32
PUT /v4/upgradesoftware

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "rebootIfRequired": true,

  "runDBMaintenance": true,

  "notifyWhenJobCompletes": true,

  "installOSUpdates": true,

  "installStorageUpdates": "DISRUPTIVE",

  "waitForDownloadJobToComplete": true,

  "entities": [

    {

      "id": 0,

      "name": "string",

      "GUID": "string",

      "type": "string"

    }

  ]

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/UpgradeSoftware' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "rebootIfRequired": true,
  "runDBMaintenance": true,
  "notifyWhenJobCompletes": true,
  "installOSUpdates": true,
  "installStorageUpdates": "DISRUPTIVE",
  "waitForDownloadJobToComplete": true,
  "entities": [
    {
      "id": 0,
      "name": "string",
      "GUID": "string",
      "type": "string"
    }
  ]
}'