Skip to main content
API Explorer|API Explorer
Resource Center/Network Resource/Hardware SDN Controller Operations
POSTHardware SDN Controller OperationsSince 5.3.0SynchronousAuth Required

SdnControllerAddHost

SdnControllerAddHost

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • sdnControllerUuidStringRequired

    The SDN controller UUID.

  • hostUuidStringRequired

    The host UUID.

Body Fields

  • vSwitchTypeString

    Optional. The virtual switch type.

  • nicNamesListRequired

    The name list of physical server's NICs.

  • vtepIpString

    Optional. The physical server's VTEP IP.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • inventorySdnControllerInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • vendorTypeStringRequired

      No description provided.

    • vendorVersionStringRequired

      The vendor version.

    • nameStringRequired

      The resource name.

    • descriptionString

      Optional. The detailed description of the resource.

    • ipStringRequired

      来源IP地址。

    • usernameStringRequired

      用户名。

    • passwordStringRequired

      密码。

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • statusSdnControllerStatusRequired

      See status.

      • ConnectingSdnControllerStatusRequired

        Connecting.

      • ConnectedSdnControllerStatusRequired

        Connected.

      • DisconnectedSdnControllerStatusRequired

        Disconnected.

    • hostRefsListRequired

      See hostRefs.

      • sdnControllerUuidStringRequired

        The SDN controller UUID.

      • hostUuidStringRequired

        The host UUID.

      • vSwitchTypeStringRequired

        The virtual switch type.

      • vtepIpStringRequired

        The VTEP IP.

      • nicPciAddressesStringRequired

        The NIC PCI address mapping.

      • nicDriversStringRequired

        The NIC driver mapping.

      • netmaskStringRequired

        The VTEP IP netmask.

      • bondModeStringRequired

        The NIC bond mode.

      • lacpModeStringRequired

        The NIC LACP mode.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

Endpoint

POST/zstack/v1/sdn-controllers/{sdnControllerUuid}/hosts/{hostUuid}

/zstack/v1/sdn-controllers/{sdnControllerUuid}/hosts/{hostUuid}

Operation ID

SdnControllerAddHost

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/sdn-controllers/{sdnControllerUuid}/hosts/{hostUuid}' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"vSwitchType":"<vSwitchType>","nicNames":["<nicNames>"],"vtepIp":"<vtepIp>","systemTags":["<systemTags>"],"userTags":["<userTags>"],"netmask":"<netmask>","bondMode":"<bondMode>","lacpMode":"<lacpMode>"}'

Response Example

200
{ "inventory": { "uuid": "2b317c278d253df6bab1acd9b293d957", "vendorType": "H3C VCFC", "name": "sdn-1", "description": "sdn controller from vendor", "ip": "192.168.1.1", "username": "admin", "password": "password" } }

Change History

This API has no change history records yet.

View all change history