Document navigation

L3 Network

Overview

An L3 network is a collection of network configurations for VM instances, including the IP range, gateway, DNS, and network services.
  • An IP range includes the start IP address, end IP address, netmask, and gateway. For example, specify the IP range from 172.20.12.2 to 172.20.12.255, set the netmask to 255.255.0.0, and set the gateway to 172.20.0.1. In addition, you can use a CIDR to specify an IP range, such as 192.168.1.0/24.
  • DNS provides DNS resolution services used for configuring VM networks.

Public Network

Generally, a public network is a type of network wherein anyone has access and through it can directly connect to the Internet. Due to a fact that the public network is a logical concept, you can also customize the public network when you cannot access the Internet. In addition, the public network can provide the network service in a vRouter network and a VPC network.
  • The public network can be used in the flat network environment to create VM instances.
  • The public network can be used in the vRouter network environment to create vRouters.
  • The public network can be used in the VPC network environment to create VPC vRouters.

System Network

A system network is a specific network used by a management node.
  • The system network can be used as a management network to deploy and set related resources, such as a host, primary storage, backup storage, and vRouter.
  • The system network can be used as a migration network to migrate VM instances.
  • Assume that your network resources are insufficient, and that you cannot use a management network separately. Then, the public network will act as the management network.
  • An independent system network can be used in a specific manner, such as managing the vRouter network.
  • The system network cannot be used to create regular VM instances.

Private Network

A private network is known as a business network or an access network. Generally, VM instances use the private network. The private network is specified as the network used by VM instances, and supports three network architecture models: flat network, vRouter network, and VPC network.

Specific Network Scenarios

  • Management Network
    A management network is a type of a system network, which can be used for managing and controlling the corresponding physical resources.
    • For example, when you access a host, a backup storage, a primary storage, and other resources that require an IP address, use the management network.
    • When you create vRouters or VPC vRouters, you need an IP address that can be interconnected between management networks in vRouters or VPC vRouters. With this IP address, you can deploy an agent and obtain messages returned by the agent.
  • Storage Network

    A storage network is the network specified by the shared storage. You can use the storage network to check the health state of a VM instance. We recommend that you plan for an independent storage network in advance to avoid potential risks.

  • VDI Network

    When you create clusters, you can specify CIDR for the VDI network. In the VDI scenario, the network traffics generated by the protocol communication between server side and client side use the VDI network. If you do not make any configuration to the VDI network, notice that the management network will be used by default.

  • Migration Network

    When you create clusters, you can specify CIDR for the migration network, which can be used for VM migrations. If you do not make any configuration to the migration network, notice that the management network will be used for VM migrations.

  • Image Synchronization Network
    An image synchronization network is the network that images can be synchronized among backup storages with the ImageStore type in the same management node.
    • If you have deployed an independent network for synchronizing images, you can specify CIDR for the image synchronization network.
    • If you do not make any configuration to the image synchronization network, the management network will be used by default.
    • If you set both source image store and target image store as the image synchronization network, only the target image store can take effect.
  • Data Network
    A data network is the network where data can transfer between a compute node and a backup storage.
    • If you use an independent data network, you can avoid network congestion, and improve the data transfer rate.
    • If you do not make any configuration to the data network, the management network will be used by default.
  • Backup Network
    ZStack Cloud provides backup services, which are add-on licensed features. A backup network is the network where you can back up your local VM instances, volumes, or databases to the local backup storage. Also, the backup network is the network where you can restore the local backup data from the local backup storage.
    • If you deploy an independent network for local backups, you can specify CIDR for the backup network.
    • If you use an independent network, you can avoid network congestion and improve the data transfer rate.
    • If you do not make any configuration to the backup network, note that the management network will be used for local backup by default.
    Note:

    Backup Service is a separate feature module. To use this feature, purchase both the Base License and the Plus License of Backup Service. The Plus License cannot be used independently.

  • Traffic Network

    A traffic network is the specified network of a port mirroring, which can be used to mirror the network traffic in the NIC to remote access. In addition, the traffic network cannot act as other networks, and cannot be used to create VM instances.

Notice

  • When you create VM instances, you can specify multiple networks. That is, you can specify multiple flat networks, vRouter networks, VPC networks, or a combination of flat networks, vRouter networks, and VPC networks.
  • We support multi-layer networks. In addition, the L2 networks of multi-layer networks can intercommunicate. Therefore, you need to pay a special attention to avoid the conflict of IP address spaces.
  • You can create multiple L3 networks by using an L2 network. If the L2 network is the HarewareVxlanNetwork type, the private network that you created can only support the flat network and other corresponding network services rather than vRouter network.

Inventory

Properties

Name Description Optional Valid Value Starting Version
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 zone UUID. For more information, see Zone. 0.6
l2NetworkUuid The parent L2 network UUID. For more information, see L2 Network. 0.6
state The state. For more information, see State.
  • Enabled
  • Disabled
0.6
dnsDomain The DNS domain. For more information, see Domain. Yes 0.6
ipRanges The IP ranges. For more information, see IP Range. 0.6
dns The DNS. For more information, see L3 Network DNS. 0.6
networkServices The network services. For more information, see L3 Network Service Reference. 0.6
type The L3 network type.
  • L3BasicNetwork
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

Sample

{
    "inventories": [
        {
            "category": "Private",
            "createDate": "Nov 2, 2017 1:21:40 PM",
            "dns": [
                "223.5.5.5"
            ],
            "ipRanges": [
                {
                    "createDate": "Nov 2, 2017 1:21:41 PM",
                    "endIp": "10.141.74.100",
                    "gateway": "10.141.0.1",
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "lastOpDate": "Nov 2, 2017 1:21:41 PM",
                    "name": "l3-bp",
                    "netmask": "255.255.0.0",
                    "networkCidr": "10.141.0.1/16",
                    "startIp": "10.141.74.1",
                    "uuid": "954f7884656e48a395a022935569b65d"
                }
            ],
            "l2NetworkUuid": "8f6a39152a72439b9ece210154de0339",
            "lastOpDate": "Nov 2, 2017 1:21:40 PM",
            "name": "l3-bp",
            "networkServices": [
                {
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "networkServiceProviderUuid": "a903477ad67746e8a4f773c5e28b5884",
                    "networkServiceType": "SecurityGroup"
                },
                {
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
                    "networkServiceType": "Eip"
                },
                {
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
                    "networkServiceType": "DHCP"
                },
                {
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
                    "networkServiceType": "Userdata"
                }
            ],
            "state": "Enabled",
            "system": false,
            "type": "L3BasicNetwork",
            "uuid": "a0190782ed35439b92959844c96a7323",
            "zoneUuid": "e59b71e99d8a4ea1952b578388b8cd1d"
        }
    ],
    "success": true
}

State

An L3 network has two available states.
  • Enabled:

    Indicates that new VM instances can be created.

  • Disabled:

    Indicates that new VM instances cannot be created.

DNS Domain

A DNS domain is used to expand hostnames of VM instances on the L3 network to Full Qualified Domain Names (FQDNs). For example, if the hostname of a VM instance is vm1 and the DNS domain of the L3 network is zstack.org, the final hostname of the VM instance will be expanded to vm1.zstack.org.

IP Range

The current ZStack version supports only IPv4 IP range.

Inventory
Name Description Optional Valid Value Starting Version
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
startIp The start IP address in the IP range. 0.6
endIp The end IP address in the IP range. 0.6
netmask The netmask. 0.6
gateway The subnet gateway. 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
Sample
{
    "inventories": [
        {
            "createDate": "Oct 30, 2017 3:59:06 PM",
            "endIp": "10.141.250.100",
            "gateway": "10.141.0.1",
            "l3NetworkUuid": "54bc8bea439a49dc82acbe302da05c66",
            "lastOpDate": "Oct 30, 2017 3:59:06 PM",
            "name": "L3-Flat",
            "netmask": "255.255.0.0",
            "networkCidr": "10.141.0.1/16",
            "startIp": "10.141.250.1",
            "uuid": "f0b8e83e4dc646c69c7f9a0ff53b6367"
        }
    ],
    "success": true
}

DNS

An L3 network can have one or more DNS take effect when the DNS network service is enabled.

L2 Network and L3 Network

Similar to a layer 2 broadcast domain that can contain multiple subnets, you can create multiple L3 networks on the same L2 network. However, these L3 networks are not isolated from each other, and can be listened, which might be a potential risk.

L3 Network Service Reference

Network service reference denotes the network services enabled on the L3 network and their service providers.

Inventory
Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 0.6
networkServiceProviderUuid The UUID of the network service provider. 0.6
networkServiceType The network service type.
  • DHCP
  • DNS
  • SNAT
  • PortForwarding
  • EIP
  • SecurityGroup
  • Userdata
  • LoadBalancer
  • IPsec
  • CentralizedDNS
  • VRouterRoute
  • VipQos
0.6
Sample
{
    "inventories": [
        {
            "l3NetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
            "networkServiceProviderUuid": "a903477ad67746e8a4f773c5e28b5884",
            "networkServiceType": "SecurityGroup"
        },
        {
            "l3NetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
            "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
            "networkServiceType": "Userdata"
        },
        {
            "l3NetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
            "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
            "networkServiceType": "DHCP"
        }
    ],
    "success": true
}

Address Pool Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.9.0
name The name. For more information, see Resource Property. 3.9.0
description The description. For more information, see Resource Property. 3.9.0
l3NetworkUuid The L3 network UUID. 3.9.0
startIp The start IP address. 3.9.0
endIp The end IP address. 3.9.0
netmask The netmask. 3.9.0
gateway The gateway. 3.9.0
networkCidr The network CIDR. 3.9.0
ipVersion The IP version. 3.9.0
addressMode The allocation mode of the IPv6 address. 3.9.0
prefixLen The length of the netmask. 3.9.0
ipRangeType The IP range type.
  • Normal
  • AddressPool
3.9.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.9.0
createDate The creation date. For more information, see Resource Property 3.9.0
lastOpDate The last operation date. For more information, see Resource Property 3.9.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.9.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.9.0
Sample
{
  "inventories": [
    {
      "l3NetworkUuid": "81ce7828f3f63c0ea8a69dd9139bdaa0",
      "name": "Test-IPRange",
      "networkCidr": "192.168.10.0/24",
      "ipRangeType": "AddressPool"
    }
  ]
}

Operations

CreateL3Network

Creates an L3 network. For example,
CreateL3Network name=L3Network l2NetworkUuid=21fd3d1876594b79bab0f2f1dfa1d03c dnsDomain="site.net"

Parameters

Name Description Optional Valid Value Starting Version
name The L3 network name. 0.6
description The detailed description of the L3 network. Yes 0.6
type The L3 network type. Yes 0.6
l2NetworkUuid The L2 network UUID. 0.6
ipVersion The IP version. Yes
  • 4
  • 6
4.6.21
system Whether the L3 network can be applied to appliance VM instances. Yes 0.6
dnsDomain The DNS domain. Yes 0.6
resourceUuid The resource UUID. If specified, the L3 network will use the specified value as the UUID. Yes 0.6
category The network type, which must be used with the system tags. If system is set to false, the category can be set to Public or Private. Yes
  • Public
  • Private
  • System
2.2
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
tagUuids The tag UUID list. Yes 4.6.21
enableIPAM Whether to enable the IP address management. Yes 4.6.21
timeout Yes
Note:
  • When you create an L3 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 an L3 network in ZStack Cloud, you can record the Huawei SDN virtual router associated with the VPC gateway by adding the logicalRouterUuid option to SystemTags.
    • Format of the logicalRouterUuid option: logicalRouterUuid::{L3NetworkVOUuid}
    • Example: logicalRouterUuid::ecb4a71e0e32476da948a583ea0a220d

DeleteL3Network

Deletes an L3 network. For example,
DeleteL3Network uuid=18874dbd1f0c4e8abd399776ae914401

Parameters

Name Description Optional Valid Value Starting Version
uuid The L3 network UUID. 0.6
deleteMode The delete mode. For more information, see Delete Resources. Yes
  • Permissive
  • Enforcing
0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

QueryL3Network

Queries an L3 network. For example,
QueryL3Network uuid=9082f45fce9c46f19b2ab5ff117511d6
QueryL3Network vmNic.l3NetworkUuid=9082f45fce9c46f19b2ab5ff117511d6

Primitive Fields of Query

See L3 Network Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
l2Network L2 Network Inventory The L2 network to which the L3 network belongs. 0.6
ipRanges IP Range Inventory 0.6
zone Zone Inventory The parent zone. 0.6
networkServices Network Service Inventory 0.6
serviceProvider Service Provider Inventory 0.6
vmNic VM NIC Inventory 0.6
hostRoute Host Route Inventory 2.3

UpdateL3Network

Updates an L3 network. For example,
UpdateL3Network name=test_L3Network uuid=3dbf30420a4b4da8bcd69f99df7fb631

Parameters

Name Description Optional Valid Value Starting Version
uuid The L3 network UUID. 0.6
name The L3 network name. Yes 0.6
description The detailed description of the L3 network. Yes 0.6
system Whether the L3 network can be applied to appliance VM instances. Yes 0.6
dnsDomain The DNS domain Yes 2.6.0
category The network type, which must be used with the system tags. If system is set to true, the category can be set to Public or Private. Yes
  • Public
  • Private
  • System
2.2
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

GetL3NetworkTypes

Obtains L3 network types. Sample response:
{
    "l3NetworkTypes": [
        "L3BasicNetwork",
        "L3VpcNetwork"
    ]
}

Parameters

Name Description Optional Valid Value Starting Version
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

ChangeL3NetworkState

Changes the L3 network state. For example,
ChangeL3NetworkState uuid=3dbf30420a4b4da8bcd69f99df7fb631 stateEvent=disable

Parameters

Name Description Optional Valid Value Starting Version
uuid The L3 network UUID. 0.6
stateEvent The state.
  • Enable
  • Disable
0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

GetL3NetworkDhcpIpAddress

Obtains the DHCP IP address of an L3 network. For example,
GetL3NetworkDhcpIpAddress l3NetworkUuid=aa6ec2f40b93413aa843ee5d76ddf73e

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

RemoveDnsFromL3Network

Removes a DNS address from an L3 network. For example,
RemoveDnsFromL3Network l3NetworkUuid=3dbf30420a4b4da8bcd69f99df7fb631 dns=114.114.114.114

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 0.6
dns The DNS address. 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

AddDnsToL3Network

Adds a DNS address to an L3 network. For example,
AddDnsToL3Network l3NetworkUuid=3dbf30420a4b4da8bcd69f99df7fb631 dns=114.114.114.114

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 0.6
dns The DNS address. 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

AddHostRouteToL3Network

Adds a host route to an L3 network. For example,
AddHostRouteToL3Network l3NetworkUuid=7dfdf976ef1334fba5c3b475104011b2 nexthop=192.168.1.254 prefix=169.254.169.254/32

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 0.6
nexthop 2.3
prefix 2.3
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

RemoveHostRouteFromL3Network

Removes a host route from an L3 network. For example,
RemoveHostRouteFromL3Network l3NetworkUuid=7dfdf976ef1334fba5c3b475104011b2 prefix=169.254.169.254/32

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 0.6
prefix 2.3
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

GetFreeIp

Obtains a free IP address. For example,
GetFreeIp l3NetworkUuid=aa6ec2f40b93413aa843ee5d76ddf73e

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. Make sure that at least one of l3NetworkUuid and ipRangeUuid is not null. Yes 0.6
ipRangeUuid The IP range UUID. Make sure that at least one of l3NetworkUuid and ipRangeUuid is not null. Yes 0.6
start The start value. Yes 0.6
ipRangeType The IP range type. Yes
  • Normal
  • AddressPool
3.9.0
ipVersion The IP version. Yes
  • 4
  • 6
3.10.0
limit The count limit. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

CheckIpAvailability

Checks the IP availability. For example,
CheckIpAvailability ip=10.128.11.3 l3NetworkUuid=aa6ec2f40b93413aa843ee5d76ddf73e

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. Yes 0.6
ip The IP address. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes
arpCheck Use arping to check. Yes 5.1.0
ipRangeCheck Check available IP address range in database. Yes 5.1.0

GetIpAddressCapacity

Obtains the IP address capacity. For example,
GetIpAddressCapacity ipRangeUuids=e6d4de6fe69a42b28363ffbc7b4a186f

Parameters

Name Description Optional Valid Value Starting Version
zoneUuids The zone UUID. Yes 0.6
l3NetworkUuids The L3 network UUID. Yes 0.6
ipRangeUuids The IP range UUID. Make sure that at least one of rangefinders, L3NetworkUuids, and zoneUuids is not null. Yes 0.6
all Global settings. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

AddIpRange

Adds an IP range. For example,
AddIpRange name=L3Network-1 l3NetworkUuid=ba076991c0f740be84ab7e9646dcfd56
startIp=10.128.33.10 endIp=10.128.33.20 netmask=255.0.0.0 gateway=10.0.0.1

Parameters

Name Description Optional Valid Value Starting Version
name The L3 network name. 0.6
description The detailed description of the L3 network. Yes 0.6
l3NetworkUuid The L3 network UUID. 0.6
startIp The start IP address. 0.6
endIp The end IP address. 0.6
gateway The gateway. 0.6
ipRangeType The IP range type. Yes
  • Normal
  • AddressPool
3.9.0
netmask The netmask. 0.6
resourceUuid The resource UUID. If specified, the L3 network will use the specified value as UUID. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes
Note:
  • When you add an IP range in ZStack Cloud, you can specify the DHCP server address by adding the DhcpServer option to SystemTags.
    • Format of the DhcpServer option: flatNetwork::DhcpServer::{%s}::ipUuid::{%s}
    • Example: flatNetwork::DhcpServer::192.168.1.100::ipUuid::null

DeleteIpRange

Deletes an IP range. For example,
DeleteIpRange uuid=32556158a15b421db215d1d4b0e846a6

Parameters

Name Description Optional Valid Value Starting Version
uuid The UUID of the IP range. 0.6
deleteMode The delete mode. For more information, see Delete Resources. Yes
  • Permissive
  • Enforcing
0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes

QueryIpRange

Queries an IP range. For example,
QueryIpRange uuid=bcdb86a63cef415c843ab02e9534a21b
QueryIpRange l3Network.l2NetworkUuid=96a3915e8c1a4fb6a7e14078e61b69b0

Primitive Fields of Query

See IP Range Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
l3Network L3 Network Inventory The L3 network to which the IP range belongs. 0.6

UpdateIpRange

Updates an IP range. For example,
UpdateIpRange uuid=b121aa49504749c39e541c434dff7303

Parameters

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

AddIpRangeByNetworkCidr

Adds an IP range by specifying a network CIDR. For example,
AddIpRangeByNetworkCidr name=L3Network-1 l3NetworkUuid=ba076991c0f740be84ab7e9646dcfd56 \
networkCidr=10.128.33.1/24

Parameters

Name Description Optional Valid Value Starting Version
name The L3 network name. 0.6
description The detailed description of the L3 network. Yes 0.6
l3NetworkUuid The L3 network UUID. 0.6
networkCidr The network CIDR. 0.6
gateway The gateway. Yes 3.7.0
ipRangeType The IP range type. Yes
  • Normal
  • AddressPool
3.9.0
resourceUuid The resource UUID. If specified, the L3 network will use the specified value as UUID. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 0.6
timeout Yes
Note:
  • When you add an IP range by specifying a network CIDR in ZStack Cloud, you can specify the DHCP server address by adding the affinityGroup option to SystemTags.
    • Format of the affinityGroup option: flatNetwork::DhcpServer::{%s}::ipUuid::{%s}
    • Example: flatNetwork::DhcpServer::192.168.1.100::ipUuid::null

GetL3NetworkMtu

Obtains the maximum transmission unit (MTU) value of an L3 network. For example,
GetL3NetworkMtu l3NetworkUuid=87ce2c1d551f4fadb2f364d18af465a1

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 2.1
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 2.1
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 2.1
timeout Yes

SetL3NetworkMtu

Sets the MTU value for an L3 network. For example,
SetL3NetworkMtu l3NetworkUuid=87ce2c1d551f4fadb2f364d18af465a1 mtu=1500

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 2.1
mtu 2.1
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 2.1
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 2.1
timeout Yes

GetL3NetworkRouterInterfaceIp

Obtains a router interface IP address in an L3 network. For example,
GetL3NetworkRouterInterfaceIp l3NetworkUuid=87ce2c1d551f4fadb2f364d18af465a1

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 2.1
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 2.1
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 2.1
timeout Yes

SetL3NetworkRouterInterfaceIp

Sets a router interface IP address in an L3 network. For example,
SetL3NetworkRouterInterfaceIp l3NetworkUuid=87ce2c1d551f4fadb2f364d18af465a1 routerInterfaceIp=192.168.180.1

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 2.1
routerInterfaceIp 2.1
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 2.1
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 2.1
timeout Yes

AddIpv6Range

Adds an IPv6 range. For example,
AddIpv6Range l3NetworkUuid=8bea912e333a440fb61d81c0c7670b52 name=L3-ipv6 startIp=234e:0:4567::2 endIp=234e:0:4567:0:ffff:ffff:ffff:ffff gateway=234e:0:4567::1 prefixLen=64 addressMode=Stateful-DHCP

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 3.1.0
name The L3 network name. 3.1.0
description The detailed description of the L3 network. Yes 3.1.0
startIp The start IP address. 3.1.0
endIp The end IP address. 3.1.0
gateway The gateway. 3.1.0
prefixLen The prefix length. 3.1.0
addressMode The allocation mode of the IPv6 address.
  • SLAAC
  • Stateful-DHCP
  • Stateless-DHCP
3.1.0
resourceUuid The resource UUID. If specified, the L3 network will use the specified value as UUID. Yes 3.1.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.1.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.1.0
timeout Yes
Note:
  • When you add an IPv6 range in ZStack Cloud, you can specify the DHCP server address by adding the affinityGroup option to SystemTags.
    • Format of the affinityGroup option: flatNetwork::DhcpServer::{%s}::ipUuid::{%s}
    • Example: flatNetwork::DhcpServer::192.168.1.100::ipUuid::null

AddIpv6RangeByNetworkCidr

Adds an IPv6 range by specifying a network CIDR. For example,
AddIpv6RangeByNetworkCidr l3NetworkUuid=8bea912e333a440fb61d81c0c7670b52 name=L3-ipv6 networkCidr=234e:0:4567::/64 addressMode=Stateful-DHCP

Parameters

Name Description Optional Valid Value Starting Version
name The L3 network name. 3.1.0
description The detailed description of the L3 network. Yes 3.1.0
l3NetworkUuid The L3 network UUID. 3.1.0
networkCidr The network CIDR. 3.1.0
addressMode The allocation mode of the IPv6 address.
  • SLAAC
  • Stateful-DHCP
  • Stateless-DHCP
3.1.0
resourceUuid The resource UUID. If specified, the L3 network will use the specified value as UUID. Yes 3.1.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.1.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.1.0
timeout Yes
Note:
  • When you add an IPv6 range by specifying a network CIDR in ZStack Cloud, you can specify the DHCP server address by adding the affinityGroup option to SystemTags.
    • Format of the affinityGroup option: flatNetwork::DhcpServer::{%s}::ipUuid::{%s}
    • Example: flatNetwork::DhcpServer::192.168.1.100::ipUuid::null

QueryIpAddress

Queries an IP address. For example,
QueryIpAddress uuid=c0af96be01703fab84495059d3188230

Primitive Fields of Query

See IP Address Inventory.

Nested And Expanded Fields of Query

Field Inventory Description Starting Version
l3Network L3 Network Inventory The L3 network to which the IP range belongs. 3.1.0
vmNic VM NIC Inventory 0.6

GetL3NetworkIpStatistic

Obtains the IP address statistics of an L3 network. For example,
GetL3NetworkIpStatistic l3NetworkUuid=9bdd769f3e603f65bd368512ebe8b998

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 3.7.0
resourceType The resource type. Yes
  • All
  • Vip
  • VM
3.7.0
ip The specified IP address. Yes 3.7.0
sortBy The sort method. Yes
  • Ip
  • CreateDate
3.7.0
sortDirection The sort direction. Yes
  • asc
  • desc
3.7.0
start The location where the statistics starts. Yes 3.7.0
limit The count of the statistics. Yes 3.7.0
replyWithCount Whether to return both the statistics result and count. 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

QueryAddressPool

Queries an IP address pool. For example,
QueryAddressPool uuid=b86c9016b4f24953a9edefb53ca0678c

Primitive Fields of Query

See Address Pool Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
l3Network L3 Network Inventory The public networks related to the IP address pool. 3.9.0

AddReservedIpRange

Add a reserved IP range. For example,
AddReservedIpRange l3NetworkUuid=b7b719a4a3c140ed80fd680b71f66bb8 startIp=172.20.60.115 endIp=172.20.60.120

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3 network UUID. 5.1.0
startIp The start IP address. 5.1.0
endIp The end IP address. 5.1.0
resourceUuid The resource UUID. If specified, the L3 network will use the specified value as UUID. Yes 5.1.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.1.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.1.0

DeleteReservedIpRange

Delete a reserved IP range. For example,
DeleteReservedIpRange uuid=cb2e0481b17f471b9fdcfab697abc7ce

Parameters

Name Description Optional Valid Value Starting Version
uuid The UUID of the reserved IP range. 5.1.0
deleteMode The delete mode. For more information, see Delete Resources. Yes
  • Permissive/Enforcing
  • Permissive
5.1.0
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 5.1.0
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 5.1.0
timeout Yes

ChangeL3NetworkDhcpIpAddress

Change the IP address of a DHCP server. For example,
ChangeL3NetworkDhcpIpAddress l3NetworkUuid=b7b719a4a3c140ed80fd680b71f66bb8 dhcpServerIp=172.20.60.115

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3Network UUID. 5.1.0
dhcpServerIp The IPv4 address of the DHCP server. Yes 5.1.0
dhcpv6ServerIp The IPv6 address of the DHCP server. Yes 5.1.0
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 5.1.0
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 5.1.0
timeout Yes

DeleteIpAddress

Delete an IP address. For example,
DeleteIpAddress l3NetworkUuid=b6e5c225bf553bc8bd5a5fcf3fac9fa3 deleteMode=Permissive

Parameters

Name Description Optional Valid Value Starting Version
l3NetworkUuid The L3Network UUID. 5.1.0
usedIpUuids The deleted IP address. Yes 5.1.0
deleteMode The delete mode. For more information, see Delete Resources. Yes
  • Permissive/Enforcing
  • Permissive
5.1.0
userTags The user tags. For more information, see CreateUserTag. The resource type is L3NetworkVO. Yes 5.1.0
systemTags The system tags. For more information, see CreateSystemTag. The resource type is L3NetworkVO. Yes 5.1.0
timeout Yes

Tags

L3 Network Tag

You can create a user tag on an L3 network by using resourceType=L3NetworkVO. For example,
CreateUserTag resourceType=L3NetworkVO tag=web-tier-l3 \
resourceUuid=f6be73fa384a419986fc6d1b92f95be9

IP Range Tag

You can create a user tag on an IP range by using resourceType=IpRangeVO. For example,
CreateUserTag resourceType=IpRangeVO tag=web-tier-IP \
resourceUuid=8191d946954940428b7d003166fa641e

IP Address Tag

You can create a user tag on an IP address by using resourceType=IpAddressVO. For example,
CreateUserTag resourceType=IpAddressVO tag=web-tier-IPAddress \
resourceUuid=c0af96be01703fab84495059d3188230
CLI Command Manual | 5.5.30 | ZStack Cloud · ZCF | ZStack Resource Center