L2 Network
Overview
- VLAN, VXLAN, or SDN can be used as an L2 network and can provide layer 2 isolation.
- An L2 network is used to provide layer 2 isolation for an L3 network, as shown in L2 Network.

Four Major Types of L2 Network
- L2NoVlanNetworkL2NoVlanNetwork indicates that VLAN settings are not used for connecting the corresponding host.
- If you set VLAN for a switch port, make sure that the switch port is in Access mode.
- If you do not set VLAN for the switch port, do not make any operation.
- If you create an L2 network, note that a bridge will be created according to the network device that you have entered.
- L2VlanNetworkL2VlanNetwork indicates that VLAN settings are used for connecting the corresponding host.
- The switch port connected by the host must be in Trunk mode.
- The virtual LAN can be divided logically. Notice that it can support 1-4094 subnets.
- If you create an L2 network, notice that a VLAN device will be created according to the network device that you have entered. In addition, a bridge will be created according to the VLAN device.
- VxlanNetworkVxlanNetwork indicates that the VXLAN network is created by using the VNI specialized by VxlanNetworkPool of the Software SDN type.
- VxlanNetwork is created according to VxlanNetworkPool of the Software SDN type.
- Each VxlanNetwork corresponds to a VNI specialized by VxlanNetworkPool of the Software SDN type.
- VxlanNetwork can be used for creating an L3 network.
- HardwareVxlanNetworkHardwareVxlanNetwork indicates that the VXLAN network is created by using the VNI specialized by VxlanNetworkPool of the Hardware SDN type.
- HardwareVxlanNetwork is created according to VxlanNetworkPool of the Hardware SDN type.
- Each HardwareVxlanNetwork corresponds to a VNI specialized by VxlanNetworkPool of the Hardware SDN type.
- HardwareVxlanNetwork can be used for creating an L3 network.
Note:
- When you add NoVlanNetWork or VlanNetwork, enter the NIC name.
- In CentOS 7, the NIC name in the ethX format will be changed after the system reboots. In addition, the NIC sequence will also be randomly changed. We recommend that you change the NIC name of each compute node (especially for VM instances with multiple NICs) to a non-ethX format, such as em01.
Relationship Between L2 Network and Cluster/L3 Network/VM Instance
- If you attached an L2 network to a cluster whereas the L2 network was not attached to a host, you could not add the host to the cluster.
- If you did not attach an L2 network to a cluster and the L2 network was not attached to a host, you could not attach the L2 network to the cluster.
- If you attached an L2 network to a host whereas the corresponding L2 network devices were inconsistently connected to other hosts in a cluster, note that the VM instance IP that you created would not work normally.
- You can use one L2 network to create multiple child L3 networks. If you select the HarewareVxlanNetwork L2 network to create a private network, you can only create a flat network and corresponding network services. vRouter network cannot be created by using the HarewareVxlanNetwork L2 network.
- If you delete an L2 network, notice that the corresponding L3 network will also be deleted, and that the VM NIC in the L3 network will be deleted as well.
- If you delete an L2 network, you will also delete the vRouter, VPC vRouter, and vRouter offering in the L2 network.
- If you delete the corresponding L2 network of a public network, notice that all network services of the corresponding router will be deleted, including the vRouter, VPC vRouter, vRouter offering, virtual IP, elastic IP, port forwarding, load balancing, IPsec tunnel, and Netflow.
- You can create multiple VxlanNetworks by using a VXLAN Pool of the Software SDN type. These VxlanNetworks can be applied to the flat network, vRouter network, or VPC network respectively.
- VM instances in VxlanNetwork cannot be accessed through the Internet. To access these VM instances through the Internet, use an elastic IP or port forwarding.
- You can also create multiple HardwareVxlanNetworks by using a VXLAN Pool of the Hardware SDN type. These HardwareVxlanNetworks can currently be applied to flat networks.
Inventory
Properties
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| attachedCidrs | 4.8.0 | |||
| vni | 4.8.0 | |||
| poolUuid | 4.8.0 | |||
| vlan | 4.8.0 | |||
| uuid | The UUID. For more information, see Resource Property. | 0.6 | ||
| name | The name. For more information, see Resource Property. | 0.6 | ||
| description | The description. For more information, see Resource Property. | Yes | 0.6 | |
| zoneUuid | The UUID of the parent zone. For more information, see Zone. | 0.6 | ||
| physicalInterface | The physical interface. For more information, see Physical Interface. | 0.6 | ||
| type | The L2 network type. |
|
0.6 | |
| attachedClusterUuids | The clusters to which the L2 network is attached. For more information, see Attach Cluster. | 0.6 | ||
| createDate | The creation date. For more information, see Resource Property. | 0.6 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 0.6 | ||
| attachedVtepRefs | For more information, see attachedVtepRefs Inventoy. | 4.8.0 | ||
| attachedVxlanNetworkRefs | For more information, see attachedVxlanNetworkRefs Inventoy. | 4.8.0 | ||
| attachedVniRanges | For more information, see attachedVniRanges Inventoy. | 4.8.0 |
Sample
{
"inventories": [
{
"attachedClusterUuids": [
"553c2fd2a67b4b89a6240541959b861f"
],
"createDate": "Mar 10, 2018 2:35:14 PM",
"description": "",
"lastOpDate": "Mar 10, 2018 2:35:14 PM",
"name": "L2Network-1",
"physicalInterface": "eth0",
"type": "L2NoVlanNetwork",
"uuid": "dde9685e3ba944bea8c643fe64200750",
"zoneUuid": "fa18454182eb41749797f824c00cfccf"
}
],
"success": true
}
Physical Interface
A physical interface is a string, such as eth0. The string contains information about the related L2 network in the data center. Normally, different types of the L2 network and different types of hypervisors have different physical interfaces. This is because the hypervisors use their own notations to describe L2 networks, and an L2 network can be simultaneously attached to multiple clusters of different hypervisor types.

Many operations seemingly applied to zones and clusters are actually delegated to hosts. Here, when L2 Network A is attached to the KVM cluster and the VMware cluster, ZStack Cloud must understand how the hypervisor in these clusters use the notations to describe the L2 network. That is, eth0 on the KVM host represents the L2 network, while vswitch0 on the VMware host also represents the L2 network. Therefore, the name of a physical interface can also reflect different hypervisors.
Attach Cluster

Assume that the network topology in your data center is as the above. The eth0s of the hosts in all clusters are on the same L2 network (L2 Network1), while eth1s of the hosts in Cluster1 and Cluster3 are on another L2 network (L2 Network2). To describe this topology in ZStack Cloud, you can attach L2 Network1 to all the three clusters, and attach only L2 Network2 to Cluster1 and Cluster3.

L2NoVlanNetwork
L2NoVlanNetwork is a basic type of L2 network. NoVlan in L2NoVlanNetwork does not mean that you cannot use the VLAN technology. Contrarily, it simply means that ZStack Cloud will not take the initiative to use VLAN to create a layer 2 broadcast domain. The following two topologies can help you better understand the L2NoVlanNetwork.
As shown in Configuration of L2NoVlanNetwork 1.

In the figure above, both Port 5 and Port 12 in L2 Switch are untagged with VLAN 10 (access port with VLAN 10 in Cisco term), and connect to eth0 on Host1 and Host2 respectively. This is an effective configuration for L2NoVlanNetwork. You can use physicalInterface = eth0 to create an L2NoVlanNetwork, and attach it to Cluster.
As shown in Configuration of L2NoVlanNetwork 2.

In the figure above, both Port 5 and Port 12 in L2 Switch are tagged with VLAN 10 (trunk port with VLAN 10 in Cisco term), and connect to eth0.10 (a pre-created VLAN device) on Host1 and Host2 respectively. This is also an effective configuration for L2NoVlanNetwork. You can use physicalInterface = eth0.10 to create an L2NoVlanNetwork, and attach it to Cluster.
That is, one L2NoVlanNetwork corresponds to a pre-created layer 2 broadcast domain. ZStack Cloud will not create any new broadcast domain for an L2NoVlanNetwork.
L2NoVlanNetwork KVM Specifications
Assuming physicalInterface = eth0
brctl create br_eth0
brctl addif br_eth0 eth0{
"inventories": [
{
"attachedClusterUuids": [
"967a353c2893409dab9312cf3033a98c"
],
"createDate": "Oct 30, 2017 1:53:20 PM",
"description": "",
"lastOpDate": "Oct 30, 2017 1:53:20 PM",
"name": "L2NoVlan",
"physicalInterface": "eth0",
"type": "L2NoVlanNetwork",
"uuid": "5f0391e0c7ed45dba5ee5ed9c638f146",
"zoneUuid": "e59b71e99d8a4ea1952b578388b8cd1d"
}
],
"success": true
}L2VlanNetwork
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vlan | The VLAN ID for creating a layer 2 broadcast domain. | [0, 4095] | 0.6 |
When you attach an L2VlanNetwork to a cluster, note that ZStack Cloud will create a VLAN device on the host in the cluster. To make this operation take effect, make sure that the switch port to which the Ethernet device specified by physicalInterface connects has a VALN tag.
As shown in Configuration of L2VlanNetwork.

In the figure above, both Port 5 and Port 12 of L2 Switch are tagged with VLAN 10. You can use physicalInterface = eth0 and vlan = 10 to create an L2VlanNetwork, and attach it to Cluster.
L2VlanNetwork KVM Specifications
Assuming physicalInterface = eth0, vlan = 10
vconfig add eth0 10
brctl create br_eth0_10
brctl addif br_eth0_10 eth0.10{
"inventories": [
{
"attachedClusterUuids": [],
"createDate": "Oct 30, 2017 1:41:19 PM",
"description": "",
"lastOpDate": "Oct 30, 2017 1:41:19 PM",
"name": "L2Vlan",
"physicalInterface": "eth0",
"type": "L2VlanNetwork",
"uuid": "ae97ba4adcb7404690344dde407b429c",
"vlan": 2222,
"zoneUuid": "e59b71e99d8a4ea1952b578388b8cd1d"
}
],
"success": true
}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 | ||
| username | 3.7.0 | |||
| vendorType | 3.7.0 | |||
| vniRanges | 3.7.0 | |||
| vxlanPools | 3.7.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 |
{
"inventories": [
{
"createDate": "Oct 23, 2019 3:17:40 PM",
"ip": "172.20.12.165",
"lastOpDate": "Oct 23, 2019 3:17:40 PM",
"name": "gtt",
"password": "Password",
"username": "shixin",
"uuid": "5ce966372dde4169865474b88973a9d8",
"vendorType": "H3C VCFC",
"vniRanges": [
{
"endVni": 3000,
"startVni": 3000
},
{
"endVni": 2009,
"startVni": 10
}
],
"vxlanPools": [
{
"attachedCidrs": {},
"attachedClusterUuids": [
"f34570997a594344ad698280305a1a9a"
],
"attachedVniRanges": [
{
"createDate": "Oct 23, 2019 3:17:52 PM",
"endVni": 29,
"l2NetworkUuid": "0b03b34eb79b46d99d2c0aa074bc2385",
"lastOpDate": "Oct 23, 2019 3:17:52 PM",
"name": "gtt",
"startVni": 23,
"uuid": "3691fb6e4d194eb39d9c49dc3c780816"
}
],
"attachedVtepRefs": [],
"attachedVxlanNetworkRefs": [],
"createDate": "Oct 23, 2019 3:17:52 PM",
"description": "",
"lastOpDate": "Oct 23, 2019 3:17:52 PM",
"name": "gtt",
"physicalInterface": "eth0",
"sdnControllerUuid": "5ce966372dde4169865474b88973a9d8",
"type": "hardware-vxlan-pool",
"uuid": "0b03b34eb79b46d99d2c0aa074bc2385",
"zoneUuid": "182bd537a902404a94f6412d285d277e"
}
]
}
],
"success": true
}
attachedVtepRefs Inventoy
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| hostUuid | The host UUID. | 4.8.0 | ||
| vtepIp | 4.8.0 | |||
| port | 4.8.0 | |||
| type | The type of l2 network. | 4.8.0 | ||
| createDate | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| lastOpDate | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| poolUuid | 4.8.0 |
attachedVxlanNetworkRefs Inventoy
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vni | 4.8.0 | |||
| poolUuid | 4.8.0 | |||
| uuid | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| name | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| description | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| zoneUuid | The UUID of the parent zone. For more information, see Zone. | 4.8.0 | ||
| physicallnterface | The physical interface. For more information, see Physical Interface. | 4.8.0 | ||
| type | The type of l2 network. | 4.8.0 | ||
| createDate | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| lastOpDate | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| attachedClusterUuids | 4.8.0 |
attachedVniRanges Inventoy
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| name | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| description | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| startVni | 4.8.0 | |||
| endVni | 4.8.0 | |||
| createDate | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| lastOpDate | The UUID. For more information, see Resource Property. | 4.8.0 | ||
| l2NetworkUuid | The l2 network UUID. | 4.8.0 |
Operations
CreateL2VxlanNetworkPool
CreateL2VxlanNetworkPool name=testvxlan zoneUuid=8abab36040884e6fbec05fa70c5ef873 \
physicalInterface=eth0Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The VXLAN pool name. | 0.6 | ||
| description | The detailed description of the VXLAN pool. | Yes | 0.6 | |
| zoneUuid | The zone UUID. | 0.6 | ||
| physicalInterface | The physical interface. | 0.6 | ||
| type | The type. | Yes | 0.6 | |
| resourceUuid | The resource UUID. If specified, the image will use the specified value as the UUID. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| vSwitchType | The vSwitch type. | Yes |
|
4.8.0 |
| tagUuid | The tag UUID list. | Yes | 4.8.0 | |
| timeout | Yes |
QueryL2VxlanNetworkPool
QueryL2VxlanNetworkPool uuid=064a634df0b742e89d088655454ce63dQueryL2VxlanNetworkPool zone.uuid=8abab36040884e6fbec05fa70c5ef873Primitive Fields of Query
See L2 VxlanNetworkPool Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| attachedVniRanges | Attached VNI Range Inventory | 0.6 | |
| attachedVtepRefs | Attached VTEP Reference Inventory | 0.6 | |
| attachedVxlanNetworkRefs | Attached VxlanNetwork Reference Inventory | 0.6 | |
| cluster | Cluster Inventory | All clusters to which the L2 network is attached. | 0.6 |
| l2VxlanNetwork | L2VxlanNetwork Inventory | 0.6 | |
| l3Network | L3 Network Inventory | The L3 network that belongs to the L2 network. | 0.6 |
| vniRange | VNI Range Inventory | 0.6 | |
| vtep | VTEP Inventory | The VXLAN tunnel endpoint. | 0.6 |
| zone | Zone Inventory | The parent zone. | 0.6 |
CreateL2VxlanNetwork
CreateL2VxlanNetwork name=L2VXLAN zoneUuid=e59b71e99d8a4ea1952b578388b8cd1d \
physicalInterface=eth0 poolUuid=1cac60dd6f124861aa99d85f51a9b4feParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The common L2 network name. | 0.6 | ||
| description | The detailed description of the common L2 network. | Yes | 0.6 | |
| zoneUuid | The zone UUID. | 0.6 | ||
| physicalInterface | The physical interface. | 0.6 | ||
| poolUuid | The VXLAN pool UUID. | 0.6 | ||
| vni | The VXLAN network ID. | Yes | 0.6 | |
| type | The type. | Yes | 0.6 | |
| resourceUuid | The resource UUID. If specified, the image will use the specified value as the UUID. | Yes | 0.6 | |
| vSwitchType | The vSwitch type | Yes |
|
4.8.0 |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| timeout | Yes |
QueryL2VxlanNetwork
QueryL2VxlanNetwork uuid=6e287827ec1f4927a90637e7c96ca92eQueryL2VxlanNetwork zone.uuid=e59b71e99d8a4ea1952b578388b8cd1dPrimitive Fields of Query
See L2 VxlanNetwork Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| cluster | Cluster Inventory. | All clusters to which the L2 network is attached. | 0.6 |
| l3Network | L3 Network Inventory. | The L3 network that belongs to the L2 network. | 0.6 |
| vxlanPool | VXLAN Pool Inventory | The VXLAN pool of the L2 network. | 0.6 |
| zone | Zone Inventory. | The parent zone. | 0.6 |
CreateL2NoVlanNetwork
CreateL2NoVlanNetwork name=management-network physicalInterface=eth0 \
zoneUuid=9a94e647a9f64bb392afcdc5396cc1e4Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The common L2 network name. | 0.6 | ||
| description | The detailed description of the common L2 network. | Yes | 0.6 | |
| zoneUuid | The zone UUID. | 0.6 | ||
| physicalInterface | The physical interface. | 0.6 | ||
| type | The type. | Yes | 0.6 | |
| vSwitchType | The vSwitch type. | Yes | 4.8.0 | |
| resourceUuid | The resource UUID. If specified, the image will use the specified value as the UUID. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| tagUuids | The tag UUID list. | Yes | 4.8.0 | |
| timeout | Yes |
Note:
- When you create a normal L2 network in ZStack Cloud, you can enable SR-IOV by adding the
enableSRIOV option to SystemTags.
- Format of the enableSRIOV option:
enableSRIOV - Example:
enableSRIOV.
- Format of the enableSRIOV option:
CreateL2VlanNetwork
CreateL2VlanNetwork name=testvlan zoneUuid=8abab36040884e6fbec05fa70c5ef873 \
physicalInterface=eth0 vlan=2637Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vlan | 0.6 | |||
| name | The L2 VLAN network name. | 0.6 | ||
| description | The detailed description of the L2 VLAN network. | Yes | 0.6 | |
| zoneUuid | The zone UUID. | 0.6 | ||
| physicalInterface | The physical interface. | 0.6 | ||
| type | Yes | 0.6 | ||
| vSwitchType | The vSwitch type. | Yes | 4.8.0 | |
| resourceUuid | The resource UUID. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| timeout | Yes |
Note:
- When you create an L2 VLAN network in
ZStack Cloud, you can enable SR-IOV by adding the enableSRIOV option
to SystemTags.
- Format of the enableSRIOV option:
enableSRIOV - Example:
enableSRIOV
- Format of the enableSRIOV option:
QueryL2VlanNetwork
QueryL2VlanNetwork physicalInterface=eth0QueryL2VlanNetwork zone.cluster.zoneUuid=8abab36040884e6fbec05fa70c5ef873Primitive Fields of Query
See L2 VLAN Network Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| l3Network | L3 Network Inventory | The L3 network that belongs to the L2 network. | 0.6 |
| cluster | Cluster Inventory | All clusters to which the L2 network is attached. | 0.6 |
| zone | Zone Inventory | The parent zone. | 0.6 |
DeleteL2Network
DeleteL2Network uuid=a5535531eb7346ce89cfd7e643ad1ef8Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The L2 network UUID. | 0.6 | ||
| deleteMode | The delete mode. For more information, see Delete Resources. | Yes |
|
0.6 |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| timeout | Yes |
QueryL2Network
QueryL2Network physicalInterface=eth0QueryL2Network l3Network.ipRanges.startIp=192.168.0.2Primitive Fields of Query
See L2 Network Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| l3Network | L3 Network Inventory | The L3 network that belongs to the L2 network. | 0.6 |
| cluster | Cluster Inventory | All clusters to which the L2 network is attached. | 0.6 |
| zone | Zone Inventory | The parent zone. | 0.6 |
UpdateL2Network
UpdateL2Network uuid=cc42d175ed9649558af69b8a0b824b9aParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The L2 network UUID. | 0.6 | ||
| name | The common L2 network name. | Yes | 0.6 | |
| description | The detailed description of the common L2 network. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| timeout | Yes |
GetL2NetworkTypes
{
"l2NetworkTypes": [
"VxlanNetworkPool",
"VxlanNetwork",
"L2NoVlanNetwork",
"L2VlanNetwork"
]
}
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| timeout | Yes |
AttachL2NetworkToCluster
AttachL2NetworkToCluster clusterUuid=2379a0d00ae242df91189f6d7d9e23e3 \
l2NetworkUuid=cc42d175ed9649558af69b8a0b824b9aParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| l2NetworkUuid | The L2 network UUID. | 0.6 | ||
| clusterUuid | The cluster UUID. | 0.6 | ||
| l2ProviderType | The L2 provider type. | Yes |
|
4.8.0 |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| timeout | Yes |
DetachL2NetworkFromCluster
DetachL2NetworkFromCluster clusterUuid=2379a0d00ae242df91189f6d7d9e23e3 \
l2NetworkUuid=cc42d175ed9649558af69b8a0b824b9aParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| l2NetworkUuid | The L2 network UUID. | 0.6 | ||
| clusterUuid | The cluster UUID. | 0.6 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| timeout | Yes |
CreateVniRange
CreateVniRange name=vni startVni=8034 endVni=9322 l2NetworkUuid=1cac60dd6f124861aa99d85f51a9b4feParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The VNI range name. | 0.6 | ||
| description | The detailed description of the VNI range. | Yes | 0.6 | |
| startVni | 0.6 | |||
| endVni | 0.6 | |||
| l2NetworkUuid | The VXLAN pool UUID. | 0.6 | ||
| resourceUuid | The resource UUID. If specified, the image will use the specified value as the UUID. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The user tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| timeout | Yes |
QueryVniRange
QueryVniRange uuid=d0b6064810d945c582448fed6cb98d54QueryVniRange vxlanPool.uuid=1cac60dd6f124861aa99d85f51a9b4fePrimitive Fields of Query
See VNI Range Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| vxlanPool | VXLAN Pool Inventory | 0.6 |
DeleteVniRange
DeleteVniRange uuid=d0b6064810d945c582448fed6cb98d54Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The VNI range UUID. | 0.6 | ||
| deleteMode | The delete mode. For more information, see Delete Resources. | Yes |
|
0.6 |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 0.6 | |
| timeout | Yes |
UpdateVniRange
UpdateVniRange uuid=d0b6064810d945c582448fed6cb98d54Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The VNI range UUID. | 3.3.0 | ||
| name | Yes | 3.3.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 3.3.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 3.3.0 | |
| timeout | Yes |
CreateL2TfNetwork
CreateL2TfNetwork name=testtf zoneUuid=b3a3bf9d1b1b44ca8631ffa3538bc59d \
physicalInterface=eth0Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| ipPrefix | The IP address prefix. | Yes | 4.8.0 | |
| ipPrefixLength | The IP address prefix length. | Yes | 4.8.0 | |
| name | The resource name. | 4.8.0 | ||
| description | The detailed description of the resource. | Yes | 4.8.0 | |
| zoneUuid | The zone UUID. | 4.8.0 | ||
| physicalInterface | The physical interface. | 4.8.0 | ||
| type | The type. | Yes | 4.8.0 | |
| resourceUuid | The resource UUID. If specified, the image will use the specified value as the UUID. | Yes | 4.8.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 4.8.0 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 4.8.0 | |
| vSwitchType | The vSwitch type. | Yes |
|
4.8.0 |
| timeout | Yes |
CreateL2HardwareVxlanNetwork
CreateL2HardwareVxlanNetwork name=test-hardvxlan zoneUuid=b3a3bf9d1b1b44ca8631ffa3538bc59d \
physicalInterface=eth0Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vni | Yes | 4.8.0 | ||
| poolUuid | ||||
| name | The resource name. | 4.8.0 | ||
| description | The detailed description of the resource. | Yes | 4.8.0 | |
| zoneUuid | The zone UUID. | 4.8.0 | ||
| physicalInterface | The physical interface. | 4.8.0 | ||
| type | The type. | Yes | 4.8.0 | |
| resourceUuid | The resource UUID. If specified, the image will use the specified value as the UUID. | Yes | 4.8.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 4.8.0 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 4.8.0 | |
| vSwitchType | The vSwitch type. | Yes |
|
4.8.0 |
| timeout | Yes |
CreateL2HardwareVxlanNetworkPool
CreateL2HardwareVxlanNetworkPool name=test-hardvlanpool sdnControllerUuid=0b2231798a5c3971811ca4c9647776b8 zoneUuid=b3a3bf9d1b1b44ca8631ffa3538bc59d \
physicalInterface=eth0Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| sdnControllerUuid | The SDN controller uuid. | 4.8.0 | ||
| name | The resource name. | 4.8.0 | ||
| description | The detailed description of the resource. | Yes | 4.8.0 | |
| zoneUuid | The zone UUID. | 4.8.0 | ||
| physicalInterface | The physical interface. | 4.8.0 | ||
| type | The type. | Yes | 4.8.0 | |
| resourceUuid | The resource UUID. If specified, the image will use the specified value as the UUID. | Yes | 4.8.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 4.8.0 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 4.8.0 | |
| vSwitchType | The vSwitch type. | Yes |
|
4.8.0 |
| timeout | Yes |
GetVSwitchTypes
GetVSwitchTypes name=test-vswitchtype zoneUuid=b3a3bf9d1b1b44ca8631ffa3538bc59d \
physicalInterface=eth0Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| systemTags | The system tags. For more information, see CreateSystemTag. The resource type is L2NetworkVO. | Yes | 4.8.0 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is L2NetworkVO. | Yes | 4.8.0 | |
| timeout | Yes |
Hardware SDN Controller
AddSdnController
AddSdnController vendorType=vendor name=sdn-1 ip=192.168.1.1 userName=admin password=passwordParameters
| 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 | 3.7.0 | |||
| password | 3.7.0 | |||
| resourceUuid | Yes | 3.7.0 | ||
| tagUuids | The tag UUID list. | Yes | 3.7.0 | |
| userTags | The user tags. For information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.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
- Format of the H3C_VDS_UUID option:
QuerySdnController
QuerySdnControllerPrimitive Fields of Query
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| vxlanPool | VLAN Pool Inventory | The VXLAN pool of the L2 network. | 3.7.0 |
RemoveSdnController
RemoveSdnController uuid=237901c5097b38c480315569a1ac7567Parameters
| 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 |
UpdateSdnController
UpdateSdnController uuid=722428da8bac30d2b75daa2f6cd34e9dParameters
| 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 |
Tags
CreateUserTag resourceType=L2NetworkVO tag=publicL2 \
resourceUuid=cff4be8694174b0fb831a9fe53b1d62b