Update Version Alias Configurations

Update Version Alias Configurations.

Request

URI

PUT

https://sfo-vcf01.rainpole.io//v1/system/settings/version-aliases

COPY

Request Body

Version Alias Configuration Specification

VersionAliasesForBundleComponentTypeSpec of type(s) application/json

Required

{
    "forceUpdate": false,
    "targetVcfVersion": "string",
    "versionAliasesForBundleComponentTypes": [
        {
            "bundleComponentType": "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, ",
            "versionAliases": [
                {
                    "aliases": [
                        "string"
                    ],
                    "version": "string"
                }
            ]
        }
    ]
}

boolean

forceUpdate

Optional

Flag for force update version alias configuration.

string

targetVcfVersion

Optional

If this field is set, LCM will calculate and update version aliases based on current deployment VCF version and the provided target VCF version

array of VersionAliasesForBundleComponentType

versionAliasesForBundleComponentTypes

Optional

List of version aliases for bundle component types.

Responses

200

Returns PageOfVersionAliasesForBundleComponentType of type(s) application/json

{
    "elements": [
        {
            "bundleComponentType": "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, ",
            "versionAliases": [
                {
                    "aliases": [
                        "string"
                    ],
                    "version": "string"
                }
            ]
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

array of VersionAliasesForBundleComponentType

elements

Optional

The list of elements included in this page

PageMetadata

pageMetadata

Optional

pageMetadata

400

Bad Request

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

The error context (e.g. the component where it occurred).

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

string

message

Optional

The localized error message

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string

remediationMessage

Optional

The localized remediation error message

500

Internal Server Error

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

The error context (e.g. the component where it occurred).