Inventory

Policy Route Rule Set Inventory

Name Description Optional Valid 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
rules The policy route rule. 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": [
    {
      "name": "name",
      "description": "example-des",
      "rules": [
        {
          "uuid": "2e05ab3c36323487baea2414005817ee",
          "ruleNumber": 1.0,
          "ruleSetUuid": "4c86543d473f3127885b3ffc8be5ec88",
          "tableUuid": "d2ad1f7ad9aa354e8da24829bbd31a05",
          "destIp": "192.168.1.1",
          "sourceIp": "10.0.0.1",
          "destPort": "22",
          "sourcePort": "80",
          "protocol": "tcp",
          "state": "enable"
        }
      ]
    }
  ]
}

Policy Route Rule Set and L3 Network Reference Inventory

Name Description Optional Valid Value Starting Version
id 3.6.0
l3NetworkUuid The L3 network UUID. 3.6.0
ruleSetUuid The UUID of the policy route rule set. 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,
      "l3NetworkUuid": "764cba1766563fd683ef1fcf76c7295c",
      "ruleSetUuid": "ddb87b28f0253810b753fc9ae62ebd31"
    }
  ]
}

Policy Route Rule Set and vRouter Reference Inventory

Name Description Optional Valid Value Starting Version
id 3.6.0
vRouterUuid The vRouter UUID. 3.6.0
ruleSetUuid The UUID of the policy route rule set. 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,
      "vRouterUuid": "8715faa19cb03995a864330766fdc77c",
      "ruleSetUuid": "2e27f9015ad3357996546fd51c2d808e"
    }
  ]
}

Policy Route Table Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.6.0
tableNumber The route table No. 3.6.0
routes The rule. 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
Samples
{
  "inventories": [
    {
      "uuid": "6e39025e9eb432fda488f19e7104fdf0",
      "tableNumber": 1.0,
      "description": "example-des",
      "routes": [
        {
          "tableUuid": "90f075232c383565ac3dbc09554c4152",
          "destinationCidr": "192.168.1.0/24",
          "nextHopIp": "192.168.1.1",
          "distance": 1.0
        }
      ]
    }
  ]
}

Policy Route Table and vRouter Reference Inventory

Name Description Optional Valid Value Starting Version
id 3.6.0
tableUuid The policy route table UUID. 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,
      "tableUuid": "cc3bb710f9d43cedb044213253363604",
      "vRouterUuid": "f281299552813438acc3c5a400802a78"
    }
  ]
}

Policy Route Table Route Entry Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.6.0
tableUuid The policy route table UUID. 3.6.0
destinationCidr The destination CIDR. 3.6.0
nextHopIp The next hop IP address. 3.6.0
distance The priority. 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": [
    {
      "tableUuid": "49bf5678360b38058ab7096715e219f4",
      "destinationCidr": "192.168.1.0/24",
      "nextHopIp": "192.168.1.1",
      "distance": 1.0
    }
  ]
}

Policy Route Rule Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.6.0
ruleNumber The priority. 3.6.0
ruleSetUuid The UUID of the policy route rule set. 3.6.0
tableUuid The policy route table UUID. 3.6.0
destIp The destination IP address. 3.6.0
sourceIp The source IP address. 3.6.0
destPort The destination port. 3.6.0
sourcePort The source port. 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": "538840755c1a36e0b79f1d04097b252e",
      "ruleNumber": 1.0,
      "ruleSetUuid": "7cb413c84b243290a7105e8c21f42b59",
      "tableUuid": "d29940b692f33c0eaf96b0193029636c",
      "destIp": "192.168.1.1",
      "sourceIp": "80",
      "destPort": "22",
      "protocol": "tcp",
      "state": "enable"
    }
  ]
}