Add Hosts To CSG | Telco Cloud Foundation Manager API

Add Hosts To CSG

This API is to be used for adding the specified hosts to a specified CSG.

Request

URI

POST

https://{api_host}/hybridity/api/ztp/v1/csgs/{csg_id}/hosts

COPY

Path Parameters

string

csg_id

Required

The ID of the CSG.

Request Body

The request payload for Add Hosts API.

InlineZtpV1CsgsCsg_idHostsRequestBody of type(s) application/json

Required

{
    "hosts": [
        {
            "id": "string",
            "version": 0,
            "name": "string",
            "username": "string",
            "password": "string",
            "ipmiFqdn": "string",
            "ipmiUsername": "string",
            "ipmiPassword": "string",
            "disableDatastoreCustomization": false
        }
    ]
}

array of object

hosts

Required

hosts

Authentication

This operation uses the following authentication methods.

x-hm-authorization

Responses

201

The submitted hosts have been added successfully.

Returns InlineZtpV1CsgsCsg_idHosts201Response 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 InlineZtpV1CsgsCsg_idHosts301Response 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 InlineZtpV1CsgsCsg_idHosts400Response 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 CSG was not found.

Operation doesn't return any data structure

422

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

Returns InlineZtpV1CsgsCsg_idHosts422Response 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_idHosts500Response 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

Description

Request

Path Parameters