{ "id":"/axapi/v3/route-map/{tag}+{action}+{sequence}", "type":"object", "node-type":"list", "title":"route-map", "partition-visibility":"shared", "description":"Configure route-map", "properties":{ "tag":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Route map tag", "optional":false }, "action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'permit': Route map permits set operations; 'deny': Route map denies set operations; ", "enum":[ "permit", "deny" ], "optional":false }, "sequence":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Sequence to insert to/delete from existing route-map entry", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "match":{ "type":"object", "$ref":"/axapi/v3/route-map/{tag}+{action}+{sequence}/match", "properties":{ "as-path":{ "type":"object", "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"AS path access-list name" } } }, "community":{ "type":"object", "properties":{ "name-cfg":{ "type":"object", "properties":{ "name":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"One or more Community Lists (numbered or named)" }, "exact-match":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do exact matching of communities" } } } } }, "extcommunity":{ "type":"object", "properties":{ "extcommunity-l-name":{ "type":"object", "properties":{ "name":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"One or more Extended Community Lists (numbered or named)" }, "exact-match":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do exact matching of ecommunities" } } } } }, "large-community":{ "type":"object", "properties":{ "l-name-cfg":{ "type":"object", "properties":{ "name":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"One or more Large Community Lists (numbered or named)" }, "exact-match":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do exact matching of large-communities" } } } } }, "group":{ "type":"object", "properties":{ "group-id":{ "type":"number", "format":"number", "minimum":0, "maximum":31, "partition-visibility":"shared", "description":"HA or VRRP-A group id" }, "ha-state":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'active': HA or VRRP-A in Active State; 'standby': HA or VRRP-A in Standby State; ", "enum":[ "active", "standby" ] } } }, "scaleout":{ "type":"object", "properties":{ "cluster-id":{ "type":"number", "format":"number", "minimum":1, "maximum":64, "partition-visibility":"shared", "description":"Scaleout Cluster-id" }, "operational-state":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'up': Scaleout is up and running; 'down': Scaleout is down or disabled; ", "enum":[ "up", "down" ] } } }, "interface":{ "type":"object", "properties":{ "ethernet":{ "type":"number", "format":"interface", "partition-visibility":"shared", "not-list":[ "loopback", "trunk", "ve", "tunnel" ], "description":"Ethernet interface (Port number)" }, "loopback":{ "type":"number", "format":"number", "minimum":0, "maximum":10, "partition-visibility":"shared", "not-list":[ "ethernet", "trunk", "ve", "tunnel" ], "description":"Loopback interface (Port number)" }, "trunk":{ "type":"number", "format":"number", "minimum":1, "maximum":4096, "partition-visibility":"shared", "not-list":[ "ethernet", "loopback", "ve", "tunnel" ], "description":"Trunk Interface (Trunk interface number)" }, "ve":{ "type":"number", "format":"number", "minimum":2, "maximum":4094, "partition-visibility":"shared", "not-list":[ "ethernet", "loopback", "trunk", "tunnel" ], "description":"Virtual ethernet interface (Virtual ethernet interface number)" }, "tunnel":{ "type":"number", "format":"interface", "partition-visibility":"shared", "not-list":[ "ethernet", "loopback", "trunk", "ve" ], "description":"Tunnel interface (Tunnel interface number)" } } }, "local-preference":{ "type":"object", "properties":{ "val":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "partition-visibility":"shared", "description":"Preference value" } } }, "origin":{ "type":"object", "properties":{ "egp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "igp", "incomplete" ], "description":"remote EGP" }, "igp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "egp", "incomplete" ], "description":"local IGP" }, "incomplete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "egp", "igp" ], "description":"unknown heritage" } } }, "ip":{ "type":"object", "properties":{ "address":{ "type":"object", "properties":{ "acl1":{ "type":"number", "format":"number", "minimum":1, "maximum":199, "partition-visibility":"shared", "not-list":[ "acl2", "name" ], "description":"IP access-list number" }, "acl2":{ "type":"number", "format":"number", "minimum":1300, "maximum":2699, "partition-visibility":"shared", "not-list":[ "acl1", "name" ], "description":"IP access-list number (expanded range)" }, "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "not-list":[ "acl1", "acl2" ], "description":"IP access-list name" }, "prefix-list":{ "type":"object", "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"IP prefix-list name" } } } } }, "next-hop":{ "type":"object", "properties":{ "acl1":{ "type":"number", "format":"number", "minimum":1, "maximum":199, "partition-visibility":"shared", "not-list":[ "acl2", "name" ], "description":"IP access-list number" }, "acl2":{ "type":"number", "format":"number", "minimum":1300, "maximum":2699, "partition-visibility":"shared", "not-list":[ "acl1", "name" ], "description":"IP access-list number (expanded range)" }, "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "not-list":[ "acl1", "acl2" ], "description":"IP access-list name" }, "prefix-list-1":{ "type":"object", "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"IP prefix-list name" } } } } }, "peer":{ "type":"object", "properties":{ "acl1":{ "type":"number", "format":"number", "minimum":1, "maximum":199, "partition-visibility":"shared", "not-list":[ "acl2", "name" ], "description":"IP access-list number" }, "acl2":{ "type":"number", "format":"number", "minimum":1300, "maximum":2699, "partition-visibility":"shared", "not-list":[ "acl1", "name" ], "description":"IP access-list number (expanded range)" }, "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "not-list":[ "acl1", "acl2" ], "description":"IP access-list name" } } }, "rib":{ "type":"object", "properties":{ "exact":{ "type":"string", "format":"ipv4-cidr", "partition-visibility":"shared", "not-list":[ "reachable", "unreachable" ], "description":"Exact match a prefix (Prefix IPv4 address)" }, "reachable":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "exact", "unreachable" ], "description":"IP address is reachable" }, "unreachable":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "exact", "reachable" ], "description":"IP address is unreachable" } } } } }, "ipv6":{ "type":"object", "properties":{ "address-1":{ "type":"object", "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"IPv6 access-list name" }, "prefix-list-2":{ "type":"object", "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"IPv6 prefix-list name" } } } } }, "next-hop-1":{ "type":"object", "properties":{ "next-hop-acl-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "not":"v6-addr", "description":"IPv6 access-list name" }, "v6-addr":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"next-hop-acl-name", "description":"IPv6 address of next hop" }, "prefix-list-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"IPv6 prefix-list name" } } }, "peer-1":{ "type":"object", "properties":{ "acl1":{ "type":"number", "format":"number", "minimum":1, "maximum":199, "partition-visibility":"shared", "not-list":[ "acl2", "name" ], "description":"IPv6 access-list number" }, "acl2":{ "type":"number", "format":"number", "minimum":1300, "maximum":2699, "partition-visibility":"shared", "not-list":[ "acl1", "name" ], "description":"IP access-list number (expanded range)" }, "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "not-list":[ "acl1", "acl2" ], "description":"IP access-list name" } } }, "rib":{ "type":"object", "properties":{ "exact":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "not-list":[ "reachable", "unreachable" ], "description":"Exact match a prefix (Prefix IPv6 address)" }, "reachable":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not-list":[ "exact", "unreachable" ], "description":"IPv6 address is reachable" }, "unreachable":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not-list":[ "exact", "reachable" ], "description":"IPv6 address is unreachable" } } } } }, "metric":{ "type":"object", "properties":{ "value":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "partition-visibility":"shared", "description":"Metric value" } } }, "route-type":{ "type":"object", "properties":{ "external":{ "type":"object", "properties":{ "value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'type-1': Match OSPF External Type 1 metrics; 'type-2': Match OSPF External Type 2 metrics; ", "enum":[ "type-1", "type-2" ] } } } } }, "tag":{ "type":"object", "properties":{ "value":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "partition-visibility":"shared", "description":"Tag value" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "set":{ "type":"object", "$ref":"/axapi/v3/route-map/{tag}+{action}+{sequence}/set", "properties":{ "ip":{ "type":"object", "properties":{ "next-hop":{ "type":"object", "properties":{ "address":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"IP address of next hop" } } } } }, "ddos":{ "type":"object", "properties":{ "class-list-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Class-List Name" }, "class-list-cid":{ "type":"number", "format":"number", "minimum":1, "maximum":32, "partition-visibility":"shared", "description":"Class-List Cid" }, "zone":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Zone Name" } } }, "ipv6":{ "type":"object", "properties":{ "next-hop-1":{ "type":"object", "properties":{ "address":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"global address of next hop" }, "local":{ "type":"object", "properties":{ "address":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"IPv6 address of next hop" } } } } } } }, "level":{ "type":"object", "properties":{ "value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'level-1': Export into a level-1 area; 'level-1-2': Export into level-1 and level-2; 'level-2': Export into level-2 sub-domain; ", "enum":[ "level-1", "level-1-2", "level-2" ] } } }, "metric":{ "type":"object", "properties":{ "value":{ "type":"string", "format":"string", "minLength":1, "maxLength":11, "partition-visibility":"shared", "description":"Metric Value (from -4294967295 to 4294967295)" } } }, "metric-type":{ "type":"object", "properties":{ "value":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'external': IS-IS external metric type; 'internal': IS-IS internal metric type; 'type-1': OSPF external type 1 metric; 'type-2': OSPF external type 2 metric; ", "enum":[ "external", "internal", "type-1", "type-2" ] } } }, "tag":{ "type":"object", "properties":{ "value":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "partition-visibility":"shared", "description":"Tag value" } } }, "aggregator":{ "type":"object", "properties":{ "aggregator-as":{ "type":"object", "properties":{ "asn":{ "type":"number", "format":"number", "minimum":1, "maximum":4294967295, "partition-visibility":"shared", "description":"AS number" }, "ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"IP address of aggregator" } } } } }, "as-path":{ "type":"object", "properties":{ "prepend":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"Prepend to the as-path (AS number)" }, "num":{ "type":"string", "format":"string", "minLength":1, "maxLength":11, "partition-visibility":"shared", "description":"AS number" }, "num2":{ "type":"string", "format":"string", "minLength":1, "maxLength":11, "partition-visibility":"shared", "description":"AS number" } } }, "atomic-aggregate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"BGP atomic aggregate attribute" }, "comm-list":{ "type":"object", "properties":{ "v-std":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "partition-visibility":"shared", "not-list":[ "v-exp", "name", "l-v-exp", "l-name" ], "description":"Community-list number (standard)" }, "delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete matching communities" }, "v-exp":{ "type":"number", "format":"number", "minimum":100, "maximum":199, "partition-visibility":"shared", "not-list":[ "v-std", "name", "l-name" ], "description":"Community-list number (expanded)" }, "v-exp-delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete matching communities" }, "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "not-list":[ "v-std", "v-exp" ], "description":"Community-list name" }, "name-delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete matching communities" } } }, "community":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"BGP community attribute" }, "dampening-cfg":{ "type":"object", "properties":{ "dampening":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable route-flap dampening" }, "dampening-half-time":{ "type":"number", "format":"number", "minimum":1, "maximum":45, "partition-visibility":"shared", "description":"Reachability Half-life time for the penalty(minutes)" }, "dampening-reuse":{ "type":"number", "format":"number", "minimum":1, "maximum":20000, "partition-visibility":"shared", "description":"Value to start reusing a route" }, "dampening-supress":{ "type":"number", "format":"number", "minimum":1, "maximum":20000, "partition-visibility":"shared", "description":"Value to start suppressing a route" }, "dampening-max-supress":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"Maximum duration to suppress a stable route(minutes)" }, "dampening-penalty":{ "type":"number", "format":"number", "minimum":1, "maximum":45, "partition-visibility":"shared", "description":"Un-reachability Half-life time for the penalty(minutes)" } } }, "extcommunity":{ "type":"object", "properties":{ "rt":{ "type":"object", "properties":{ "value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"VPN extended community" } } }, "soo":{ "type":"object", "properties":{ "value":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"VPN extended community" } } } } }, "local-preference":{ "type":"object", "properties":{ "val":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "partition-visibility":"shared", "description":"Preference value" } } }, "originator-id":{ "type":"object", "properties":{ "originator-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"IP address of originator" } } }, "weight":{ "type":"object", "properties":{ "weight-val":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "partition-visibility":"shared", "description":"Weight value" } } }, "origin":{ "type":"object", "properties":{ "egp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "igp", "incomplete" ], "description":"remote EGP" }, "igp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "egp", "incomplete" ], "description":"local IGP" }, "incomplete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "egp", "igp" ], "description":"unknown heritage" } } }, "large-comm-list":{ "type":"object", "properties":{ "l-v-std":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "partition-visibility":"shared", "description":"Large Community-list number (standard)" }, "l-v-std-delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete matching large communities" }, "l-v-exp":{ "type":"number", "format":"number", "minimum":100, "maximum":199, "partition-visibility":"shared", "not":"v-std", "description":"Large Community-list number (expanded)" }, "l-v-exp-delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete matching large communities" }, "l-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "not-list":[ "v-std", "v-exp" ], "description":"Large Community-list name" }, "large-name-delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete matching large communities" } } }, "large-community":{ "type":"string", "format":"string-rlx", "partition-visibility":"shared", "description":"BGP large community attribute" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "object-keys":[ "tag", "action", "sequence" ], "required":[ "tag", "action", "sequence" ] }