AddSdnController

POST/zstack/v1/sdn-controllers

Operation ID

AddSdnController

Since

3.7.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

params
ObjectRequired
Request body parameter object.
- vendorType
  StringRequired
  The vendor type.
- name
  StringRequired
  The resource name.
- description
  String
  Optional. The detailed description of the resource.
- ip
  StringRequired
  The IP address.
- userName
  String
  Optional. The user name.
- password
  String
  Optional. The password.
- resourceUuid
  String
  Optional. The resource UUID.
- tagUuids
  List
  Optional. The tag UUID list.
- zoneUuid
  String
  Optional. The zone UUID.
systemTags
List
Optional. The system tags.
userTags
List
Optional. The user tags.
hostRefs
ListRequired
5.3.0

Responses

200 OK

On success, this API returns the following response structure.

success
BooleanRequired
Whether the operation succeeded.
error
ErrorCodeRequired
The error code. If not null, the operation fails, or vice versa. For more information, see error.
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The brief description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.
inventory
SdnControllerInventoryRequired
See inventory.
- uuid
  StringRequired
  The resource UUID.
- vendorType
  StringRequired
  The vendor type.
- vendorVersion
  StringRequired
  The vendor version.
- name
  StringRequired
  The resource name.
- description
  StringRequired
  The detailed description of the resource.
- ip
  StringRequired
  The IP address.
- username
  StringRequired
  The username.
- password
  StringRequired
  The password.
- createDate
  TimestampRequired
  The creation date.
- lastOpDate
  TimestampRequired
  The last operation date.
- status
  SdnControllerStatusRequired
  See status.
  Connecting
  SdnControllerStatusRequired
  Connecting.
  Connected
  SdnControllerStatusRequired
  Connected.
  Disconnected
  SdnControllerStatusRequired
  Disconnected.
- hostRefs
  ListRequired
  See host Refs.
  sdnControllerUuid
  StringRequired
  The SDN controller UUID.
  hostUuid
  StringRequired
  The host UUID.
  vSwitchType
  StringRequired
  The virtual switch type.
  vtepIp
  StringRequired
  The VTEP IP.
  nicPciAddresses
  StringRequired
  The NIC PCI address mapping.
  nicDrivers
  StringRequired
  The NIC driver mapping.
  netmask
  StringRequired
  The VTEP IP netmask.
  bondMode
  StringRequired
  The NIC bond mode.
  lacpMode
  StringRequired
  The NIC LACP mode.

Request Example

curl -X POST '{host}/zstack/v1/sdn-controllers' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "vendorType": "{vendorType}",
    "name": "{name}",
    "description": "{description}",
    "ip": "{ip}",
    "userName": "{userName}",
    "password": "{password}",
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ],
    "zoneUuid": "{zoneUuid}"
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ],
  "hostRefs": [
    "{hostRefs}"
  ]
}'

Response Example

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

VM Instance Operations

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations