Discover Vcf Ops

Discover VCF Operations instance and its adjacent topology such as its cluster nodes, management node, vCenters, etc.

Request

URI

POST

https://{api_host}/v1/sddcs/vcfops-discovery

COPY

Request Body

VcfOperationsDiscoverySpec of type(s) application/json

Required

Show optional properties

{
    "address": "string",
    "adminPassword": "string",
    "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
}

{
    "address": "string",
    "adminUsername": "string",
    "adminPassword": "string",
    "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
}

string

address

Required

VCF Operations instance address.

string

adminUsername

Optional

Admin username. Can be omitted.

string

adminPassword

Required

Admin password.

string

sslThumbprint

Required

VCF Operations SSL thumbprint (SHA256).

Responses

200

Returns VcfOperationsDiscoveryResult of type(s) application/json

"VcfOperationsDiscoveryResult Object"

string

vcfOperationsVersion

Required

VCF Operations instance version.

string

vcfOperationsBuildNumber

Required

VCF Operations instance build number.

array of object

vcfOperationsNodes

Required

VCF Operations nodes info.

object

vcfOperationsManagementNode

Optional

VCF Operations Management node information.

array of object

vcfAutomationNodes

Optional

VCF Automation nodes info.

array of object

vcenterAdapters

Optional

Registered vCenter adapters.

array of object

nsxAdapters

Optional

Registered NSX adapters.

400

Bad Request

Returns Error of type(s) application/json

"Error Object"

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

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

object

context

Optional

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

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of object

causes

Optional

The underlying cause exceptions.

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

label

Optional

The localized label message

string

remediationUrl

Optional

The URL string for remediation documentation link

500

InternalServerError

Returns Error of type(s) application/json

"Error Object"

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

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

object

context

Optional

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

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of object

causes

Optional

The underlying cause exceptions.

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

label

Optional

The localized label message

string

remediationUrl

Optional

The URL string for remediation documentation link

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"address:"string","adminPassword:"string","sslThumbprint:"string"}' https://{api_host}/v1/sddcs/vcfops-discovery

On This Page

Description

Request

Request Body

Response

200 Response Body

Errors

Vcf Installer Operations