DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›CLI Command ManualZCF
Document navigation

Hardware SDN Controller

Overview

The SDN controller is the core of the SDN architecture, responsible for centralized management and control of network devices.

Feature Highlights

  • Unified Management: Supports multiple software and hardware SDN controller types and delivers a consistent management experience.
  • Automated Configuration Deployment: Automatically pushes network configurations to the SDN controller when creating L3 networks, significantly improving deployment efficiency.
  • SDN Tenant-Level Resource Isolation: Automatically allocates subnets to target SDN tenants, ensuring resource isolation and preventing resource contention across tenants.

Supported Controller Types

The following table lists the supported controller types.
Vendor Version Description
Cloud SDN Controller - A software SDN controller provided by ZStack Cloud. You can create OVS-DPDK L2 networks with high performance and low latency.
H3C VCFC R6506 With H3C SDN controllers, you can manage SDN networks of hardware switches, thereby reducing network latency and improving VXLAN network performance.
E2507
HUAWEI iMaster NCE-Fabric V100R023 With Huawei SDN controllers, you can achieve centralized management and automated configuration deployment, enabling efficient VXLAN network construction and intelligent operation.

Core Concepts

Tenant
An SDN tenant is a logically isolated entity on H3C or Huawei SDN controllers that enjoys independent network resources and security policies.
Logical Router
A virtualized network device on Huawei SDN controllers that connects VMs across different networks, enabling cross-layer-3 communication between virtual machines.
Remote VPC
A security domain on Huawei SDN controllers that provides inter-tenant network isolation. Each VPC typically corresponds to a specific business unit or department.

Inventory

SDN Controller Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.7.0
name The name. For more information, see Resource Property. 3.7.0
description The description. For more information, see Resource Property. Yes 3.7.0
ip 3.7.0
password The password. 3.7.0
status 5.3.0
username 3.7.0
vendorType 3.7.0
vendorVersion The vendor version. 5.4.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. Yes 3.7.0
createDate The creation date. For more information, see Resource Property. 3.7.0
lastOpDate The last operation date. For more information, see Resource Property. 3.7.0
userTags The user tags. The For more information, see CreateUserTag. Yes 3.7.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.7.0
tagUuid 3.7.0
hostRefs 3.7.0
Sample
{
    "inventories": [
        {
            "createDate": "Oct 11, 2025 11:08:10 AM",
            "description": "",
            "hostRefs": [],
            "ip": "172.26.32.131",
            "lastOpDate": "Oct 14, 2025 4:42:37 PM",
            "name": "H3C-VCFC",
            "password": "Pwd@12345",
            "status": "Connected",
            "username": "admin",
            "uuid": "2b56e3332569446b8fc17be1e63167a1",
            "vendorType": "H3C VCFC",
            "vendorVersion": "V2"
        }
    ],
    "success": true
}

HuaweiIMasterFabric Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 5.4.0
name The name. For more information, see Resource Property. 5.4.0
description The description. For more information, see Resource Property. 5.4.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. 5.4.0
sdnControllerUuid The SDN controller UUID. 5.4.0
state The status. 5.4.0
tagUuid 5.4.0
createDate The creation date. For more information, see Resource Property. 5.4.0
lastOpDate The last operation date. For more information, see Resource Property. 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
userTags The user tags. The For more information, see CreateUserTag. Yes 5.4.0
Sample
{
    "inventories": [
        {
            "createDate": "Oct 11, 2025 11:12:37 AM",
            "description": "",
            "lastOpDate": "Oct 11, 2025 11:12:37 AM",
            "name": "222222",
            "sdnControllerUuid": "4d81cdfcfa1748caaecaa4285cebe383",
            "state": "Enabled",
            "uuid": "c05731d1bce04507bcc3065d5d0132ee"
        }
    ],
    "success": true
}

HuaweiIMasterTenant Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 5.4.0
state The status. 5.4.0
description The description. For more information, see Resource Property. Yes 5.4.0
fabricIds 5.4.0
name The name. For more information, see Resource Property. 5.4.0
sdnControllerUuid The SDN controller UUID. 5.4.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. Yes 5.4.0
tagUuid 5.4.0
createDate The creation date. For more information, see Resource Property. 5.4.0
lastOpDate The last operation date. For more information, see Resource Property. 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
userTags The user tags. The For more information, see CreateUserTag. Yes 5.4.0
Sample
{
    "inventories": [
        {
            "createDate": "Sep 8, 2025 1:56:22 PM",
            "description": "",
            "fabricIds": [
                "018a7946156e413db9ce4d8a56c87c36"
            ],
            "lastOpDate": "Oct 11, 2025 11:12:38 AM",
            "name": "test38",
            "sdnControllerUuid": "4d81cdfcfa1748caaecaa4285cebe383",
            "state": "Enabled",
            "uuid": "fd6010487f4b4c068d063c5905ea1f20"
        }
    ],
    "success": true
}

HuaweiIMasterVRouter Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 5.4.0
state The status. 5.4.0
description The description. For more information, see Resource Property. Yes 5.4.0
fabricUuid 5.4.0
name The name. For more information, see Resource Property. 5.4.0
sdnControllerUuid The SDN controller UUID. 5.4.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. Yes 5.4.0
tagUuid 5.4.0
logicalNetworkId The logical network ID. 5.4.0
tenantId The tenant ID. 5.4.0
createDate The creation date. For more information, see Resource Property. 5.4.0
lastOpDate The last operation date. For more information, see Resource Property. 5.4.0
userTags The user tags. The For more information, see CreateUserTag. Yes 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
Sample
{
    "inventories": [
        {
            "createDate": "Oct 13, 2025 4:19:34 PM",
            "fabricUuid": "018a7946156e413db9ce4d8a56c87c36",
            "lastOpDate": "Oct 13, 2025 4:19:34 PM",
            "logicalNetworkId": "495dbcc4805a49468c76298642289f27",
            "name": "demo1",
            "sdnControllerUuid": "4d81cdfcfa1748caaecaa4285cebe383",
            "state": "Enabled",
            "tenantId": "95a5661e8d364b3494e630a19f9520b9",
            "uuid": "6b5c386d47bb4c05a7a939ec5eb6f012"
        }
    ],
    "success": true
}

HuaweiIMasterVpc Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 5.4.0
name The name. For more information, see Resource Property. 5.4.0
sdnControllerUuid The SDN controller UUID. 5.4.0
state The status. 5.4.0
description The description. For more information, see Resource Property. Yes 5.4.0
isVpcDeployed 5.4.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. Yes 5.4.0
fabricId The Fabric ID. 5.4.0
tenantId The tenant ID. 5.4.0
tagUuid 3.7.0
createDate The creation date. For more information, see Resource Property. 5.4.0
lastOpDate The last operation date. For more information, see Resource Property. 5.4.0
userTags The user tags. The For more information, see CreateUserTag. Yes 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
Sample
{
    "inventories": [
        {
            "createDate": "Sep 8, 2025 2:42:22 PM",
            "description": "",
            "fabricId": "018a7946156e413db9ce4d8a56c87c36",
            "isVpcDeployed": true,
            "lastOpDate": "Oct 11, 2025 11:12:39 AM",
            "name": "test19-vpc3",
            "sdnControllerUuid": "4d81cdfcfa1748caaecaa4285cebe383",
            "state": "Enabled",
            "tenantId": "0249a3967a5c448289c6e78e0c74adcd",
            "uuid": "cea389338d5048be905f6938977f946b"
        }
    ],
    "success": true
}

Operations

AddSdnController

Adds an SDN controller. For example,
AddSdnController vendorType=Ovn name=sdn-1 ip=192.168.1.1

Parameters

Name Description Optional Valid Value Starting Version
vendorType 3.7.0
name The resource name. 3.7.0
description The detailed description of the resource. Yes 3.7.0
ip 3.7.0
userName Yes 5.3.20
password Yes 5.3.20
resourceUuid Yes 3.7.0
tagUuids The tag UUID list. Yes 3.7.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.7.0
userTags The user tags. For information, see CreateUserTag. Yes 3.7.0
zoneUuid The zone UUID. Yes 5.3.0
timeout Yes
Note:
  • When you add an SDN controller in ZStack Cloud, you can create an H3C SDN controller by adding the H3C_VDS_UUID option to SystemTags. The SystemTag is passed by using the vdsUuid parameter.
    • Format of the H3C_VDS_UUID option: vdsUuid::{%s}
    • Example: vdsUuid::1234-5678
    • Associated resource: SdnControllerVO.class
  • When you add a Huawei SDN controller in ZStack Cloud, you can record the VLAN range used by the SDN controller by adding startVlan::endVlan options to SystemTags.
    • Format: startVlan::{%s}::endVlan::{%s}
    • Example: startVlan::110::endVlan::120
    • Associated resource: SdnControllerVO.class
  • When you add an H3C v1 SDN controller in ZStack Cloud, you can record the Vni range used by the SDN controller by adding startVni::endVni options to SystemTags.
    • Format: startVlan::{%s}::endVlan::{%s}
    • Example: startVlan::100::endVlan::200
    • Associated resource: SdnControllerVO.class

RemoveSdnController

Removes an SDN controller. For example,
RemoveSdnController uuid=237901c5097b38c480315569a1ac7567

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.7.0
deleteMode Yes 3.7.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.7.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.7.0
timeout Yes

QuerySdnController

Queries an SDN controller. For example,
QuerySdnController uuid=910df7d2e17c486cb5c20384d59f57da

Primitive Fields of Query

See SDN Controller Inventory.

ChangeSdnController

Changes an SDN controller. For example, 
ChangeSdnController uuid=cd65a5af636038bf91f4e404ef9594b1 userName=example password=password

Parameters

Name Description Optional Valid Value Starting Version
uuid The SDN controller UUID. 5.4.0
userName The new username for the SDN controller. Yes 5.4.0
password The new passwor for the SDN controller. Yes 5.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
vlanRanges Yes 5.4.0
Note:
  • When you create a Layer 3 network in ZStack Cloud, you can specify the port mirroring network by adding the mirrorNetwork option to SystemTags.
    • Format of the mirrorNetwork option: mirrorNetwork::{L3NetworkVOUuid}
    • Example: mirrorNetwork::1c707a63817b4f29b1235fa1f76c0ccc
  • When you create a Layer 3 network in ZStack Cloud, you can record the Huawei SDN virtual router UUID associated with the VPC gateway by adding the logicalRouterUuid option to SystemTags.
    • Format of the logicalRouterUuid option: logicalRouterUuid::{%s}
    • Example: logicalRouterUuid::ecb4a71e0e32476da948a583ea0a220d
  • When you add a Huawei SDN controller in ZStack Cloud, you can record the VLAN range used by the SDN controller by adding startVlan::endVlan:: options to SystemTags.
    • Format of the startVlan and endVlan options: startVlan::{%s}::endVlan::{%s}
    • Example: startVlan::100::endVlan::1000

PullSdnControllerTenant

Pulls SDN controller tenants. For example, 
PullSdnControllerTenant uuid=6d53fa409b343fc8a231c100e3f3c90f

Parameters

Name Description Optional Optional Value Starting Version
uuid Yes 5.3.28
userTags The system tags. For more information, see CreateSystemTag. Yes 5.3.28
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.3.28

CreateHuaweiIMasterVRouter

Create a Huawei iMaster VRouter. For example, 
CreateHuaweiIMasterVRouter name=test-vrouter description=Test VRouter for Huawei iMaster huaweiVpcUuid=67ed6b0065633829892c11ccf1ee2dba

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 5.4.0
description The detailed description of the resource. Yes 5.4.0
huaweiVpcUuid 5.4.0
resourceUuid The resource UUID. Yes 5.4.0
tagUuids The tag UUID list. Yes 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
userTags The user tags. For information, see CreateUserTag. Yes 5.4.0

DeleteHuaweiIMasterVRouter

Deletes a Huawei iMaster vrouter. For example,
DeleteHuaweiIMasterVRouter uuid=523c2083fec532b79fbc3701909e3b25 sdnControllerUuid=6f0803e4276a38308d958c2d8dc7381c

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 5.4.0
sdnControllerUuid 5.4.0
deleteMode The deletion mode (Permissive/Enforcing, Permissive). Yes 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.0

QueryHuaweiIMasterVRouter

Queries a Huawei iMaster vrouter. For example,
QueryHuaweiIMasterVRouter uuid=910df7d2e17c486cb5c20384d59f57da

Primitive Fields of Query

See HuaweiIMasterVRouter Inventory.

DeleteHuaweiIMasterTenant

Deletes a Huawei iMaster tenant. For example,
DeleteHuaweiIMasterTenant uuid=082fa02e39d53778a21a7e86b044ce17 sdnControllerUuid=2969528393513dcb812b38947a2ff3bc

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 5.4.0
sdnControllerUuid The SDN controller UUID. Yes 5.4.0
deleteMode The deletion mode (Permissive/Enforcing, Permissive). Yes 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.0

QueryHuaweiIMasterTenant

Queries a Huawei iMaster tenant. For example,
QueryHuaweiIMasterTenant uuid=4ca38813eb493b34a95f9f506c97f92d

Primitive Fields of Query

See HuaweiIMasterTenant Inventory.

DeleteHuaweiIMasterVpc

Deletes a Huawei iMaster VPC. For example, 
DeleteHuaweiIMasterVpc uuid=7daed678898c31968176551f0b718ab6 sdnControllerUuid=34bab7bf172633e78e54fdefdc5c0b6e

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 5.4.0
sdnControllerUuid Yes 5.4.0
deleteMode The deletion mode (Permissive/Enforcing, Permissive). Yes 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.0

QueryHuaweiIMasterVpc

Queries a Huawei iMaster VPC. For example,
QueryHuaweiIMasterVpc uuid=910df7d2e17c486cb5c20384d59f57da

Primitive Fields of Query

See HuaweiIMasterVpc Inventory.

DeleteHuaweiIMasterFabric

Deletes a Huawei iMaster fabric. For example, 
DeleteHuaweiIMasterFabric uuid=1aa09d25169430c2a01ec3f1b6f1ff67 sdnControllerUuid=7b50926063c439b4ba2b2da766b6dc67

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 5.4.0
sdnControllerUuid Yes 5.4.0
deleteMode The deletion mode (Permissive/Enforcing, Permissive). Yes 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.0

QueryHuaweiIMasterFabric

Queries a Huawei iMaster fabric. For example,
QueryHuaweiIMasterFabric uuid=910df7d2e17c486cb5c20384d59f57da

Primitive Fields of Query

See HuaweiIMasterFabric Inventory.

ReconnectSdnController

Reconnects an SDN controller. For example,
ReconnectSdnController sdnControllerUuid=910df7d2e17c486cb5c20384d59f57da

Parameters

Name Description Optional Valid Value Starting Version
sdnControllerUuid 5.3.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.3.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.3.0

UpdateSdnController

Updates an SDN controller. For example,
UpdateSdnController uuid=722428da8bac30d2b75daa2f6cd34e9d

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.7.0
name The resource name. Yes 3.7.0
description The detailed description of the resource. Yes 3.7.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.7.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.7.0
timeout Yes

PullHuaweiIMasterController

Pulls a Huawei iMaster controller. For example, 
PullHuaweiIMasterController uuid=10b101c6b2583c1ab6a08c4ea6962d6a pullSwitch=true

Parameters

Name Description Optional Optional Value Starting Version
uuid The resource UUID. 5.4.0
pullSwitch Whether to pull the switch information. Yes 5.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.0
userTags The user tags. For information, see CreateUserTag. Yes 5.4.0

SdnControllerAddHost

Adds a host for an SDN controller. For example,
SdnControllerAddHost nicNames=test hostUuid=2dede8695d5346f88cad28212c98d3cf sdnControllerUuid=910df7d2e17c486cb5c20384d59f57da vtepIp=172.25.16.15 netmask=255.255.0.0

Parameters

Name Description Optional Valid Value Starting Version
sdnControllerUuid The SDN controller UUID. 5.3.0
hostUuid The host UUID. 5.3.0
vSwitchType The virtual switch type. Yes
  • OvsKernel
  • OvsDpdk
  • SRIOV
 5.3.0
nicNames The physical server's nic name list. 5.3.0
vtepIp The physical server's VTEP IP. 5.3.0
systemTags The system tags. For more information, see CreateSystemTag. 是 5.3.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.3.0
netmask The physical server's VTEP IP netmask. 5.3.0
bondMode The physical server's NIC bond mode. Yes 5.3.0
lacpMode Yes 5.3.0

SdnControllerChangeHost

Changes a host for an SDN controller. For example,
SdnControllerChangeHost hostUuid=2dede8695d5346f88cad28212c98d3cf sdnControllerUuid=910df7d2e17c486cb5c20384d59f57da

Parameters

Name Description Optional Valid Value Starting Version
sdnControllerUuid The SDN controller UUID. 5.3.0
hostUuid The host UUID. 5.3.0
vSwitchType The virtual switch type. Yes
  • OvnDpdk
  • OvnKernel
 5.3.0
nicNames The physical server's NIC name list. Yes 5.3.0
vtepIp The physical server's VTEP IP. Yes 5.3.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.3.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.3.0
netmask The physical server's VTEP IP netmask. Yes 5.3.0
bondMode The physical server's bond mode. Yes 5.3.0
lacpMode The physical server's LACP mode. Yes 5.3.0

SdnControllerRemoveHost

Deletes a host from the SDN controller. For example,
SdnControllerRemoveHost hostUuid=2dede8695d5346f88cad28212c98d3cf sdnControllerUuid=910df7d2e17c486cb5c20384d59f57da

Parameters

Name Description Optional Valid Value Starting Version
sdnControllerUuid The SDN controller UUID. 5.3.0
hostUuid The host UUID. 5.3.0
vSwitchType The virtual switch type. Yes
  • OvnDpdk
  • OvnKernel
 5.3.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.3.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.3.0

CreateOvnControllerOffering

Creates an OVN offering. For example,
CreateOvnControllerOffering zoneUuid=782a09ba46aa4763953517747763ed84 memorySize=102400000 name=testovn cpuNum=2 imageUuid=4b01c08ea107467e8556a7e4dc35121c managementNetw
orkUuid=ae46ca68608349ba8d1abd6a12cd6dba

Parameters

Name Description Optional Valid Value Starting Version
zoneUuid The zone UUID. 5.3.20
managementNetworkUuid The management network UUID. 5.3.20
imageUuid The image UUID. 5.3.20
name The offering name. 5.3.20
description The detailed description of the resource. Yes 5.3.20
cpuNum The CPU number. 5.3.20
memorySize The memory size in Byte. 5.3.20
reservedMemorySize Yes 5.3.20
allocatorStrategy The allocate strategy. Yes 5.3.20
sortKey Yes 5.3.20
type Yes 5.3.20
resourceUuid The resource UUID. Yes 5.3.20
tagUuids Tag UUID list. Yes 5.3.20
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.3.20
userTags The user tags. For more information, see CreateUserTag. Yes 5.3.20

CreateNfvInstOffering

Creates an NFV instance offering. For example, 
CreateNfvInstOffering zoneUuid=4e805d7b14bd3f14a91f94775beb12c9 memorySize=102400000 name=testnfv cpuNum=2 imageUuid=3db251b909a13775a8c80f6b76b34f0c managementNetw
orkUuid=8517112e29f13eac8470f918baac3edd

Parameters

Name Description Optional Valid Value Starting Version
zoneUuid The zone UUID. 0.6
managementNetworkUuid 0.6
imageUuid The image UUID. 0.6
name The resource name. 0.6
description Optional. The detailed description of the resource. Yes 0.6
cpuNum 0.6
memorySize 0.6
allocatorStrategy Optional. Yes 0.6
sortKey Optional. Yes 0.6
type Optional. Yes 0.6
resourceUuid Optional. The resource UUID. Yes 0.6
tagUuids Optional. The list of tag UUIDs. Yes 0.6
reservedMemorySize Optional. The system tags. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. Yes 0.6

CreateNfvInst

Creates an NFV instance. For example, 
CreateNfvInst name=NfvInst nfvInstGroupUuid=ebd1efff3ce534129170d32bcb7a8a1b

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 5.4.2
nfvInstGroupUuid 5.4.2
description The detailed description of the resource. Yes 5.4.2
zoneUuid The zone Uuid. Yes 5.4.2
clusterUuid The cluster Uuid. Yes 5.4.2
hostUuid The host Uuid. Yes 5.4.2
resourceUuid The resource Uuid. Yes 5.4.2
tagUuids The list of tag Uuids. Yes 5.4.2
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.2
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.2

AttachNfvInstToGroup

Attaches an NFV instance to an NFV instance group. For example, 
AttachNfvInstToGroup groupUuid=567d546382d33bd2b44b4b52f7109896 nfvInstUuid=5d9126e217473805b351c309279ee492

Parameters

Name Description Optional Valid Value Starting Version
groupUuid 5.4.2
nfvInstUuid 5.4.2
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.3.20
userTags The user tags. For more information, see CreateUserTag. Yes 5.3.20

DetachNfvInstFromGroup

Detaches an NFV instance from an NFV group. For example, 
DetachNfvInstFromGroup groupUuid=ac8a5781ccce3f099a7d99676f4bf518 nfvInstUuid=887cc8c54cfd3b9e8b58ec5e310a7bb0

Parameters

Name Description Optional Valid Value Starting Version
groupUuid 5.4.2
nfvInstUuid 5.4.2
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.2
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.2

ProvisionNfvInstConfig

Provisions an NFV instance configuration.
ProvisionNfvInstConfig vmInstanceUuid=8dcbeddb685a30f5aea4d03b2bb97bf4

Parameters

Name Description Optional Valid Value Starting Version
vmInstanceUuid The VM instance UUID. 0.6
systemTags The system tags. For more information, see CreateSystemTag. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. Yes 0.6

ReconnectNfvInst

Reconnects an NFV instance. For example, 
ReconnectNfvInst vmInstanceUuid=88eff88e87e63114a614f8d7ef6fee60

Parameters

Name Description Optional Valid Value Starting Version
vmInstanceUuid The VM instance Uuid. 0.6
systemTags The system tags. For more information, see CreateSystemTag. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. Yes 0.6

CreateNfvInstGroup

Creates an NFV instance group. For example, 
CreateNfvInstGroup name=nfvInstGroup instType=KVM funcType=DEDICATED_SLB

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 0.6
description The detailed description of the resource. Yes 0.6
instType
  • KVM
 0.6
funcType
  • DEDICATED_SLB
 0.6
monitorIps Yes 0.6
nfvInstOfferingUuid 0.6
frontEndL3NetworkUuid Yes 0.6
backendL3NetworkUuids Yes 0.6
resourceUuid The resource Uuid. Yes 0.6
tagUuids The list of tag UUIDs. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. Yes 0.6
netOsDistro Yes 5.4.2
baseOsDistro Yes 5.4.2
vipUuid VIP UUID Yes 5.4.2
ipv6VipUuid 5.4.2
primaryStorageUuid The primary storage UUID. 5.4.2
primaryStoragePoolUuid 5.4.2
clusterUuid The cluster UUID. 5.4.2
zoneUuid The zone UUID. 5.4.2

DeleteNfvInstGroup

Deletes an NFV instance group. For example, 
DeleteNfvInstGroup uuid=4161bb82e42332bd8a34cec6d4c3aedd deleteMode=Permissive

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource Uuid. 5.4.2
deleteMode The deletion mode (Permissive / Enforcing，Permissive) Yes 5.4.2
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.2
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.2

ProvisionNfvInstGroup

Provisions an NFV group. For example, 
ProvisionNfvInstGroup uuid=f35f1cb6eb9037158a17e2b94d6f3655

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 5.4.2
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.2
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.2

UpdateNfvInstGroup

Updates an NFV group. For example, 
UpdateNfvInstGroup uuid=ff57ab6e79613a40b7e55d38e3069ea5

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.5
name The resource name. 5.5
description The detailed description of the resource. Yes 5.5
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.5
userTags The user tags. For more information, see CreateUserTag. Yes 5.5

SyncNfvInstGroup

Syncs an NFV group. For example, 
SyncNfvInstGroup uuid=f6befd7f753634faba06ac3c4391b9ca

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource Uuid. 5.4.2
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.2
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.2

AddL3NetworkToGroup

Adds a L3 network to a group. For example, 
AddL3NetworkToGroup nfvInstGroupUuid=0c2382cd771b33279d44695f721fc791 networkServiceUuid=cdb5f49b42503212a1b7b2eb77ca3e93 frontEndL3NetworkUuid=2353b0e1eaf430dca4b3024c238e455f

Parameters

Name Description Optional Valid Value Starting Version
nfvInstGroupUuid 0.6
networkServiceUuid 0.6
frontEndL3NetworkUuid 0.6
backendL3NetworkUuids 0.6
systemTags The system tags. For more information, see CreateSystemTag. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. Yes 0.6

ChangeNfvInstGroupOperationMode

Changes an NFV instance group operation mode. For example, 
ChangeNfvInstGroupOperationMode uuid=1dd069e761853e6f83d146e08fc988b7 operationMode=Maintenance

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource Uuid. 5.4.2
operationMode
  • Normal
  • Maintenance
 5.4.2
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.4.2
userTags The user tags. For more information, see CreateUserTag. Yes 5.4.2
PreviousL2 NetworkNextL3 Network
CLI Command Manual | 5.5.30 | ZStack Cloud · ZCF | ZStack Resource Center