Update Host For Cluster

Update Host For Cluster

Update the specified host.

Request
URI
PUT
https://{api_host}/hybridity/api/ztp/v1/clusters/{cluster_id}/hosts/{host_id}
COPY
Path Parameters
string
cluster_id
Required

The ID of the cluster.

string
host_id
Required

The ID of the host.

Request Body

The request payload for Update Host API.

InlineZtpV1ClustersCluster_idHostsHost_idRequestBody of type(s) application/json
Required 
{
    "id": "string",
    "version": 0,
    "name": "string",
    "username": "string",
    "password": "string",
    "ipmiFqdn": "string",
    "ipmiUsername": "string",
    "ipmiPassword": "string",
    "vmkVsanIp": "string",
    "vmkVmotionIp": "string"
}
string As uuid As uuid
id
Optional

The unique ID of the host. This is optional when adding hosts and required when updating host(s) in the absence of host ID as API Path Param. This field cannot be updated during Host Update.

integer
version
Optional

The version of this host entity. This field must be specified during Host Update.

string
name
Required

FQDN of the host. This field cannot be updated during Host Update.

string
username
Required

Username of the host.

string
password
Required

Password of the host in base64 format.

string
ipmiFqdn
Optional

IPMI FQDN of host.

string
ipmiUsername
Optional

IPMI username of host.

string
ipmiPassword
Optional

IPMI password of host in base64 format.

string
vmkVsanIp
Required

vmk IP for VSAN network

string
vmkVmotionIp
Required

vmk IP for VMotion network

Authentication
This operation uses the following authentication methods.
Responses
200

The specified host has been updated successfully.

Returns InlineZtpV1ClustersCluster_idHostsHost_id200Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


301

API endpoint has permanently moved.

Returns InlineZtpV1ClustersCluster_idHostsHost_id301Response of type(s) application/json 
{
    "redirectURL": "string"
}
string
redirectURL
Optional

redirectURL

Response Headers

string
Location

URI where the client will find the new endpoint.


400

Response may include details of why the request is bad.

Returns InlineZtpV1ClustersCluster_idHostsHost_id400Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

404

The specified host was not found.

Operation doesn't return any data structure

422

The request payload couldn't be processed by the server.

Returns InlineZtpV1ClustersCluster_idHostsHost_id422Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


500

An internal server error has occurred.

Returns InlineZtpV1ClustersCluster_idHostsHost_id500Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


On This Page
Host Operations
POST
Add Hosts To Cluster
POST
Add Hosts To CSG
DELETE
Delete Host For Cluster
DELETE
Delete Host For CSG
POST
Delete Hosts V1
POST
Fetch Hcp Names For Hosts
POST
Fetch Hosts By Name
GET
Get Host For Cluster
GET
Get Host For CSG
GET
Get Hosts
GET
Get Hosts For Cluster
GET
Get Hosts For CSG
GET
Get Status For Clusters Host
GET
Get Status For CS Gs Host
POST
Resync Hosts For Cluster
POST
Resync Hosts For CSG
PUT
Update Host For Cluster
PUT
Update Host For CSG
PUT
Update Hosts For Cluster
PUT
Update Hosts For CSG