Add Cluster Host | vRealize Automation Container Service API

Add Cluster Host

Add host to cluster. Operation is available for container admins, system admins.

Request

URI

POST

https://{api_host}/container-service/api/resources/clusters/{clusterId}/hosts

COPY

Path Parameters

string

Required

The id of cluster where this host has to be added.

Request Body

ContainerHostSpec of type(s) application/json

Optional

{
    "acceptCertificate": false,
    "acceptHostAddress": false,
    "sslTrust": {
        "commonName": "string",
        "documentExpirationTimeMicros": "string",
        "validSince": 0,
        "issuerName": "string",
        "origin": "string",
        "certificate": "string",
        "subscriptionLink": "string",
        "documentUpdateTimeMicros": "string",
        "serial": "string",
        "documentSelfLink": "string",
        "fingerprint": "string",
        "tenantLinks": [
            "string"
        ],
        "resourceLink": "string",
        "validTo": 0
    },
    "hostState": {
        "hostName": "string",
        "powerState": "string",
        "environmentName": "string",
        "tagLinks": [
            "string"
        ],
        "creationTimeMicros": 0,
        "zoneId": "string",
        "groupLinks": [
            "string"
        ],
        "id": "string",
        "gpuCount": 0,
        "cpuCount": 0,
        "lifecycleState": "string",
        "documentExpirationTimeMicros": "string",
        "parentLink": "string",
        "address": "string",
        "diskLinks": [
            "string"
        ],
        "endpointLink": "string",
        "instanceType": "string",
        "descriptionLink": "string",
        "cpuMhzPerCore": 0,
        "documentUpdateTimeMicros": "string",
        "primaryMAC": "string",
        "totalMemoryBytes": 0,
        "resourcePoolLink": "string",
        "adapterManagementReference": "string",
        "regionId": "string",
        "networkInterfaceLinks": [
            "string"
        ],
        "documentSelfLink": "string",
        "name": "string",
        "tenantLinks": [
            "string"
        ],
        "desc": "string"
    },
    "isUpdateOperation": false
}

boolean

acceptCertificate

Optional

acceptCertificate

boolean

acceptHostAddress

Optional

acceptHostAddress

SslTrustCertificateState

sslTrust

Optional

sslTrust

ComputeState

hostState

Optional

hostState

boolean

isUpdateOperation

Optional

isUpdateOperation

Responses

200

successful operation. If the host does not have SSL enabled or its certificate is trusted, the cluster is created and the host is added to it. A ClusterDto object is returned. Otherwise, if the certificate of the host is not trusted, it is returned for confirmation from the user. In this case, the cluster is not created.

Returns SslTrustCertificateState of type(s) */*

{
    "commonName": "string",
    "documentExpirationTimeMicros": "string",
    "validSince": 0,
    "issuerName": "string",
    "origin": "string",
    "certificate": "string",
    "subscriptionLink": "string",
    "documentUpdateTimeMicros": "string",
    "serial": "string",
    "documentSelfLink": "string",
    "fingerprint": "string",
    "tenantLinks": [
        "string"
    ],
    "resourceLink": "string",
    "validTo": 0
}

string

commonName

Optional

commonName

string

documentExpirationTimeMicros

Optional

documentExpirationTimeMicros

integer As int64 As int64

validSince

Optional

validSince