openconfig-relay-agent

openconfig-version: 0.1.1

Description

This module describes a model for configuration and operational state related to relay agents typically used for DHCP and BOOTP packets. The supports both DHCP and DHCPv6 and device-wide and per-interface settings.

Imports

ietf-inet-types
ietf-yang-types
openconfig-interfaces
openconfig-extensions

Data elements

/
relay-agent

description:
Top level container for relay-agent configuration and operational state data

nodetype: container (rw)

/relay-agent/
dhcp

description:
Top-level container for global relay agent data

nodetype: container (rw)

/relay-agent/dhcp/
config

description:
Configuration data for global DHCPv4

nodetype: container (rw)

/relay-agent/dhcp/config/
enable-relay-agent

description:
Enables DHCP/BOOTP relay agent on all interfaces

nodetype: leaf (rw)

type: boolean

default: false

/relay-agent/dhcp/
state

description:
Operational state data global DHCPv4

nodetype: container (ro)

/relay-agent/dhcp/state/
enable-relay-agent

description:
Enables DHCP/BOOTP relay agent on all interfaces

nodetype: leaf (ro)

type: boolean

default: false

/relay-agent/dhcp/
agent-information-option

description:
Top-level container for relay agent information option data

nodetype: container (rw)

/relay-agent/dhcp/agent-information-option/
config

description:
Configuration data for the relay agent information option

nodetype: container (rw)

/relay-agent/dhcp/agent-information-option/config/
enable

description:
Enable sending the DHCP option for Relay Agent information -- option 82.

nodetype: leaf (rw)

type: boolean

default: false

/relay-agent/dhcp/agent-information-option/
state

description:
Operational state data for agent information at global level

nodetype: container (ro)

/relay-agent/dhcp/agent-information-option/state/
enable

description:
Enable sending the DHCP option for Relay Agent information -- option 82.

nodetype: leaf (ro)

type: boolean

default: false

/relay-agent/dhcp/
interfaces

description:
Enclosing container for the list of interface references.

nodetype: container (rw)

/relay-agent/dhcp/interfaces/
interface

description:
List of interfaces on which the relay agent is configured.

nodetype: list (rw)

list keys: [id]

/relay-agent/dhcp/interfaces/interface/
id

description:
Reference to the interface list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/id

/relay-agent/dhcp/interfaces/interface/
config

description:
Configuration data for relay agent interfaces.

nodetype: container (rw)

/relay-agent/dhcp/interfaces/interface/config/
id

description:
Name of the interface on which relay agent is active

nodetype: leaf (rw)

type: oc-if:interface-id

/relay-agent/dhcp/interfaces/interface/config/
enable

description:
Enables the relay agent on the referenced interface. At least one helper address should also be configured for forwarding requested.

nodetype: leaf (rw)

type: boolean

/relay-agent/dhcp/interfaces/interface/config/
helper-address

description:
List of IPv4 or IPv6 addresses of DHCP servers to which the relay agent should forward DHCPv4 requests. The relay agent is expected to forward DHCPv4/BOOTP requests to all listed server addresses when DHCPv4 relaying is enabled globally, or on the interface.

nodetype: leaf-list (rw)

type: inet:ip-address

/relay-agent/dhcp/interfaces/interface/
state

description:
Operational state data for relay agent interfaces.

nodetype: container (ro)

/relay-agent/dhcp/interfaces/interface/state/
id

description:
Name of the interface on which relay agent is active

nodetype: leaf (ro)

type: oc-if:interface-id

/relay-agent/dhcp/interfaces/interface/state/
enable

description:
Enables the relay agent on the referenced interface. At least one helper address should also be configured for forwarding requested.

nodetype: leaf (ro)

type: boolean

/relay-agent/dhcp/interfaces/interface/state/
helper-address

description:
List of IPv4 or IPv6 addresses of DHCP servers to which the relay agent should forward DHCPv4 requests. The relay agent is expected to forward DHCPv4/BOOTP requests to all listed server addresses when DHCPv4 relaying is enabled globally, or on the interface.

nodetype: leaf-list (ro)

type: inet:ip-address

/relay-agent/dhcp/interfaces/interface/state/
counters

description:
Counters and statistics for relay agent operation.

nodetype: container (ro)

/relay-agent/dhcp/interfaces/interface/state/counters/
total-dropped

description:
Total number of DHCP packets dropped by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
invalid-opcode

description:
Number of DHCP packets dropped due to an invalid opcode

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
invalid-options

description:
Number of DHCP packets dropped due to an invalid option

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
bootrequest-received

description:
BOOTREQUEST messages received by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
dhcp-decline-received

description:
DHCP DECLINE messages received by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
dhcp-discover-received

description:
DHCP DISCOVER messages received by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
dhcp-inform-received

description:
DHCP INFORM messages received by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
dhcp-release-received

description:
DHCP RELEASE messages received by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
dhcp-request-received

description:
DHCP REQUEST messages received by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
bootrequest-sent

description:
BOOTREQUEST messages forwarded by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
bootreply-sent

description:
BOOTREPLY messages forwarded by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
dhcp-offer-sent

description:
DHCP OFFER messages sent by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
dhcp-ack-sent

description:
DHCP ACK messages sent by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/state/counters/
dhcp-nack-sent

description:
DHCP NACK messages sent by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcp/interfaces/interface/
interface-ref

description:
Reference to an interface or subinterface

nodetype: container (rw)

/relay-agent/dhcp/interfaces/interface/interface-ref/
config

description:
Configured reference to interface / subinterface

nodetype: container (rw)

/relay-agent/dhcp/interfaces/interface/interface-ref/config/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/name

/relay-agent/dhcp/interfaces/interface/interface-ref/config/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/relay-agent/dhcp/interfaces/interface/interface-ref/
state

description:
Operational state for interface-ref

nodetype: container (ro)

/relay-agent/dhcp/interfaces/interface/interface-ref/state/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/name

/relay-agent/dhcp/interfaces/interface/interface-ref/state/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/relay-agent/dhcp/interfaces/interface/
agent-information-option

description:
Top-level container for relay agent information option data

nodetype: container (rw)

/relay-agent/dhcp/interfaces/interface/agent-information-option/
config

description:
Configuration data for the relay agent information option

nodetype: container (rw)

/relay-agent/dhcp/interfaces/interface/agent-information-option/config/
enable

description:
Enable sending the DHCP option for Relay Agent information -- option 82.

nodetype: leaf (rw)

type: boolean

default: false

/relay-agent/dhcp/interfaces/interface/agent-information-option/config/
circuit-id

description:
Encodes an agent-local identifier of the circuit from which a DHCP client-to-server packet was received. It is intended for use by agents in relaying DHCP responses back to the proper circuit. The circuit id is an opaque value

nodetype: leaf (rw)

type: string

/relay-agent/dhcp/interfaces/interface/agent-information-option/config/
remote-id

description:
Provides a mechanism to identify the remote host end of the circuit. The remote-id should be thought of as an opaque value, but must be globally unique.

nodetype: leaf (rw)

type: string

/relay-agent/dhcp/interfaces/interface/agent-information-option/
state

description:
Operational state data

nodetype: container (ro)

/relay-agent/dhcp/interfaces/interface/agent-information-option/state/
enable

description:
Enable sending the DHCP option for Relay Agent information -- option 82.

nodetype: leaf (ro)

type: boolean

default: false

/relay-agent/dhcp/interfaces/interface/agent-information-option/state/
circuit-id

description:
Encodes an agent-local identifier of the circuit from which a DHCP client-to-server packet was received. It is intended for use by agents in relaying DHCP responses back to the proper circuit. The circuit id is an opaque value

nodetype: leaf (ro)

type: string

/relay-agent/dhcp/interfaces/interface/agent-information-option/state/
remote-id

description:
Provides a mechanism to identify the remote host end of the circuit. The remote-id should be thought of as an opaque value, but must be globally unique.

nodetype: leaf (ro)

type: string

/relay-agent/dhcp/interfaces/interface/agent-information-option/state/
sent-circuit-id

description:
Reports the circuit-id sent by the system to the DHCP server.

nodetype: leaf (ro)

type: string

/relay-agent/dhcp/interfaces/interface/agent-information-option/state/
sent-remote-id

description:
Reports the remote-id value sent by the system to the DHCP server

nodetype: leaf (ro)

type: string

/relay-agent/
dhcpv6

description:
Top-level container for global relay agent data

nodetype: container (rw)

/relay-agent/dhcpv6/
config

description:
Configuration data for global DHCPv6

nodetype: container (rw)

/relay-agent/dhcpv6/config/
enable-relay-agent

description:
Enables DHCP/BOOTP relay agent on all interfaces

nodetype: leaf (rw)

type: boolean

default: false

/relay-agent/dhcpv6/
state

description:
Operational state data global DHCPv6

nodetype: container (ro)

/relay-agent/dhcpv6/state/
enable-relay-agent

description:
Enables DHCP/BOOTP relay agent on all interfaces

nodetype: leaf (ro)

type: boolean

default: false

/relay-agent/dhcpv6/
options

description:
Top-level container for DHCPv6 agent options on interfaces

nodetype: container (rw)

/relay-agent/dhcpv6/options/
config

description:
Configuration data

nodetype: container (rw)

/relay-agent/dhcpv6/options/config/
enable-interface-id

description:
Enables DHCPv6 OPTION_INTERFACE_ID (18) to identify the interface on which the client message was received.

nodetype: leaf (rw)

type: boolean

default: false

/relay-agent/dhcpv6/options/config/
enable-remote-id

description:
Sets DHCPv6 OPTION_REMOTE_ID (37). This option is the DHCPv6 equivalent for the IPv4 (DHCPv4) Relay Agent Option's Remote-ID suboption as specified in RFC 3046. The remote-id field may be used to encode a user name, remote IP address, interface/port identifier, etc.

nodetype: leaf (rw)

type: boolean

default: false

/relay-agent/dhcpv6/options/
state

description:
Operational state data for DHCPv6 agent option on an interface

nodetype: container (ro)

/relay-agent/dhcpv6/options/state/
enable-interface-id

description:
Enables DHCPv6 OPTION_INTERFACE_ID (18) to identify the interface on which the client message was received.

nodetype: leaf (ro)

type: boolean

default: false

/relay-agent/dhcpv6/options/state/
enable-remote-id

description:
Sets DHCPv6 OPTION_REMOTE_ID (37). This option is the DHCPv6 equivalent for the IPv4 (DHCPv4) Relay Agent Option's Remote-ID suboption as specified in RFC 3046. The remote-id field may be used to encode a user name, remote IP address, interface/port identifier, etc.

nodetype: leaf (ro)

type: boolean

default: false

/relay-agent/dhcpv6/
interfaces

description:
Enclosing container for the list of interface references.

nodetype: container (rw)

/relay-agent/dhcpv6/interfaces/
interface

description:
List of interfaces on which the relay agent is configured.

nodetype: list (rw)

list keys: [id]

/relay-agent/dhcpv6/interfaces/interface/
id

description:
Reference to the interface list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/id

/relay-agent/dhcpv6/interfaces/interface/
config

description:
Configuration data for relay agent interfaces.

nodetype: container (rw)

/relay-agent/dhcpv6/interfaces/interface/config/
id

description:
Name of the interface on which relay agent is active

nodetype: leaf (rw)

type: oc-if:interface-id

/relay-agent/dhcpv6/interfaces/interface/config/
enable

description:
Enables the relay agent on the referenced interface. At least one helper address should also be configured for forwarding requested.

nodetype: leaf (rw)

type: boolean

/relay-agent/dhcpv6/interfaces/interface/config/
helper-address

description:
List of IPv6 addresses of DHCP servers to which the relay agent should forward DHCPv6 requests. The relay agent is expected to forward DHCPv4/BOOTP requests to all listed server addresses when DHCPv6 relaying is enabled globally, or on the interface.

nodetype: leaf-list (rw)

type: inet:ipv6-address

/relay-agent/dhcpv6/interfaces/interface/
state

description:
Operational state data for relay agent interfaces.

nodetype: container (ro)

/relay-agent/dhcpv6/interfaces/interface/state/
id

description:
Name of the interface on which relay agent is active

nodetype: leaf (ro)

type: oc-if:interface-id

/relay-agent/dhcpv6/interfaces/interface/state/
enable

description:
Enables the relay agent on the referenced interface. At least one helper address should also be configured for forwarding requested.

nodetype: leaf (ro)

type: boolean

/relay-agent/dhcpv6/interfaces/interface/state/
helper-address

description:
List of IPv6 addresses of DHCP servers to which the relay agent should forward DHCPv6 requests. The relay agent is expected to forward DHCPv4/BOOTP requests to all listed server addresses when DHCPv6 relaying is enabled globally, or on the interface.

nodetype: leaf-list (ro)

type: inet:ipv6-address

/relay-agent/dhcpv6/interfaces/interface/state/
counters

description:
Counters and statistics for relay agent operation.

nodetype: container (ro)

/relay-agent/dhcpv6/interfaces/interface/state/counters/
total-dropped

description:
Total number of DHCP packets dropped by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
invalid-opcode

description:
Number of DHCP packets dropped due to an invalid opcode

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
invalid-options

description:
Number of DHCP packets dropped due to an invalid option

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-solicit-received

description:
Number of DHCPv6 SOLICIT messages received from clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-decline-received

description:
Number of DHCPv6 DECLINE messages received from clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-request-received

description:
Number of DHCPv6 request messages received from clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-release-received

description:
Number of DHCPv6 release messages received from clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-confirm-received

description:
Number of DHCPv6 confirm messages received from clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-rebind-received

description:
Number of DHCPv6 rebind messages received from clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-info-request-received

description:
Number of DHCPv6 information requests messages received from clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-relay-reply-received

description:
Number of DHCPv6 relay reply messages received from servers by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-adverstise-sent

description:
Number of DHCPv6 adverstise messages sent to clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-reply-sent

description:
Number of DHCPv6 reply messages sent to clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-reconfigure-sent

description:
Number of DHCPv6 reconfigure messages sent to clients by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/state/counters/
dhcpv6-relay-forw-sent

description:
Number of DHCPv6 relay-forward messages sent to servers by the relay agent

nodetype: leaf (ro)

type: yang:counter64

/relay-agent/dhcpv6/interfaces/interface/
interface-ref

description:
Reference to an interface or subinterface

nodetype: container (rw)

/relay-agent/dhcpv6/interfaces/interface/interface-ref/
config

description:
Configured reference to interface / subinterface

nodetype: container (rw)

/relay-agent/dhcpv6/interfaces/interface/interface-ref/config/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/name

/relay-agent/dhcpv6/interfaces/interface/interface-ref/config/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/relay-agent/dhcpv6/interfaces/interface/interface-ref/
state

description:
Operational state for interface-ref

nodetype: container (ro)

/relay-agent/dhcpv6/interfaces/interface/interface-ref/state/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/name

/relay-agent/dhcpv6/interfaces/interface/interface-ref/state/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/relay-agent/dhcpv6/interfaces/interface/
options

description:
Top-level container for DHCPv6 agent options on interfaces

nodetype: container (rw)

/relay-agent/dhcpv6/interfaces/interface/options/
config

description:
Configuration data

nodetype: container (rw)

/relay-agent/dhcpv6/interfaces/interface/options/config/
enable-interface-id

description:
Enables DHCPv6 OPTION_INTERFACE_ID (18) to identify the interface on which the client message was received.

nodetype: leaf (rw)

type: boolean

default: false

/relay-agent/dhcpv6/interfaces/interface/options/config/
enable-remote-id

description:
Sets DHCPv6 OPTION_REMOTE_ID (37). This option is the DHCPv6 equivalent for the IPv4 (DHCPv4) Relay Agent Option's Remote-ID suboption as specified in RFC 3046. The remote-id field may be used to encode a user name, remote IP address, interface/port identifier, etc.

nodetype: leaf (rw)

type: boolean

default: false

/relay-agent/dhcpv6/interfaces/interface/options/config/
interface-id

description:
Sets DHCPv6 OPTION_INTERFACE_ID (18) to identify the interface on which the client message was received.

nodetype: leaf (rw)

type: string

/relay-agent/dhcpv6/interfaces/interface/options/config/
remote-id

description:
Sets DHCPv6 OPTION_REMOTE_ID (37). This option is the DHCPv6 equivalent for the IPv4 (DHCPv4) Relay Agent Option's Remote-ID suboption as specified in RFC 3046. The remote-id field may be used to encode a user name, remote IP address, interface/port identifier, etc.

nodetype: leaf (rw)

type: string

/relay-agent/dhcpv6/interfaces/interface/options/
state

description:
Operational state data for DHCPv6 agent option on an interface

nodetype: container (ro)

/relay-agent/dhcpv6/interfaces/interface/options/state/
enable-interface-id

description:
Enables DHCPv6 OPTION_INTERFACE_ID (18) to identify the interface on which the client message was received.

nodetype: leaf (ro)

type: boolean

default: false

/relay-agent/dhcpv6/interfaces/interface/options/state/
enable-remote-id

description:
Sets DHCPv6 OPTION_REMOTE_ID (37). This option is the DHCPv6 equivalent for the IPv4 (DHCPv4) Relay Agent Option's Remote-ID suboption as specified in RFC 3046. The remote-id field may be used to encode a user name, remote IP address, interface/port identifier, etc.

nodetype: leaf (ro)

type: boolean

default: false

/relay-agent/dhcpv6/interfaces/interface/options/state/
interface-id

description:
Sets DHCPv6 OPTION_INTERFACE_ID (18) to identify the interface on which the client message was received.

nodetype: leaf (ro)

type: string

/relay-agent/dhcpv6/interfaces/interface/options/state/
remote-id

description:
Sets DHCPv6 OPTION_REMOTE_ID (37). This option is the DHCPv6 equivalent for the IPv4 (DHCPv4) Relay Agent Option's Remote-ID suboption as specified in RFC 3046. The remote-id field may be used to encode a user name, remote IP address, interface/port identifier, etc.

nodetype: leaf (ro)

type: string

/relay-agent/dhcpv6/interfaces/interface/options/state/
sent-interface-id

description:
Reflects the DHCPv6 OPTION_INTERFACE_ID (18) sent to the server by the system.

nodetype: leaf (ro)

type: string

/relay-agent/dhcpv6/interfaces/interface/options/state/
sent-remote-id

description:
Reflects the DHCPv6 OPTION_REMOTE_ID (37) sent to the server by the system.

nodetype: leaf (ro)

type: string