openconfig-defined-sets

openconfig-version: 1.1.0

Description

This module defines configuration and operational state data for defined sets (sets of IPv4 prefixes, sets of IPv6 prefixes, sets of ports, etc). These sets are used, for example, in network access control lists (i.e., filters, rules, etc.) in the matching fields.

Imports

openconfig-extensions
openconfig-inet-types
openconfig-packet-match-types

Data elements

/
defined-sets

description:
Top level enclosing container for defined-set model config and operational state data.

nodetype: container (rw)

/defined-sets/
ipv4-prefix-sets

description:
Container to hold the list of IPv4 prefix sets.

nodetype: container (rw)

/defined-sets/ipv4-prefix-sets/
ipv4-prefix-set

description:
List of IPv4 prefix sets.

nodetype: list (rw)

list keys: [name]

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/
name

description:
Reference to the name of the IPv4 prefix set.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/
config

description:
Configuration data for IPv4 prefix sets.

nodetype: container (rw)

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/config/
name

description:
A user defined name of the IPv4 prefix set.

nodetype: leaf (rw)

type: string

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/config/
description

description:
A user defined IPv4 prefix set description.

nodetype: leaf (rw)

type: string

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/config/
prefix

description:
A user defined list of IPv4 prefixes to be used in match conditions. Each entry is an IPv4 + mask combination. Addresses within these prefixes will be considered for matching, unless they also fall within any of the 'exclude-prefix' entries.

nodetype: leaf-list (rw)

type: oc-inet:ipv4-prefix

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/config/
exclude-prefix

description:
A user-defined list of IPv4 prefixes to be excluded from the 'prefix' list. Each entry is an IPv4 address with a mask. Let P be the union of all addresses in the 'prefix' list, and E be the union of all addresses in the 'exclude-prefix' list. The effective match set is ( P - E ), i.e., addresses in 'prefix' that are not in 'exclude-prefix'.

nodetype: leaf-list (rw)

type: oc-inet:ipv4-prefix

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/
state

description:
State data for IPv4 prefix sets.

nodetype: container (ro)

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/state/
name

description:
A user defined name of the IPv4 prefix set.

nodetype: leaf (ro)

type: string

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/state/
description

description:
A user defined IPv4 prefix set description.

nodetype: leaf (ro)

type: string

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/state/
prefix

description:
A user defined list of IPv4 prefixes to be used in match conditions. Each entry is an IPv4 + mask combination. Addresses within these prefixes will be considered for matching, unless they also fall within any of the 'exclude-prefix' entries.

nodetype: leaf-list (ro)

type: oc-inet:ipv4-prefix

/defined-sets/ipv4-prefix-sets/ipv4-prefix-set/state/
exclude-prefix

description:
A user-defined list of IPv4 prefixes to be excluded from the 'prefix' list. Each entry is an IPv4 address with a mask. Let P be the union of all addresses in the 'prefix' list, and E be the union of all addresses in the 'exclude-prefix' list. The effective match set is ( P - E ), i.e., addresses in 'prefix' that are not in 'exclude-prefix'.

nodetype: leaf-list (ro)

type: oc-inet:ipv4-prefix

/defined-sets/
ipv6-prefix-sets

description:
Container to hold the list of IPv4 prefix sets.

nodetype: container (rw)

/defined-sets/ipv6-prefix-sets/
ipv6-prefix-set

description:
List of IPv6 prefix sets. Each defined set is uniquely identified by a name

nodetype: list (rw)

list keys: [name]

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/
name

description:
Reference to the name of the IPv6 prefix set.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/
config

description:
Configuration data for IPv6 prefix sets.

nodetype: container (rw)

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/config/
name

description:
Name of the IPv6 prefix set.

nodetype: leaf (rw)

type: string

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/config/
description

description:
A user defined IPv6 prefix set description.

nodetype: leaf (rw)

type: string

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/config/
prefix

description:
A user defined list of IPv6 prefixes to be used in match conditions. Each entry is an IPv6 + mask combination. Addresses within these prefixes will be considered for matching, unless they also fall within any of the 'exclude-prefix' entries.

nodetype: leaf-list (rw)

type: oc-inet:ipv6-prefix

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/config/
exclude-prefix

description:
A user-defined list of IPv6 prefixes to be excluded from the 'prefix' list. Each entry is an IPv6 address with a mask. Let P be the union of all addresses in the 'prefix' list, and E be the union of all addresses in the 'exclude-prefix' list. The effective match set is ( P - E ), i.e., addresses in 'prefix' that are not in 'exclude-prefix'.

nodetype: leaf-list (rw)

type: oc-inet:ipv6-prefix

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/
state

description:
State data for prefix lists.

nodetype: container (ro)

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/state/
name

description:
Name of the IPv6 prefix set.

nodetype: leaf (ro)

type: string

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/state/
description

description:
A user defined IPv6 prefix set description.

nodetype: leaf (ro)

type: string

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/state/
prefix

description:
A user defined list of IPv6 prefixes to be used in match conditions. Each entry is an IPv6 + mask combination. Addresses within these prefixes will be considered for matching, unless they also fall within any of the 'exclude-prefix' entries.

nodetype: leaf-list (ro)

type: oc-inet:ipv6-prefix

/defined-sets/ipv6-prefix-sets/ipv6-prefix-set/state/
exclude-prefix

description:
A user-defined list of IPv6 prefixes to be excluded from the 'prefix' list. Each entry is an IPv6 address with a mask. Let P be the union of all addresses in the 'prefix' list, and E be the union of all addresses in the 'exclude-prefix' list. The effective match set is ( P - E ), i.e., addresses in 'prefix' that are not in 'exclude-prefix'.

nodetype: leaf-list (ro)

type: oc-inet:ipv6-prefix

/defined-sets/
port-sets

description:
Container to hold the list of port sets.

nodetype: container (rw)

/defined-sets/port-sets/
port-set

description:
List of port sets. Each por set is uniquely identified by its name

nodetype: list (rw)

list keys: [name]

/defined-sets/port-sets/port-set/
name

description:
Name of the port set. The name is used to reference the set in match conditions.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/defined-sets/port-sets/port-set/
config

description:
Configuration data for port lists.

nodetype: container (rw)

/defined-sets/port-sets/port-set/config/
name

description:
A user defined name of the port set.

nodetype: leaf (rw)

type: string

/defined-sets/port-sets/port-set/config/
description

description:
A user defined description for the port set

nodetype: leaf (rw)

type: string

/defined-sets/port-sets/port-set/config/
port

description:
A user defined set of ports to be used in the match conditions. Ports listed here will be considered for matching, unless they are also included in 'exclude-port'.

nodetype: leaf-list (rw)

type: oc-pkt-match-types:port-num-range

/defined-sets/port-sets/port-set/config/
exclude-port

description:
A user-defined list of ports to be excluded from the 'port' list. Let P be the union of the ports in the 'port' list, and E be the union of ports in the 'exclude-port' list. The effective match set is ( P - E ) i.e., ports in 'port' that are not in 'exclude-port'.

nodetype: leaf-list (rw)

type: oc-pkt-match-types:port-num-range

/defined-sets/port-sets/port-set/
state

description:
State data for port lists.

nodetype: container (ro)

/defined-sets/port-sets/port-set/state/
name

description:
A user defined name of the port set.

nodetype: leaf (ro)

type: string

/defined-sets/port-sets/port-set/state/
description

description:
A user defined description for the port set

nodetype: leaf (ro)

type: string

/defined-sets/port-sets/port-set/state/
port

description:
A user defined set of ports to be used in the match conditions. Ports listed here will be considered for matching, unless they are also included in 'exclude-port'.

nodetype: leaf-list (ro)

type: oc-pkt-match-types:port-num-range

/defined-sets/port-sets/port-set/state/
exclude-port

description:
A user-defined list of ports to be excluded from the 'port' list. Let P be the union of the ports in the 'port' list, and E be the union of ports in the 'exclude-port' list. The effective match set is ( P - E ) i.e., ports in 'port' that are not in 'exclude-port'.

nodetype: leaf-list (ro)

type: oc-pkt-match-types:port-num-range