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.
ietf-inet-types
ietf-yang-types
openconfig-interfaces
openconfig-extensions
description:
Top level container for relay-agent configuration and
operational state data
nodetype: container (rw)
description:
Top-level container for global relay agent data
nodetype: container (rw)
description:
Configuration data for global DHCPv4
nodetype: container (rw)
description:
Enables DHCP/BOOTP relay agent on all interfaces
nodetype: leaf (rw)
type: boolean
default: false
description:
Operational state data global DHCPv4
nodetype: container (ro)
description:
Enables DHCP/BOOTP relay agent on all interfaces
nodetype: leaf (ro)
type: boolean
default: false
description:
Top-level container for relay agent information option
data
nodetype: container (rw)
description:
Configuration data for the relay agent information
option
nodetype: container (rw)
description:
Enable sending the DHCP option for Relay Agent information
-- option 82.
nodetype: leaf (rw)
type: boolean
default: false
description:
Operational state data for agent information at global
level
nodetype: container (ro)
description:
Enable sending the DHCP option for Relay Agent information
-- option 82.
nodetype: leaf (ro)
type: boolean
default: false
description:
Enclosing container for the list of interface references.
nodetype: container (rw)
description:
List of interfaces on which the relay agent is
configured.
The interface referenced is based on the interface and
subinterface leaves within the interface-ref container -
which reference an entry in the /interfaces/interface list -
and should not rely on the value of the list key.
nodetype: list (rw)
list keys: [id]
description:
Reference to the interface list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for relay agent interfaces.
nodetype: container (rw)
description:
Name of the interface on which relay agent is active
nodetype: leaf (rw)
type: oc-if:interface-id
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
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
description:
Operational state data for relay agent interfaces.
nodetype: container (ro)
description:
Name of the interface on which relay agent is active
nodetype: leaf (ro)
type: oc-if:interface-id
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
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
description:
Counters and statistics for relay agent operation.
nodetype: container (ro)
description:
Total number of DHCP packets dropped by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCP packets dropped due to an invalid opcode
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCP packets dropped due to an invalid option
nodetype: leaf (ro)
type: yang:counter64
description:
BOOTREQUEST messages received by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
DHCP DECLINE messages received by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
DHCP DISCOVER messages received by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
DHCP INFORM messages received by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
DHCP RELEASE messages received by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
DHCP REQUEST messages received by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
BOOTREQUEST messages forwarded by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
BOOTREPLY messages forwarded by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
DHCP OFFER messages sent by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
DHCP ACK messages sent by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
DHCP NACK messages sent by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Reference to an interface or subinterface. The interface
that is being referenced is uniquely referenced based on
the specified interface and subinterface leaves. In contexts
where a Layer 3 interface is to be referenced, both the
interface and subinterface leaves must be populated, as
Layer 3 configuration within the OpenConfig models is
associated with a subinterface. In the case where a
Layer 2 interface is to be referenced, only the
interface is specified.
The interface/subinterface leaf tuple must be used as
the means by which the interface is specified, regardless
of any other context information (e.g., key in a list).
nodetype: container (rw)
description:
Configured reference to interface / subinterface
nodetype: container (rw)
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
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
description:
Operational state for interface-ref
nodetype: container (ro)
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
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
description:
Top-level container for relay agent information option
data
nodetype: container (rw)
description:
Configuration data for the relay agent information
option
nodetype: container (rw)
description:
Enable sending the DHCP option for Relay Agent information
-- option 82.
nodetype: leaf (rw)
type: boolean
default: false
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
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
description:
Operational state data
nodetype: container (ro)
description:
Enable sending the DHCP option for Relay Agent information
-- option 82.
nodetype: leaf (ro)
type: boolean
default: false
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
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
description:
Reports the circuit-id sent by the system to the DHCP
server.
nodetype: leaf (ro)
type: string
description:
Reports the remote-id value sent by the system to the DHCP
server
nodetype: leaf (ro)
type: string
description:
Top-level container for global relay agent data
nodetype: container (rw)
description:
Configuration data for global DHCPv6
nodetype: container (rw)
description:
Enables DHCP/BOOTP relay agent on all interfaces
nodetype: leaf (rw)
type: boolean
default: false
description:
Operational state data global DHCPv6
nodetype: container (ro)
description:
Enables DHCP/BOOTP relay agent on all interfaces
nodetype: leaf (ro)
type: boolean
default: false
description:
Top-level container for DHCPv6 agent options on interfaces
nodetype: container (rw)
description:
Configuration data
nodetype: container (rw)
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
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
description:
Operational state data for DHCPv6 agent option on an
interface
nodetype: container (ro)
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
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
description:
Enclosing container for the list of interface references.
nodetype: container (rw)
description:
List of interfaces on which the relay agent is
configured.
The interface referenced is based on the interface and
subinterface leaves within the interface-ref container -
which reference an entry in the /interfaces/interface list -
and should not rely on the value of the list key.
nodetype: list (rw)
list keys: [id]
description:
Reference to the interface list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for relay agent interfaces.
nodetype: container (rw)
description:
Name of the interface on which relay agent is active
nodetype: leaf (rw)
type: oc-if:interface-id
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
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
description:
Operational state data for relay agent interfaces.
nodetype: container (ro)
description:
Name of the interface on which relay agent is active
nodetype: leaf (ro)
type: oc-if:interface-id
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
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
description:
Counters and statistics for relay agent operation.
nodetype: container (ro)
description:
Total number of DHCP packets dropped by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCP packets dropped due to an invalid opcode
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCP packets dropped due to an invalid option
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 SOLICIT messages received from clients
by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 DECLINE messages received from
clients by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 request messages received from clients
by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 release messages received from clients
by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 confirm messages received from clients
by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 rebind messages received from clients
by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 information requests messages received from
clients by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 relay reply messages received from servers
by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 adverstise messages sent to clients by
the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 reply messages sent to clients by
the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 reconfigure messages sent to clients by
the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Number of DHCPv6 relay-forward messages sent to servers
by the relay agent
nodetype: leaf (ro)
type: yang:counter64
description:
Reference to an interface or subinterface. The interface
that is being referenced is uniquely referenced based on
the specified interface and subinterface leaves. In contexts
where a Layer 3 interface is to be referenced, both the
interface and subinterface leaves must be populated, as
Layer 3 configuration within the OpenConfig models is
associated with a subinterface. In the case where a
Layer 2 interface is to be referenced, only the
interface is specified.
The interface/subinterface leaf tuple must be used as
the means by which the interface is specified, regardless
of any other context information (e.g., key in a list).
nodetype: container (rw)
description:
Configured reference to interface / subinterface
nodetype: container (rw)
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
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
description:
Operational state for interface-ref
nodetype: container (ro)
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
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
description:
Top-level container for DHCPv6 agent options on interfaces
nodetype: container (rw)
description:
Configuration data
nodetype: container (rw)
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
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
description:
Sets DHCPv6 OPTION_INTERFACE_ID (18) to identify the
interface on which the client message was received.
nodetype: leaf (rw)
type: string
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
description:
Operational state data for DHCPv6 agent option on an
interface
nodetype: container (ro)
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
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
description:
Sets DHCPv6 OPTION_INTERFACE_ID (18) to identify the
interface on which the client message was received.
nodetype: leaf (ro)
type: string
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
description:
Reflects the DHCPv6 OPTION_INTERFACE_ID (18) sent to the
server by the system.
nodetype: leaf (ro)
type: string
description:
Reflects the DHCPv6 OPTION_REMOTE_ID (37) sent to the
server by the system.
nodetype: leaf (ro)
type: string