Inventory

Flow Collector Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.6.0
name The name. For more information, see Resource Property. 3.6.0
description The description. For more information, see Resource Property. Yes 3.6.0
flowMeterUuid 3.6.0
port The UDP port of the flow collector. 3.6.0
server The IP address of the flow collector. 3.6.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.6.0
createDate The creation date. For more information, see Resource Property. 3.6.0
lastOpDate The last operation date. For more information, see Resource Property. 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
Sample
{   "inventories": [     {       "uuid": "e231c750a95b301cb4b6de429fa11bbc",       "server": "192.168.48.12",       "port": 2055.0,       "createDate": "Nov 14, 2017 10:20:57 PM",       "lastOpDate": "Nov 14, 2017 10:20:57 PM"     }   ] }

Flow Meter Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.6.0
name The name. For more information, see Resource Property. 3.6.0
description The description. For more information, see Resource Property. Yes 3.6.0
expireInterval The expiration interval of the flow. 3.6.0
sample The sample rate of the flow meter. 3.6.0
type The type of the flow meter protocol. 3.6.0
version The version of the flow meter protocol. 3.6.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.6.0
createDate The creation date. For more information, see Resource Property. 3.6.0
lastOpDate The last operation date. For more information, see Resource Property. 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
Sample
{   "inventories": [     {       "uuid": "4ba598ab40a1321798fb957a9eddb77d",       "type": "NetFlow",       "createDate": "Nov 14, 2017 10:20:57 PM",       "lastOpDate": "Nov 14, 2017 10:20:57 PM"     }   ] }

vRouter Flow Meter Network Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.6.0
flowMeterUuid 3.6.0
l3NetworkUuid The L3 network UUID. 3.6.0
vRouterUuid 3.6.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.6.0
createDate The creation date. For more information, see Resource Property. 3.6.0
lastOpDate The last operation date. For more information, see Resource Property. 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
Sample
{   "inventories": [     {       "uuid": "62413232b13c3ff496876495906d9254",       "vRouterUuid": "276b37d53794342b8b93f11ffdab0b24",       "flowMeterUuid": "606c59dee3e0371da1b6a829c249bb79",       "l3NetworkUuid": "7d744eec67cb385cb8f55e84056a3a50",       "createDate": "Nov 14, 2017 10:20:57 PM",       "lastOpDate": "Nov 14, 2017 10:20:57 PM"     }   ] }

Port Mirror Inventory

Name Description Optional Optional Value Starting Version
description The description. For more information, see Resource Property. Yes 3.7.0
mirrorNetworkUuid The UUID of the mirror network resource. 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. For more information, see CreateUserTag. Yes 3.7.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.7.0
Sample
{     "inventories": [],     "success": true } 

Port Mirror Session Inventory

Name Description Optional Optional 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
dstEndPoint The destination endpoint of the mirror session. 3.7.0
internalId 3.7.0
portMirrorUuid The port mirror UUID. 3.7.0
srcEndPoint The source endpoint of the mirror session. 3.7.0
status 3.7.0
type 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. For more information, see CreateUserTag. Yes 3.7.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.7.0
Sample
{     "inventories": [],     "success": true }

Port Mirror Network Used IP Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.7.0
description The description. For more information, see Resource Property. Yes 3.7.0
clusterUuid The cluster UUID. 3.7.0
hostUuid The host UUID. 3.7.0
l3NetworkUuid The L3 network UUID. 3.7.0
usedIpInventory 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
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
Sample
{     "inventories": [],     "success": true }

Network Service Provider Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 2.2
name The name. For more information, see Resource Property. 2.2
description The description. For more information, see Resource Property. Yes 2.2
attachedL2NetworkUuids The UUIDs of attached L2 networks. 2.2
networkServiceTypes The network service types. 2.2
type 2.2
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 2.2
createDate The creation date. For more information, see Resource Property. 2.2
lastOpDate The last operation date. For more information, see Resource Property. 2.2
userTags The user tags. For more information, see CreateUserTag. Yes 2.2
systemTags The system tags. For more information, see CreateSystemTag. Yes 2.2
Sample
{     "inventories": [         {             "attachedL2NetworkUuids": [                 "06787a08456b458db2af527c23ab110c",                 "8baa26aacfb740adb1d7709a369179ef",                 "fd91d394591e4b79a2979c34abac464d",                 "32d20dc18ef74adfb033fdfbce674bbf",                 "00e1a1bea98c46d59c4c9768357d4f62"             ],             "createDate": "Jun 20, 2018 10:45:45 AM",             "description": "zstack vrouter network service provider",             "lastOpDate": "Jun 20, 2018 10:45:45 AM",             "name": "vrouter",             "networkServiceTypes": [                 "IPsec",                 "VRouterRoute",                 "CentralizedDNS",                 "VipQos",                 "DNS",                 "SNAT",                 "LoadBalancer",                 "PortForwarding",                 "Eip",                 "DHCP"             ],             "type": "vrouter",             "uuid": "1b0e0976950b4dd1a57ec93f31957b53"         },         {             "attachedL2NetworkUuids": [                 "aceca791929e472890aff8f2dbf5114b",                 "06787a08456b458db2af527c23ab110c",                 "9344c9a846564ae285a8150a317c4596",                 "ba8e717610854cfab8e6a98affb1e880",                 "21ba175a6b8c4e2e9e3b0efb103c3843",                 "40f4ad9d69954d9cb3bf5dc95c67ed83",                 "8baa26aacfb740adb1d7709a369179ef",                 "fd91d394591e4b79a2979c34abac464d",                 "e6f80f6348f146a3b0d4682be87c8bab",                 "32d20dc18ef74adfb033fdfbce674bbf",                 "00e1a1bea98c46d59c4c9768357d4f62",                 "aeac2cd1a74d4274b94bda5cc1b7689e"             ],             "createDate": "Jun 20, 2018 10:45:45 AM",             "description": "Flat Network Service Provider",             "lastOpDate": "Jun 20, 2018 10:45:45 AM",             "name": "Flat Network Service Provider",             "networkServiceTypes": [                 "VipQos",                 "DNS",                 "HostRoute",                 "Userdata",                 "Eip",                 "DHCP"             ],             "type": "Flat",             "uuid": "5716a451ebe040e5b70822df8e4423d7"         },         {             "attachedL2NetworkUuids": [                 "06787a08456b458db2af527c23ab110c",                 "8baa26aacfb740adb1d7709a369179ef",                 "fd91d394591e4b79a2979c34abac464d",                 "32d20dc18ef74adfb033fdfbce674bbf",                 "00e1a1bea98c46d59c4c9768357d4f62"             ],             "createDate": "Jun 20, 2018 10:45:45 AM",             "description": "zstack security group network service provider",             "lastOpDate": "Jun 20, 2018 10:45:45 AM",             "name": "SecurityGroup",             "networkServiceTypes": [                 "SecurityGroup"             ],             "type": "SecurityGroup",             "uuid": "5fad7c177d6041be9b76d5c55e742865"         },         {             "attachedL2NetworkUuids": [                 "06787a08456b458db2af527c23ab110c",                 "8baa26aacfb740adb1d7709a369179ef",                 "fd91d394591e4b79a2979c34abac464d",                 "32d20dc18ef74adfb033fdfbce674bbf",                 "00e1a1bea98c46d59c4c9768357d4f62"             ],             "createDate": "Jun 20, 2018 10:45:45 AM",             "description": "zstack virtual router network service provider",             "lastOpDate": "Jun 20, 2018 10:45:45 AM",             "name": "VirtualRouter",             "networkServiceTypes": [                 "DNS",                 "SNAT",                 "LoadBalancer",                 "PortForwarding",                 "Eip",                 "DHCP"             ],             "type": "VirtualRouter",             "uuid": "9c4e250086ef43a1839f0c71c42c5d47"         }     ],     "success": true }

VPC Firewall Inventory

VPC Firewall Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.6.0
name The name. For more information, see Resource Property. 3.6.0
description The description. For more information, see Resource Property. 3.6.0
refs The reference between the VPC firewall rule set and the network. 3.6.0
rulesets The VPC firewall rule set. 3.6.0
createDate The creation date. For more information, see Resource Property. 3.6.0
lastOpDate The last operation date. For more information, see Resource Property. 3.6.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.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
Sample
{   "inventories": [     {       "name": "name",       "ruleSets": [         {           "name": "name",           "vpcFirewallUuid": "76cbd34de351334bbd0f51ee0653d0ab",           "actionType": "drop",           "description": "example-des",           "enableDefaultLog": false,           "isDefault": false         }       ],       "refs": [         {           "id": 1.0,           "ruleSetUuid": "530b17414c29330db2d788c227c50134",           "l3Uuid": "01a959eec095396eaed841c886219eec",           "packetsForwardType": "in",           "createDate": "Nov 14, 2017 10:20:57 PM",           "lastOpDate": "Nov 14, 2017 10:20:57 PM"         }       ],       "description": "example-des"     }   ] }

Firewall Rule Set Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.6.0
name The name. For more information, see Resource Property. 3.6.0
description The description. For more information, see Resource Property. 3.6.0
actionType The action type.
  • drop
  • reject
  • accept
3.6.0
isDefault The default value. 3.6.0
vpcFirewallUuid 3.6.0
createDate The creation date. For more information, see Resource Property. 3.6.0
lastOpDate The last operation date. For more information, see Resource Property. 3.6.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.6.0
userTags The user tags. For more information, see CreateUserTag Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
Sample
{   "inventories": [     {       "name": "name",       "vpcFirewallUuid": "c4a963f2391f3d7195032ed37bad0b57",       "actionType": "drop",       "description": "example-des",       "enableDefaultLog": false,       "isDefault": false     }   ] }

Firewall Rule Set and L3 Network Reference Inventory

Name Description Optional Optional Value Starting Version
id 3.6.0
l3NetworkUuid The L3 network UUID. 3.6.0
packetsForwardType 3.6.0
ruleSetUuid The rule set UUID. 3.6.0
vpcFirewallUuid The firewall UUID. 3.6.0
createDate The creation date. For more information, see Resource Property. 3.6.0
lastOpDate The last operation date. For more information, see Resource Property. 3.6.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.6.0
userTags The user tags. For more information, see CreateUserTag Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
Sample
{   "inventories": [     {       "id": 1.0,       "ruleSetUuid": "f4575926f7a13c82a0d610dfac995ffa",       "l3Uuid": "85044a1e0ccb3c859c0b024e967fb191",       "packetsForwardType": "in",       "createDate": "Nov 14, 2017 10:20:57 PM",       "lastOpDate": "Nov 14, 2017 10:20:57 PM"     }   ] }

Firewall Rule Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.6.0
description The description. For more information, see Resource Property. Yes 3.6.0
action 3.6.0
allowStates 3.6.0
destIp 3.6.0
destPort 3.6.0
icmpTypeName 3.6.0
isDefault 3.6.0
protocol 3.6.0
ruleNumber 3.6.0
ruleSetName 3.6.0
ruleSetUuid 3.6.0
sourceIp 3.6.0
sourcePort 3.6.0
state 3.6.0
tcpFlag 3.6.0
vpcFirewallUuid 3.6.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.6.0
createDate The creation date. For more information, see Resource Property. 3.6.0
lastOpDate The last operation date. For more information, see Resource Property. 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
Sample
{   "inventories": [     {       "vpcFirewallUuid": "1aa5e5c3dd4f359a932438a2a6efbf62",       "ruleSetUuid": "09e49f20a184378db905d38223ab020f",       "action": "accept",       "protocol": "TCP",       "destPort": "22",       "sourcePort": "22",       "sourceIp": "192.168.1.2",       "destIp": "192.168.1.1",       "ruleNumber": 1001.0,       "allowStates": "invalid,new",       "tcpFlag": "SYN",       "icmpTypeName": "echo-reply",       "enableLog": false,       "state": "disable",       "isDefault": false,       "description": "example rule des"     }   ] }

VPC Firewall and vRouter Reference Inventory

Name Description Optional Optional Value Starting Version
vpcFirewallUuid The firewall UUID. 3.6.0
id 3.6.0
vRouterUuid The vRouter UUID. 3.6.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.6.0
createDate The creation date. For more information, see Resource Property. 3.6.0
lastOpDate The last operation date. For more information, see Resource Property. 3.6.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.6.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.6.0
Sample
{   "inventories": [     {       "id": 1.0,       "vpcFirewallUuid": "cd7ab20e4768316c86230f2d982ae5a5",       "vRouterUuid": "7013faeb3b4736d1800749b1e910a845",       "createDate": "Nov 14, 2017 10:20:57 PM",       "lastOpDate": "Nov 14, 2017 10:20:57 PM"     }   ] }

Security Group Inventory

Properties

Name Description Optional Optional 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
state The state. For more information, see Resource Property.
  • Enabled
  • Disabled
0.6
rules The rules. For more information, see Security Group Rule Inventory. 0.6
attachedL3NetworkUuids The UUIDs of the L3 Network to which the security group is attached. 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

 {     "attachedL3NetworkUuids": [         "0b48770e593e400c8f54e71fd4e7f514"     ],     "createDate": "Nov 16, 2015 1:02:22 AM",     "lastOpDate": "Nov 16, 2015 1:02:22 AM",     "name": "sg-in",     "rules": [         {             "allowedCidr": "0.0.0.0/0",             "createDate": "April 29, 2015 9:57:10 PM",             "state": "Enabled",             "endPort": 22,             "lastOpDate": "Nov 29, 2015 9:57:10 PM",             "protocol": "TCP",             "securityGroupUuid": "9e0a72fe64814900baa22f78a1b9d235",             "startPort": 22,             "type": "Ingress",             "uuid": "a338d11be18d4e288223597682964dc8"         }     ],     "state": "Enabled",     "uuid": "9e0a72fe64814900baa22f78a1b9d235" }

Default Security Group Policy

  • For an empty security group, we have default polices for inbound traffics and outbound traffics.
  • For inbound traffics, the default policy is to deny, which means that all inbound traffics traveling to the NICs in this empty security group will be blocked.
  • For outbound traffics, the default policy is to allow, which means that all outbound traffics coming from the NICs in this empty security group will be allowed.

To change default policies, you can change the actions for Ingress.defaultPolicy and Egress.defaultPolicy in Global Setting.

Security Group Rule Inventory

Name Description Optional Optional Value Starting Version
uuid The UUID. For more information, see Resource Property. 0.6
securityGroupUuid The UUID of the parent security group. 0.6
remoteSecurityGroupUuid The source security group, which indicates that only the VM instances specified in the security group are allowed. Yes 0.6
type The type. For more information, see Traffic Type.
  • Ingress
  • Egress
0.6
protocol The traffic protocol type.
  • TCP
  • UDP
  • ICMP
0.6
startPort If the protocol is TCP or UDP, this parameter is the start port of the port range. If the protocol is ICMP, this parameter is ICMP type.
  • For TCP/UDP: 0 - 65535.
  • For ICMP: use '-1' to represent all types. For more information, see ICMP type and code.
0.6
endPort If the protocol is TCP/UDP, this parameter is the end port of the port range. If the protocol is ICMP, this parameter is ICMP type.
  • For TCP/UDP: 0 - 65535.
  • For ICMP: use '-1' to represent all types. For more information, see ICMP type and code.
0.6
allowedCidr The allowed CIDR. For more information, see Allowed CIDR. 0.6
state The rule state, which is not implemented in the current version.
  • Enabled
  • Disabled
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

{      "allowedCidr": "0.0.0.0/0",      "state": "Enabled",      "startPort": 22,      "endPort": 22,      "protocol": "TCP",      "type": "Ingress",      "createDate": "Nov 29, 2015 9:57:10 PM",      "lastOpDate": "Nov 29, 2015 9:57:10 PM",      "uuid": "a338d11be18d4e288223597682964dc8"      "securityGroupUuid": "9e0a72fe64814900baa22f78a1b9d235" }

Traffic Type

Traffics have two types.
  • Ingress:

    Inbound traffics that access a VM NIC.

  • Egress:

    Outbound traffics that leave from a VM NIC.

Allowed CIDR

Allowed CIDR has different meanings according to different traffic types. The format of an allowed CIDR is as follows:
ipv4_address/network_prefix For example: 12.12.12.12/24
If the traffic type is Ingress, the allowed CIDR is a source CIDR that is allowed to access VM NICs. The following is an example of an inbound rule:
startPort: 22 endPort: 22 protocol: TCP type: Ingress allowedCidr: 12.12.12.12/32
The example above indicates that only TCP traffics from the IP address (12.12.12.12) are allowed to access port 22.
If the traffic type is Egress, the allowed CIDR is a destination CIDR that is allowed to leave VM NICs. The following is an example of an outbound rule:
startPort: 22 endPort: 22 protocol: TCP type: Egress allowedCidr: 12.12.12.12/32
The example above indicates that only TCP traffics to port 22 of the IP address (12.12.12.12) are allowed to leave.

Note that CIDR 0.0.0.0/0 represents all IP addresses.


VIP Inventory

Properties

Name Description Optional Optional 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
l3NetworkUuid The UUID of the L3 network to which the VIP is allocated. 0.6
ip The IP address of the IPv4 type. 0.6
state The state of the VIP.
  • Enabled
  • Disabled
0.6
gateway The gateway. 0.6
netmask The netmask. 0.6
serviceProvider The service provider that provides the VIP service. Yes 0.6
peerL3NetworkUuids The L3 private network UUID or the VPC L3 network UUID. 0.6
useFor The usage, such as port forwarding. Yes
  • EIP
  • PortForwarding
  • LoadBalancer
  • IPsec
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

 {             "createDate": "Dec 1, 2017 8:24:43 PM",             "description": "",             "gateway": "10.0.0.1",             "ip": "10.128.19.232",             "l3NetworkUuid": "429f0e8a088b4ed688e64f42dab3c405",             "lastOpDate": "Dec 1, 2017 8:25:00 PM",             "name": "vip-for-lb-lb2",             "netmask": "255.0.0.0",             "peerL3NetworkUuids": [                 "62eeb35445144649acbbd72392cf2b40"             ],             "serviceProvider": "vrouter",             "state": "Enabled",             "useFor": "LoadBalancer",             "uuid": "81806eb3a0034f529e80034e749b2a8a" }




Back to Top

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.