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"
    }
  ]
}