Document navigation

VPC

Overview

VPC network: A VPC network is a private network where VM instances can be created. A VM instance in a VPC network can access the Internet through a VPC vRouter. A custom private cloud network environment composed of VPC vRouter and VPC networks helps enterprise users to build a logically isolated private cloud.

VPC vRouter and VPC Network

VPC consists of VPC vRouter and VPC network.
  1. VPC vRouter: a vRouter that is created based on a vRouter offering. A VPC vRouter has two types of network: public network and management network.
    • VPC vRouters are the core of VPC. A VPC vRouter can be created by specifying a vRouter offering.
    • To create a vRouter offering, create the required public network, management network, and vRouter image in advance.
    • A VPC vRouter can be attached to or detached from VPC networks or other public networks.
    • The public network and the management network that are defined by a vRouter offering cannot be detached.
    • The same vRouter offering can be used to create multiple VPC vRouters. These VPC vRouters share both the public IP range and the management IP range defined by the same vRouter offering.
    • The public network is the default network used to provide network services.
    • VPC vRouters have higher resource priorities than VM instances. When the host workload rates are extremely high, and then resources contend with each other, the resource priority sequence from low to high is as follows: VM instances with Normal priorities < VM instances with High priorities < VPC vRouters. For example, when CPU resources contend with each other on hosts, VPC vRouters have higher CPU resource grabbing capability.
  2. VPC network: a private network that can be attached to a VPC vRouter.
    • You need to create an L2 network before you can create an L3 VPC network.
    • When you create a VPC network, you can specify a vRouter. Or you can attach a vRouter to the VPC network after you create the VPC network.
    • If your VM instances use a VPC network, you cannot detach the VPC network from the VPC vRouter.
    • The newly created IP range must not overlap any IP range in the VPC vRouter.
Figure 1. VPC Network Topology


HA Group of VPC vRouter

High availability (HA) group: You can deploy two VPC vRouters according to the active-backup policy. When the active VPC vRouter is abnormal, the backup VPC vRouter will automatically take over to work properly, thus ensuring your business continuity.
Note: The VPC vRouters in an HA group will be only displayed on the details page of the HA group, but will not be displayed independently in the vRouter table.

VPC Features

VPC has the following feature benefits:
  • Flexible network configuration: Different VPC networks can be flexibly attached to the VPC vRouters. You can customize an independent IP range and an independent gateway for each VPC network. VPC vRouters allow you to attach or detach gateways, and also to dynamically configure your route tables and route entries.
  • Secure and reliable isolation: Different VPC networks in different VPCs are logically isolated. That is, the VPC networks support VLAN and VXLAN for logical layer 2 isolation, and different VPCs of different accounts will not affect each other.
  • Multi-subnet interconnection: Multiple VPC networks under the same VPC can communicate privately and securely with one another.
  • Network traffic optimization: VPC supports distributed route features, indicating that VPC can optimize the east-west network traffic, and reduce the network latency effectively.
  • VPC vRouter HA: In a VPC vRouter HA group, you can deploy two VPC vRouters according to the active-standby policy. When the active VPC vRouter is abnormal, the standby VPC vRouter will automatically take over to work properly, thus ensuring your business continuity.

VPC Network Service

The VPC network, which acts as a private network, provides a group of network services by using VPC vRouters.
  • DHCP: By default, the VPC network provides distributed DHCP services by using the flat network service module.
  • DNS: A VPC vRouter can act as a DNS server to provide DNS services. The DNS address in a VPC vRouter VM instance is the IP address of the VPC vRouter. Note that the DNS address that you set is forwarded by the VPC vRouter.
  • SNAT: A VPC vRouter can provide the source network address translation (SNAT) services for VM instances. Then, the VM instances can directly access the Internet by using SNAT.
  • Route table: Through the route table, you can manage and customize routes.
  • Security group: The security group service is provided by the security group network service module. You can configure and manage firewalls for VM instances by using iptables.
  • Elastic IP address (EIP): You can bind an EIP to a VPC network. Then, the public network can interconnect with the private network of the VM instance.
  • Port forwarding: The port forwarding service allows a public IP address to interconnect with the private IP address of a VM instance. To be more specific, you can create port forwarding rules to allow external networks to reach specific ports of your VM instances.
  • Load balancing: The load balancing service distributes your inbound traffics from a public IP address to a group of backend VM instances. Then, this service will automatically check and isolate the VM instances that are unavailable.
  • IPsec tunnel: The IPsec tunnel can be used to achieve interconnection between different virtual private networks (VPNs).
  • Dynamic routing: The VPC vRouter supports the Open Shortest Path First (OSPF) routing protocol, which is used to distribute routing information within a single autonomous system.
  • Multicast routing: The VPC vRouter forwards the multicast information sent by the multicast source to VM instances, achieving one-to-multi-point communication in the transmission side and receiving side.
  • VPC firewall: The VPC firewall filters the south-north traffic on the VPC vRouter ports, effectively protecting the VPC communication security and VPC vRouter security.
  • Netflow: The Netflow service monitors and analyzes the inbound and outbound traffics of the VPC vRouter NICs. Currently, the following two types of data-flow output format are supported: Netflow V5 and Netflow V9.
  • Port Mirroring: The port mirroring mirrors the data traffic of VM NICs and sends the data traffic to the target ports. This allows for the analysis of data packets of ports and simplifies the monitoring and management of data traffic and makes it easier to locate network errors and exceptions.

Inventory

Properties

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 2.3
name The name. For more information, see Resource Property. 2.3
description The description. For more information, see Resource Property. Yes 2.3
agentPort 2.3
allocatorStrategy The allocator strategy.
  • DefaultHostAllocatorStrategy
  • LastHostPreferredAllocatorStrategy
  • LeastVmPreferredHostAllocatorStrategy
  • MinimumCPUUsageHostAllocatorStrategy
  • MinimumMemoryUsageHostAllocatorStrategy
  • MaxInstancePerHostHostAllocatorStrategy
  • DesignatedHostAllocatorStrategy
2.3
applianceVmType The type of special VM instance. 2.3
clusterUuid The cluster UUID. 2.3
zoneUuid The zone UUID. 2.3
cpuNum The CPU count. 2.3
cpuSpeed 2.3
defaultL3NetworkUuid The default L3 network UUID. 2.3
defaultRouteL3NetworkUuid The UUID of the L3 network that provides default routing in a vRouter VM instance. 2.3
hostUuid The host UUID. 2.3
lastHostUuid The UUID of the host where the vRouter VM instance was located last time. 2.3
imageUuid The image UUID. 2.3
rootVolumeUuid The root volume UUID. 2.3
instanceOfferingUuid The instance offering UUID. 2.3
managementNetworkUuid The management network UUID. 2.3
publicNetworkUuid The public network UUID. 2.3
memorySize The memory size. 2.3
hypervisorType The hypervisor type. 2.3
platform 2.3
state The state.
  • Running
  • Stopped
2.3
status The status. 2.3
groupBy
createDate The creation date. For more information, see Resource Property. 2.3
lastOpDate The last operation date. For more information, see Resource Property. 2.3
type The type. 2.3

Sample

{
    "inventories": [
        {
            "agentPort": 7272,
            "allVolumes": [
                {
                    "actualSize": 308124672,
                    "createDate": "Jan 29, 2018 2:50:36 PM",
                    "description": "Root volume for VM[uuid:21fb8cf769804830b397b5ae1491f527]",
                    "deviceId": 0,
                    "format": "qcow2",
                    "installPath": "/Cloud_ps_1/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-f01fd90b7d6248f9b106d6beb6910459/f01fd90b7d6248f9b106d6beb6910459.qcow2",
                    "isShareable": false,
                    "lastOpDate": "Jan 29, 2018 2:50:37 PM",
                    "name": "ROOT-for-TestVPC",
                    "primaryStorageUuid": "c81fe76a96c74568bbc3f7d46ac67e22",
                    "rootImageUuid": "f54bc778326842d8be3b6bd6a10ddf57",
                    "size": 8589934592,
                    "state": "Enabled",
                    "status": "Ready",
                    "type": "Root",
                    "uuid": "f01fd90b7d6248f9b106d6beb6910459",
                    "vmInstanceUuid": "21fb8cf769804830b397b5ae1491f527"
                }
            ],
            "allocatorStrategy": "LeastVmPreferredHostAllocatorStrategy",
            "applianceVmType": "vpcvrouter",
            "clusterUuid": "03e75816a0da42f998e2102d8286c27e",
            "cpuNum": 1,
            "cpuSpeed": 0,
            "createDate": "Jan 29, 2018 2:50:36 PM",
            "defaultL3NetworkUuid": "3533e0dcd01d4e2aa8697048e152c5d8",
            "defaultRouteL3NetworkUuid": "ac057539be3840b7ba62c26d88028d74",
            "description": "vpc vrouter",
            "hostUuid": "faa187eff2a24db087f7c999c6990dd5",
            "hypervisorType": "KVM",
            "imageUuid": "f54bc778326842d8be3b6bd6a10ddf57",
            "instanceOfferingUuid": "bea67a0669434d23ba4da7bf73f07255",
            "lastHostUuid": "faa187eff2a24db087f7c999c6990dd5",
            "lastOpDate": "Jan 30, 2018 10:12:42 AM",
            "managementNetworkUuid": "ac057539be3840b7ba62c26d88028d74",
            "memorySize": 1073741824,
            "name": "TestVPC",
            "platform": "Linux",
            "publicNetworkUuid": "ac057539be3840b7ba62c26d88028d74",
            "rootVolumeUuid": "f01fd90b7d6248f9b106d6beb6910459",
            "state": "Running",
            "status": "Connected",
            "type": "ApplianceVm",
            "uuid": "21fb8cf769804830b397b5ae1491f527",
            "virtualRouterVips": [
                "ff59daff8b6b4873b3f6dd9f100c753a"
            ],
            "vmNics": [
                {
                    "createDate": "Jan 29, 2018 2:50:37 PM",
                    "deviceId": 0,
                    "gateway": "10.0.0.1",
                    "ip": "10.128.22.161",
                    "l3NetworkUuid": "ac057539be3840b7ba62c26d88028d74",
                    "lastOpDate": "Jan 29, 2018 2:50:37 PM",
                    "mac": "fa:34:d5:44:3c:00",
                    "metaData": "3",
                    "netmask": "255.0.0.0",
                    "uuid": "2886bdb03c324feea04ac556cee9fe14",
                    "vmInstanceUuid": "21fb8cf769804830b397b5ae1491f527"
                },
                {
                    "createDate": "Jan 29, 2018 4:05:30 PM",
                    "deviceId": 1,
                    "gateway": "192.168.29.1",
                    "ip": "192.168.29.1",
                    "l3NetworkUuid": "3533e0dcd01d4e2aa8697048e152c5d8",
                    "lastOpDate": "Jan 29, 2018 4:05:30 PM",
                    "mac": "fa:34:0c:67:11:01",
                    "metaData": "4",
                    "netmask": "255.255.255.0",
                    "uuid": "748a1699b40044829d3cef7ec1c1b448",
                    "vmInstanceUuid": "21fb8cf769804830b397b5ae1491f527"
                }
            ],
            "zoneUuid": "96e7b45997f0419789d9f187500a3540"
        }
    ],
    "success": true
}

VPC HA Group Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.5.1
description The description. For more information, see Resource Property. 3.5.1
name The name. For more information, see Resource Property. 3.5.1
createDate The creation date. For more information, see Resource Property. 3.5.1
lastOpDate The last operation date. For more information, see Resource Property. 3.5.1
groupBy 3.5.1
systemTags 3.5.1
userTags 3.5.1

Sample

{
    "inventories": [
        {
            "createDate": "Jul 15, 2019 4:30:58 PM",
            "description": "",
            "lastOpDate": "Jul 15, 2019 4:30:58 PM",
            "monitors": [
                {
                    "createDate": "Jul 15, 2019 4:30:58 PM",
                    "id": 2,
                    "lastOpDate": "Jul 15, 2019 4:30:58 PM",
                    "monitorIp": "172.24.0.1",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                }
            ],
            "name": "vhg",
            "services": [
                {
                    "createDate": "Jul 15, 2019 4:30:58 PM",
                    "id": 22,
                    "lastOpDate": "Jul 15, 2019 4:30:58 PM",
                    "networkServiceName": "PortForwardingRuleVO",
                    "networkServiceUuid": "4ef05744e52a499daeb4f54b86d4c652",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                },
                {
                    "createDate": "Jul 15, 2019 4:40:23 PM",
                    "id": 24,
                    "lastOpDate": "Jul 15, 2019 4:40:23 PM",
                    "networkServiceName": "VipVO",
                    "networkServiceUuid": "432d38b6e32241aabe63e904c4c559dd",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                },
                {
                    "createDate": "Jul 15, 2019 4:40:25 PM",
                    "id": 25,
                    "lastOpDate": "Jul 15, 2019 4:40:25 PM",
                    "networkServiceName": "EipVO",
                    "networkServiceUuid": "9b8d2747168f47d188be973702af4e9d",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                },
                {
                    "createDate": "Jul 15, 2019 4:30:58 PM",
                    "id": 21,
                    "lastOpDate": "Jul 15, 2019 4:30:58 PM",
                    "networkServiceName": "VipVO",
                    "networkServiceUuid": "eea29b936a754cc7ae579bb9bd9ebc25",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                },
                {
                    "createDate": "Jul 15, 2019 4:58:05 PM",
                    "id": 26,
                    "lastOpDate": "Jul 15, 2019 4:58:05 PM",
                    "networkServiceName": "VipVO",
                    "networkServiceUuid": "e7d36f743b8545e39ee9494051f3c159",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                },
                {
                    "createDate": "Jul 15, 2019 4:30:58 PM",
                    "id": 23,
                    "lastOpDate": "Jul 15, 2019 4:30:58 PM",
                    "networkServiceName": "VpcRouterDnsVO",
                    "networkServiceUuid": "223.5.5.5",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                },
                {
                    "createDate": "Jul 15, 2019 4:30:58 PM",
                    "id": 19,
                    "lastOpDate": "Jul 15, 2019 4:30:58 PM",
                    "networkServiceName": "L3NetworkVO",
                    "networkServiceUuid": "15ed3ffa436d4c729ff8ae1d4a9003f0",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                },
                {
                    "createDate": "Jul 15, 2019 4:30:58 PM",
                    "id": 20,
                    "lastOpDate": "Jul 15, 2019 4:30:58 PM",
                    "networkServiceName": "VipVO",
                    "networkServiceUuid": "e3c68f02ef6f43848e9c15ffb03f8ec3",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                },
                {
                    "createDate": "Jul 15, 2019 4:58:10 PM",
                    "id": 27,
                    "lastOpDate": "Jul 15, 2019 4:58:10 PM",
                    "networkServiceName": "LoadBalancerVO",
                    "networkServiceUuid": "82ad4a36c71c4f14ab35369142dcc18a",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                }
            ],
            "usedIps": [
                {
                    "createDate": "Jul 15, 2019 4:30:58 PM",
                    "id": 2,
                    "ip": "172.24.3.249",
                    "l3NetworkUuid": "5e928354551743dc83c922386ff0a667",
                    "lastOpDate": "Jul 15, 2019 4:30:58 PM",
                    "netmask": "255.255.0.0",
                    "vipUuid": "eea29b936a754cc7ae579bb9bd9ebc25",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                }
            ],
            "uuid": "6ca37f92c7474c1b82a6d354819da912",
            "vrRefs": [
                {
                    "uuid": "49ea6a808c4e43748ebe89f4b97542b4",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                },
                {
                    "uuid": "e272a6a9c3144fc4aa776f2303584d18",
                    "vpcHaRouterUuid": "6ca37f92c7474c1b82a6d354819da912"
                }
            ]
        }
    ],
    "success": true
}

Operations

CreateVpcVRouter

Creates a VPC vRouter. For example,
CreateVpcVRouter name=TestVPC virtualRouterOfferingUuid=bea67a0669434d23ba4da7bf73f07255

Parameters

Name Description Optional Valid Value Starting Version
name The VPC vRouter name. 2.3
virtualRouterOfferingUuid The vRouter offering. 2.3
description The detailed description of the VPC vRouter. Yes 2.3
resourceUuid The resource UUID. If specified, the VPC will use the specified value as UUID. Yes 2.3
zoneUuid The zone UUID. Yes 3.10.0
clusterUuid The cluster UUID. Yes 3.10.0
hostUuid The host UUID. If specified, the VM instance will be created on the specified host. Yes 3.10.0
primaryStorageUuidForRootVolume The primary storage UUID. Yes 4.4.24
rootVolumeSystemTags The system tags required by the VPC vRouter root volume. Yes 4.4.24
tagUuids The tag UUIDs. Yes 3.10.0
userTags The user tag. For more information, see CreateUserTag. The resource type is VirtualRouterVmVO. Yes 2.3
systemTags The system tag. For more information, see CreateSystemTag. The resource type is VirtualRouterVmVO. Yes 2.3
timeout Yes
Note:
  • When you create a VPC vRouter in ZStack Cloud, the cloud records whether the VPC vRouter is added to an HA group. Note that you can add the haUuid option to SystemTags.
    • Format of the haUuid option: haUuid::HA_GROUP_UUID
    • Example: haUuid::e2af8f869eff49d2a3d6f86cadc27090
  • When you create a VPC vRouter in ZStack Cloud, you can specify a public IP by adding the staticVip option to SystemTags.
    • Format of the staticVip option: staticVip::L3UUID::IP. Here, L3UUID is the L3 public network UUID in the vRouter offering, and IP is the public IP address that you specified.
    • Example: staticVip::4ed5cce4f55a43aca8e61ebbc0c3985d::172.20.1.1
  • When you create a VPC vRouter in ZStack Cloud, you can bind the VPC vRouter to the cluster by adding the resourceBinding option to SystemTags. This disables the VPC vRouter auto cross-cluster migrations.
    • Format of the resourceBinding option: resourceBindings::Cluster:clusterUuid,其中clusterUuid为对应的集群uuid
    • Example: resourceBindings::Cluster:2sdasf231jvznsdak

QueryVpcRouter

Queries a VPC vRouter.

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. Yes 2.3
name The resource name. Yes 2.3
description The detailed description of the resource. Yes 2.3
dns Yes 2.3
clusterUuid The cluster UUID. Yes 2.3
defaultL3NetworkUuid Yes 2.3
defaultRouteL3NetworkUuid Yes 2.3
hostUuid The host UUID. Yes 2.3
imageUuid The image UUID. Yes 2.3
lastHostUuid Yes 2.3
zoneUuid The zone UUID. Yes 2.3
rootVolumeUuid Yes 2.3
publicNetworkUuid Yes 2.3
managementNetworkUuid Yes 2.3
instanceOfferingUuid Yes 2.3
agentPort Yes 2.3
allVolumes Yes 2.3
platform Yes 2.3
memorySize Yes 2.3
allocatorStrategy Yes
  • DefaultHostAllocatorStrategy
  • LastHostPreferredAllocatorStrategy
  • LeastVmPreferredHostAllocatorStrategy
  • MinimumCPUUsageHostAllocatorStrategy
  • MinimumMemoryUsageHostAllocatorStrategy
  • MaxInstancePerHostHostAllocatorStrategy
  • DesignatedHostAllocatorStrategy
2.3
applianceVmType Yes 2.3
cpuSpeed Yes 2.3
cpuNum Yes 2.3
hypervisorType Yes 2.3
virtualRouterVips Yes 2.3
vmNics Yes 2.3
createDate The creation date. Yes 2.3
lastOpDate The last operation date. Yes 2.3
type Yes 2.3
state Yes 2.3
status Yes 2.3
userTags The user tags. For more information, see CreateUserTag. Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. Yes 2.3
timeout Yes

GetAttachableVpcL3Network

Obtains the L3 networks that can be attached by a VPC vRouter. For example,
GetAttachableVpcL3Network uuid=21fb8cf769804830b397b5ae1491f527

Parameters

Name Description Optional Valid Value Starting Version
uuid The VPC vRouter UUID. 2.3
userTags The user tags. For more information, see CreateUserTag. The resource type is VirtualRouterVmVO. Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VirtualRouterVmVO. Yes 2.3
timeout Yes

GetVpcVRouterDistributedRoutingConnections

Obtains the real-time traffic state of a VPC vRouter. For example,
GetVpcVRouterDistributedRoutingConnections uuid=ae813073d37347098fd6d52b83bfbcd2

Parameters

Name Description Optional Valid Value Starting Version
uuid The VPC vRouter UUID. To obtain the real-time traffic state of a VPC vRouter, enable the distributed router. 2.3
userTags The user tags. For more information, see CreateUserTag. The resource type is VirtualRouterVmVO. Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VirtualRouterVmVO. Yes 2.3
timeout Yes

GetVpcVRouterDistributedRoutingEnabled

Checks whether a distributed router is enabled. For example,
GetVpcVRouterDistributedRoutingEnabled uuid=ae813073d37347098fd6d52b83bfbcd2

Parameters

Name Description Optional Valid Value Starting Version
uuid The VPC vRouter UUID. 2.3
userTags The user tags. For more information, see CreateUserTag. The resource type is VirtualRouterVmVO. Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VirtualRouterVmVO. Yes 2.3
timeout Yes

SetVpcVRouterDistributedRoutingEnabled

Enables a distributed routing switch. For example,
SetVpcVRouterDistributedRoutingEnabled uuid=ae813073d37347098fd6d52b83bfbcd2 \
stateEvent=enable

Parameters

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

AddDnsToVpcRouter

Adds a DNS to a VPC vRouter. For example,
AddDnsToVpcRouter dns=1.1.1.1 uuid=ae813073d37347098fd6d52b83bfbcd2

Parameters

Name Description Optional Valid Value Starting Version
uuid The VPC vRouter UUID. 2.3
dns 2.3
resourceUuid Yes 2.3
userTags The user tags. For more information, see CreateUserTag. The resource type is VirtualRouterVmVO. Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VirtualRouterVmVO. Yes 2.3
timeout Yes

RemoveDnsFromVpcRouter

Removes a DNS from a VPC vRouter. For example,
RemoveDnsFromVpcRouter dns=1.1.1.1 uuid=ae813073d37347098fd6d52b83bfbcd2

Parameters

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

GetVpcVRouterNetworkServiceState

Obtains the network service state of a VPC vRouter. For example,
GetVpcVRouterNetworkServiceState uuid=bea67a0669434d23ba4da7bf73f07255 networkService=SNAT

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.4.0
networkService The network service provided by the vRouter. Yes
  • SNAT
3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes
Note:
  • When you obtain the network service state of a VPC vRouter in ZStack Cloud, you can disable the SNAT service of the VPC vRouter by adding the disabledService option to SystemTags.
    • Format of the disabledService option: disabledService::SNAT
    • Example: disabledService::SNAT
    • If the SystemTag of the VPC vRouter does not contain the resourceType::VirtualRouterVmVO flag, the SNAT service of the VPC vRouter is enabled. Otherwise, if the SystemTag contains the resourceType::VirtualRouterVmVO flag, the SNAT service is disabled.

SetVpcVRouterNetworkServiceState

Sets the network service of a VPC vRouter. For example,
SetVpcVRouterNetworkServiceState uuid=bea67a0669434d23ba4da7bf73f07255 networkService=SNAT state=enable

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.4.0
networkService The network service provided by the vRouter. Yes
  • SNAT
3.4.0
state The service state. Yes
  • Enable
  • Disable
3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes
Note:
  • When you obtain the network service state of a VPC vRouter in ZStack Cloud, you can disable the SNAT service of the VPC vRouter by adding the disabledService option to SystemTags.
    • Format of the disabledService option: disabledService::SNAT
    • Example: disabledService::SNAT
    • If the SystemTag of the VPC vRouter does not contain the resourceType::VirtualRouterVmVO flag, the SNAT service of the VPC vRouter is enabled. Otherwise, if the SystemTag contains the resourceType::VirtualRouterVmVO flag, the SNAT service is disabled.

ChangeVpcHaGroupMonitorIps

Changes a monitor IP address in an HA group. For example,
ChangeVpcHaGroupMonitorIps uuid=85ba2342e37930f6a0cdd056565654cd

Parameters

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

CreateVpcHaGroup

Creates an HA group. For example,
CreateVpcHaGroup uuid=d32cd856d4603754aa30d8fe60ea07a4

Parameters

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

DeleteVpcHaGroup

Deletes an HA group. For example,
DeleteVpcHaGroup uuid=b86c9016b4f24953a9edefb53ca0678c

Parameters

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

UpdateVpcHaGroup

Updates an HA group. For example,
UpdateVpcHaGroup uuid=5ddaa8fa444c3b0a8e9187d87eb026f6

Parameters

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

QueryVpcHaGroup

Queries an HA group. For example,
QueryVpcHaGroup

Primitive Fields of Query

See VPC HA Group Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
monitors Monitors The monitor IP address list. 3.5.1
services Services The UUID of the network service that is associated with the HA group. 3.5.1
usedIps Used IP Addresses The public IP address of the HA group. 3.5.1
vrRefs vRouter References The UUID of the VPC vRouter that joins the HA group. 3.5.1

UpdateVirtualRouter

Updates a virtual router. For example,
UpdateVirtualRouter vmInstanceUuid=142981c8c8243113b52db453575fb03f

Parameters

Name Description Optional Valid Value Starting Version
vmInstanceUuid The resource UUID. 3.9.0
defaultRouteL3NetworkUuid Yes 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
timeout Yes

UpdateVirtualRouterSoftwareVersion

Updates the VPC vRouter software. For example,
UpdateVirtualRouterSoftwareVersion uuid=7ece55616a8246838845f976724983c6 softwareName=IPsec targetVersion=5.9.4

Parameters

Name Description Optional Valid Value Starting Version
uuid The resourse UUID. 4.5.0
softwareName The VPC vRouter software name. IPsec 4.5.0
targetVersion The target version.
  • 4.5.2
  • 5.9.4
4.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
timeout Yes

GetVirtualRouterSoftwareVersion

Gets the version of the VPC vRouter software. For example,
GetVirtualRouterSoftwareVersion softwareName=IPsec

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. Yes 4.5.0
softwareName The VPC vRouter software name. IPsec 4.5.0
needUpdate Whether need to be updated. Yes 4.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 4.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 4.5.0
timeout Yes

GetRouteTableVpcVRouterCandidate

Retrieves available VPC vRouters for a router table.
GetRouteTableVpcVRouterCandidate uuid=142981c8c8243113b52db453575fb03f

Parameters

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

Tags

VPC Network Tags

You can create a user tag on a VPC network by using resourceType=L3NetworkVO. For example,
CreateUserTag resourceType=L3NetworkVO tag=web-vpc-l3 \
resourceUuid=3533e0dcd01d4e2aa8697048e152c5d8

VPC vRouter Tags

You can create a user tag on a VPC vRouter by using resourceType=VirtualRouterVmVO. For example,
CreateUserTag resourceType=VirtualRouterVmVO tag=web-vpc-vrouter \
resourceUuid=ae813073d37347098fd6d52b83bfbcd2
CLI Command Manual | 4.8.38 | ZStack Cloud · ZCF | ZStack Resource Center