Get Host For CSG

Get Host For CSG

Get the specified host.

Request
URI
GET
https://{api_host}/hybridity/api/ztp/v1/csgs/{csg_id}/hosts/{host_id}
COPY
Path Parameters
string
csg_id
Required

The ID of the CSG

string
host_id
Required

The ID of the host

Authentication
This operation uses the following authentication methods.
Responses
200

The specified host.

Returns InlineZtpV1CsgsCsg_idHostsHost_id200Response of type(s) application/json 
{
    "id": "string",
    "version": 0,
    "domainId": "string",
    "domainType": "string",
    "parent": "string",
    "ip": "string",
    "name": "string",
    "username": "string",
    "status": "string",
    "createdTimestamp": 0,
    "lastUpdatedTimestamp": 0,
    "disableDatastoreCustomization": false,
    "ipmiFqdn": "string",
    "ipmiUsername": "string",
    "hostSettingStatus": "string",
    "isVcpResyncNeeded": false,
    "isHcpResyncNeeded": false,
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
string
id
Optional

The unique ID of the host.

integer
version
Optional

The version of this host entity.

string
domainId
Optional

The unique ID of the host's domain.

string
domainType
Optional

The type of host's domain.

string
parent
Optional

The name of the domain that is the parent of this host.

string
ip
Optional

IP of the host.

string
name
Optional

FQDN of the host.

string
username
Optional

Username of the host.

string
status
Optional

The status of provisioning of the host. It can be one of: [NOT_PROVISIONED, PROVISIONED, IN_PROGRESS, FAILED, TO_BE_DELETED, DELETING, DELETE_FAILED].

integer As int64 As int64
createdTimestamp
Optional

The timestamp of when this host was added.

integer As int64 As int64
lastUpdatedTimestamp
Optional

The timestamp of when this host was last modified.

boolean
disableDatastoreCustomization
Optional

Flag indicating whether to enable Datastore Customization or not.

string
ipmiFqdn
Optional

IPMI FQDN of host.

string
ipmiUsername
Optional

IPMI username of host.

string
hostSettingStatus
Optional

The status of host config profile of the host. It can be one of: [NOT_CONFIGURED, IN_PROGRESS, CONFIGURED, FAILED, TO_BE_DELETED, DELETING, DELETE_FAILED, DELETED].

boolean
isVcpResyncNeeded
Optional

This flag specifies whether a resync is needed for this host to realize the latest specification from its parent domain w.r.t provisioning in vCenter.

boolean
isHcpResyncNeeded
Optional

This flag specifies whether a resync is needed for this host to realize the latest specification from its parent domain and parent Host Config Profile w.r.t applying Host Config Profile.

array of object
errors
Optional

The list of errors.


301

API endpoint has permanently moved.

Returns InlineZtpV1CsgsCsg_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.


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 parameters couldn't be processed by the server.

Returns InlineZtpV1CsgsCsg_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 InlineZtpV1CsgsCsg_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