Update Upgrade Coordinator Feature Configuration

Pre-Upgrade Configuration - Update Upgrade Coordinator deployment configuration

Modifies the deployment configuration for the Upgrade Coordinator. Use this operation to update specific deployment parameters, such as the target upgrade version and the configuration revision.

Request

URI

PUT

https://{api_host}/ssp/lcm/upgrade-coordinator/config

COPY

Request Body

Update Upgrade Coordinator platform feature configuration.

UpgradeCoordinatorConfiguration of type(s) application/json

Required

This request body class requires all of the following: ManagedResource , InlineUpgradeCoordinatorConfiguration1

{
    "target_version": "5.2.0-0.0-25412677",
    "_revision": 0
}

Authentication

This operation uses the following authentication methods.

enterprise_admin

Responses

202

Update request has been processed and accepted.

Returns AsyncApiResponse of type(s) application/json

{
    "id": "upgrade-coordinator",
    "status_url": "https://ssp.broadcom.com/lcm/upgrade-coordinator/config/status"
}

string

Optional

UUID identifier of the response.

string

status_url

Optional

The URL to check the status of the operation.

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

412

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

428

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

429

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

default

Update operation encountered error.

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/ssp/lcm/upgrade-coordinator/config

On This Page

Description

Request

Request Body

Authentication

Response

202 Response Body

Errors

Upgrade Operations

GET

Get Upgrade Coordinator Feature Configuration

PUT