RESTAPI Manual
Layer 3
Prefix List
11 min
urls summary urls summary url get post patch put delete /rest/v1/running/prefix lists/{name} y y y n y /rest/v1/running/prefix lists/{name}/entries/{sequence id} y y y n y /rest/v1/rpc/show ip prefix list summary json n y n n n /rest/v1/rpc/show ipv6 prefix list summary json n y n n n examples examples create a prefix list create a prefix list post https //{switch ip}/rest/v1/running/prefix lists { "name" "test", "type" "ipv4", "description" "test ipv4 prefix list" } create prefix list entries create prefix list entries post https //{switch ip}/rest/v1/running/prefix lists/test/entries \[{ "sequence id" "11", "action" "deny" },{ "sequence id" "12", "action" "deny", "ipv4 prefix" "10 0 1 0/24", "min ipv4 prefix length" "25", "max ipv4 prefix length" "26" },{ "sequence id" "13", "action" "permit", "ipv4 prefix" "10 0 2 0/24", "min ipv4 prefix length" "25" },{ "sequence id" "14", "action" "deny", "ipv4 prefix" "10 0 3 0/24", "max ipv4 prefix length" "30" },{ "sequence id" "15", "action" "deny", "ipv4 prefix" "10 0 4 0/24" }] show ipv4 prefix list show ipv4 prefix list post https //{switch ip}/rest/v1/rpc/show ip prefix list summary show ipv6 prefix list show ipv6 prefix list post https //{switch ip}/rest/v1/rpc/show ipv6 prefix list summary properties descriptions properties descriptions prefix lists and entries prefix lists and entries tree diagrams + rw prefix lists + rw prefix list \[name] + rw name + rw type + rw description? + rw entries + rw entry \[sequence id] + rw sequence id + rw action + rw (value)? + (ipv4 prefix) \| + rw ipv4 prefix \| + rw min ipv4 prefix length? \| + rw max ipv4 prefix length? + (ipv6 prefix) + rw ipv6 prefix + rw min ipv6 prefix length? + rw max ipv6 prefix length? table of properties name required type/range description prefix lists m path only node, has no configurable value name m prefix list name (sub property of prefix lists) prefix list name type m "ipv4" "ipv6" (sub property of prefix lists) prefix list type description o string (sub property of prefix lists) prefix list user description entries m (sub property of prefix lists) path only node, has no configurable value sequence id m 1 4294967295 (sub property of entries) prefix list sequence value action m "deny" "permit" (sub property of entries) prefix list action on match ipv4 prefix m a b c d/m (sub property of entries) mutually exclusive with \ ipv6 prefix \ min ipv6 prefix length \ max ipv6 prefix length configure ipv4 prefix to match min ipv4 prefix length o 0 32 (sub property of entries) mutually exclusive with \ ipv6 prefix \ min ipv6 prefix length \ max ipv6 prefix length specifies if matching prefixes with length greater than or equal to value max ipv4 prefix length o 0 32 (sub property of entries) mutually exclusive with \ ipv6 prefix \ min ipv6 prefix length \ max ipv6 prefix length specifies if matching prefixes with length lesser than or equal to value ipv6 prefix m xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx/m (sub property of entries) mutually exclusive with \ ipv4 prefix \ min ipv4 prefix length \ max ipv4 prefix length configure ipv6 prefix to match min ipv6 prefix length o 0 128 (sub property of entries) mutually exclusive with \ ipv4 prefix \ min ipv4 prefix length \ max ipv4 prefix length specifies if matching prefixes with length greater than or equal to value max ipv6 prefix length o 0 128 (sub property of entries) mutually exclusive with \ ipv4 prefix \ min ipv4 prefix length \ max ipv4 prefix length specifies if matching prefixes with length lesser than or equal to value show ipv4 prefix list show ipv4 prefix list tree diagrams + x show ip prefix list summary json \| + w input \| | + w name? \| | + w sequence id? \| + ro output \| + ro data? table of properties name required type/range description show ip prefix list summary json m path only node, has no configurable value name o string (sub property of input) name of a prefix list sequence id o 1 4294967295 (sub property of input) prefix list sequence value data ro \<anydata> (sub property of output) show ipv6 prefix list show ipv6 prefix list tree diagrams + x show ipv6 prefix list summary json + w input \| + w name? \| + w sequence id? + ro output + ro data? table of properties name required type/range description show ipv6 prefix list summary json m path only node, has no configurable value name o string (sub property of input) name of a prefix list sequence id o 1 4294967295 (sub property of input) prefix list sequence value data ro \<anydata> (sub property of output)
