dhcp-server

AsterNOS YANG Model for dhcp server.

YANG Tree Diagram

module: asternos-dhcp-server
  +--rw dhcp-server
     +--rw class* [name]
     |  +--rw name            string
     |  +--rw rule* [id]
     |  |  +--rw id              uint8
     |  |  +--rw option          enumeration
     |  |  +--rw option-value    string
     |  +--rw option-group?   uint16
     +--rw failover
     |  +--rw max-response-delay-time?   uint16
     |  +--rw local-address?             union
     |  +--rw peer-address?              inet:ipv4-address-no-zone
     |  +--rw role?                      enumeration
     +--rw option-group* [id]
     |  +--rw id                             uint16
     |  +--rw bootfile-name?                 string
     |  +--rw capwap-ac-address?             inet:ipv4-address-no-zone
     |  +--rw vendor-specific-information?   string
     |  +--rw default-gateway?               inet:ipv4-address-no-zone
     |  +--rw tftp-server?                   string
     +--rw v4-pool* [name]
     |  +--rw name                           string
     |  +--rw network?                       inet:ipv4-prefix
     |  +--rw start-ip?                      inet:ipv4-address-no-zone
     |  +--rw end-ip?                        inet:ipv4-address-no-zone
     |  +--rw domain-name-server*            inet:ipv4-address-no-zone
     |  +--rw bootfile-name?                 string
     |  +--rw capwap-ac-address?             inet:ipv4-address-no-zone
     |  +--rw vendor-specific-information?   string
     |  +--rw default-gateway?               inet:ipv4-address-no-zone
     |  +--rw tftp-server?                   string
     |  +--rw default-lease-time?            uint32
     |  +--rw max-lease-time?                uint32
     |  +--rw vlan?                          cmn:vlan-name
     |  +--rw next-server?                   inet:ipv4-address-no-zone
     |  +--rw class* [class-name]
     |  |  +--rw class-name    string
     |  |  +--rw start-ip?     inet:ipv4-address-no-zone
     |  |  +--rw end-ip?       inet:ipv4-address-no-zone
     |  +--rw server-identifier?             union
     +--rw v6-pool* [name]
     |  +--rw name                  string
     |  +--rw network?              inet:ipv6-prefix
     |  +--rw start-ip?             inet:ipv6-address-no-zone
     |  +--rw end-ip?               inet:ipv6-address-no-zone
     |  +--rw domain-name-server*   inet:ipv6-address-no-zone
     |  +--rw default-lease-time?   uint32
     |  +--rw max-lease-time?       uint32
     |  +--rw vlan?                 cmn:vlan-name
     +--rw interfaces* [name]
        +--rw name       union
        +--rw enabled?   boolean

  rpcs:
    +---x show-dhcp-pool-info
    |  +---w input
    |  |  +---w version?   enumeration
    |  +--ro output
    |     +--ro data?   string
    +---x show-dhcp-pool-ip-in-use
       +---w input
       |  +---w version?   enumeration
       |  +---w address?   inet:ip-address-no-zone
       +--ro output
          +--ro data?   string

Resources

Resource List

Path	Access
/dhcp-server	Read-Write
/dhcp-server/class	Read-Write
/dhcp-server/class/name	Read-Write
/dhcp-server/class/rule	Read-Write
/dhcp-server/class/rule/id	Read-Write
/dhcp-server/class/rule/option	Read-Write
/dhcp-server/class/rule/option-value	Read-Write
/dhcp-server/class/option-group	Read-Write
/dhcp-server/failover	Read-Write
/dhcp-server/failover/max-response-delay-time	Read-Write
/dhcp-server/failover/local-address	Read-Write
/dhcp-server/failover/peer-address	Read-Write
/dhcp-server/failover/role	Read-Write
/dhcp-server/option-group	Read-Write
/dhcp-server/option-group/id	Read-Write
/dhcp-server/option-group/bootfile-name	Read-Write
/dhcp-server/option-group/capwap-ac-address	Read-Write
/dhcp-server/option-group/vendor-specific-information	Read-Write
/dhcp-server/option-group/default-gateway	Read-Write
/dhcp-server/option-group/tftp-server	Read-Write
/dhcp-server/v4-pool	Read-Write
/dhcp-server/v4-pool/name	Read-Write
/dhcp-server/v4-pool/network	Read-Write
/dhcp-server/v4-pool/start-ip	Read-Write
/dhcp-server/v4-pool/end-ip	Read-Write
/dhcp-server/v4-pool/domain-name-server	Read-Write
/dhcp-server/v4-pool/bootfile-name	Read-Write
/dhcp-server/v4-pool/capwap-ac-address	Read-Write
/dhcp-server/v4-pool/vendor-specific-information	Read-Write
/dhcp-server/v4-pool/default-gateway	Read-Write
/dhcp-server/v4-pool/tftp-server	Read-Write
/dhcp-server/v4-pool/default-lease-time	Read-Write
/dhcp-server/v4-pool/max-lease-time	Read-Write
/dhcp-server/v4-pool/vlan	Read-Write
/dhcp-server/v4-pool/next-server	Read-Write
/dhcp-server/v4-pool/class	Read-Write
/dhcp-server/v4-pool/class/class-name	Read-Write
/dhcp-server/v4-pool/class/start-ip	Read-Write
/dhcp-server/v4-pool/class/end-ip	Read-Write
/dhcp-server/v4-pool/server-identifier	Read-Write
/dhcp-server/v6-pool	Read-Write
/dhcp-server/v6-pool/name	Read-Write
/dhcp-server/v6-pool/network	Read-Write
/dhcp-server/v6-pool/start-ip	Read-Write
/dhcp-server/v6-pool/end-ip	Read-Write
/dhcp-server/v6-pool/domain-name-server	Read-Write
/dhcp-server/v6-pool/default-lease-time	Read-Write
/dhcp-server/v6-pool/max-lease-time	Read-Write
/dhcp-server/v6-pool/vlan	Read-Write
/dhcp-server/interfaces	Read-Write
/dhcp-server/interfaces/name	Read-Write
/dhcp-server/interfaces/enabled	Read-Write

Detailed Nodes

/dhcp-server

Path

/dhcp-server

Node Type

container

Access

Read-Write

/dhcp-server/class

Path

/dhcp-server/class

Node Type

list

Description

class of dhcp server

Access

Read-Write

/dhcp-server/class/name

Path

/dhcp-server/class/name

Node Type

leaf

Access

Read-Write

Data Type

/dhcp-server/class/rule

Path

/dhcp-server/class/rule

Node Type

list

Access

Read-Write

/dhcp-server/class/rule/id

Path

/dhcp-server/class/rule/id

Node Type

leaf

Description

DHCP server class rule id.

Access

Read-Write

Data Type

Constraints

Valid range: 1 to 16

/dhcp-server/class/rule/option

Path

/dhcp-server/class/rule/option

Node Type

leaf

Description

Some option fields in the DHCP protocol.

Access

Read-Write

Data Type

Constraints

Enumeration with options: circuit-id / remote-id / pxe-system-type

Mandatory

Yes

/dhcp-server/class/rule/option-value

Path

/dhcp-server/class/rule/option-value

Node Type

leaf

Description

The value of option in the DHCP protocol.

Access

Read-Write

Data Type

Mandatory

Yes

/dhcp-server/class/option-group

Path

/dhcp-server/class/option-group

Node Type

leaf

Description

Class-bound option-group.

Access

Read-Write

Data Type

/dhcp-server/failover

Path

/dhcp-server/failover

Node Type

container

Access

Read-Write

/dhcp-server/failover/max-response-delay-time

Path

/dhcp-server/failover/max-response-delay-time

Node Type

leaf

Description

The maximum time the current server waits for a response from the peer server

Access

Read-Write

Data Type

Constraints

Valid range: 30 to 3600

/dhcp-server/failover/local-address

Path

/dhcp-server/failover/local-address

Node Type

leaf

Description

The address of local.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/failover/peer-address

Path

/dhcp-server/failover/peer-address

Node Type

leaf

Description

The IP address of peer.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/failover/role

Path

/dhcp-server/failover/role

Node Type

leaf

Description

The current server role

Access

Read-Write

Data Type

Constraints

Enumeration with options: primary / secondary

/dhcp-server/option-group

Path

/dhcp-server/option-group

Node Type

list

Access

Read-Write

/dhcp-server/option-group/id

Path

/dhcp-server/option-group/id

Node Type

leaf

Description

ID of DHCP option group

Access

Read-Write

Data Type

Constraints

Valid range: 1 to 65535

/dhcp-server/option-group/bootfile-name

Path

/dhcp-server/option-group/bootfile-name

Node Type

leaf

Description

The location of the boot file used by the client to start the system.

Access

Read-Write

Data Type

/dhcp-server/option-group/capwap-ac-address

Path

/dhcp-server/option-group/capwap-ac-address

Node Type

leaf

Description

IP address of ac.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/option-group/vendor-specific-information

Path

/dhcp-server/option-group/vendor-specific-information

Node Type

leaf

Description

The value of option43 is usually in hexadecimal. The format is TLV, Type 1 byte, Length 1 byte, value 1-251 bytes.

Access

Read-Write

Data Type

/dhcp-server/option-group/default-gateway

Path

/dhcp-server/option-group/default-gateway

Node Type

leaf

Description

Specify the IP address of the default gateway.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index.This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/option-group/tftp-server

Path

/dhcp-server/option-group/tftp-server

Node Type

leaf

Description

Specify the IP address or domain name of the tftp server.

Access

Read-Write

Data Type

/dhcp-server/v4-pool

Path

/dhcp-server/v4-pool

Node Type

list

Access

Read-Write

/dhcp-server/v4-pool/name

Path

/dhcp-server/v4-pool/name

Node Type

leaf

Description

dhcp pool name

Access

Read-Write

Data Type

/dhcp-server/v4-pool/network

Path

/dhcp-server/v4-pool/network

Node Type

leaf

Description

Specify the network segment of the DHCP pool.

Access

Read-Write

Data Type

Constraints

The ipv4-prefix type represents an IPv4 prefix. The prefix length is given by the number following the slash character and must be less than or equal to 32. A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0. The canonical format of an IPv4 prefix has all bits of the IPv4 address set to zero that are not part of the IPv4 prefix. The definition of ipv4-prefix does not require that bits, which are not part of the prefix, are set to zero. However, implementations have to return values in canonical format, which requires non-prefix bits to be set to zero. This means that 192.0.2.1/24 must be accepted as a valid value but it will be converted into the canonical format 192.0.2.0/24.

/dhcp-server/v4-pool/start-ip

Path

/dhcp-server/v4-pool/start-ip

Node Type

leaf

Description

Specify the starting IP address of the DHCP pool.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v4-pool/end-ip

Path

/dhcp-server/v4-pool/end-ip

Node Type

leaf

Description

Specify the end IP address of the DHCP pool.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v4-pool/domain-name-server

Path

/dhcp-server/v4-pool/domain-name-server

Node Type

leaf-list

Description

IP address of DNS server.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v4-pool/bootfile-name

Path

/dhcp-server/v4-pool/bootfile-name

Node Type

leaf

Description

The location of the boot file used by the client to start the system.

Access

Read-Write

Data Type

/dhcp-server/v4-pool/capwap-ac-address

Path

/dhcp-server/v4-pool/capwap-ac-address

Node Type

leaf

Description

IP address of ac.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v4-pool/vendor-specific-information

Path

/dhcp-server/v4-pool/vendor-specific-information

Node Type

leaf

Description

The value of option43 is usually in hexadecimal. The format is TLV, Type 1 byte, Length 1 byte, value 1-251 bytes.

Access

Read-Write

Data Type

/dhcp-server/v4-pool/default-gateway

Path

/dhcp-server/v4-pool/default-gateway

Node Type

leaf

Description

Specify the IP address of the default gateway.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v4-pool/tftp-server

Path

/dhcp-server/v4-pool/tftp-server

Node Type

leaf

Description

Specify the IP address or domain name of the tftp server.

Access

Read-Write

Data Type

/dhcp-server/v4-pool/default-lease-time

Path

/dhcp-server/v4-pool/default-lease-time

Node Type

leaf

Description

Default lease time.

Access

Read-Write

Data Type

Constraints

Valid range: 30 to 100000000

/dhcp-server/v4-pool/max-lease-time

Path

/dhcp-server/v4-pool/max-lease-time

Node Type

leaf

Description

Maximum lease time.

Access

Read-Write

Data Type

Constraints

Valid range: 30 to 100000000

/dhcp-server/v4-pool/vlan

Path

/dhcp-server/v4-pool/vlan

Node Type

leaf

Description

Bind this VLAN to dhcp pool.

Access

Read-Write

Data Type

/dhcp-server/v4-pool/next-server

Path

/dhcp-server/v4-pool/next-server

Node Type

leaf

Description

IP address of tftp server

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v4-pool/class

Path

/dhcp-server/v4-pool/class

Node Type

list

Description

Class bound to dhcp pool

Access

Read-Write

/dhcp-server/v4-pool/class/class-name

Path

/dhcp-server/v4-pool/class/class-name

Node Type

leaf

Description

The bound class name.

Access

Read-Write

Data Type

/dhcp-server/v4-pool/class/start-ip

Path

/dhcp-server/v4-pool/class/start-ip

Node Type

leaf

Description

Set the rules in this class to apply to the starting IP address of the IP segment.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v4-pool/class/end-ip

Path

/dhcp-server/v4-pool/class/end-ip

Node Type

leaf

Description

Set the rules in this class to apply to the end IP address of the IP segment.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v4-pool/server-identifier

Path

/dhcp-server/v4-pool/server-identifier

Node Type

leaf

Description

The address of server identifier.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v6-pool

Path

/dhcp-server/v6-pool

Node Type

list

Access

Read-Write

/dhcp-server/v6-pool/name

Path

/dhcp-server/v6-pool/name

Node Type

leaf

Description

dhcp pool name

Access

Read-Write

Data Type

/dhcp-server/v6-pool/network

Path

/dhcp-server/v6-pool/network

Node Type

leaf

Description

Specify the network segment of the DHCP pool v6.

Access

Read-Write

Data Type

Constraints

The ipv6-prefix type represents an IPv6 prefix. The prefix length is given by the number following the slash character and must be less than or equal to 128. A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0. The canonical format of an IPv6 prefix has all bits of the IPv6 address set to zero that are not part of the IPv6 prefix. Furthermore, the IPv6 address is represented as defined in Section 4 of RFC 5952. The definition of ipv6-prefix does not require that bits, which are not part of the prefix, are set to zero. However, implementations have to return values in canonical format, which requires non-prefix bits to be set to zero. This means that 2001:db8::1/64 must be accepted as a valid value but it will be converted into the canonical format 2001:db8::/64.

/dhcp-server/v6-pool/start-ip

Path

/dhcp-server/v6-pool/start-ip

Node Type

leaf

Description

Specify the starting IPv6 address of the DHCP pool v6.

Access

Read-Write

Data Type

Constraints

An IPv6 address without a zone index. This type, derived from the type ipv6-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v6-pool/end-ip

Path

/dhcp-server/v6-pool/end-ip

Node Type

leaf

Description

Specify the end IPv6 address of the DHCP pool v6.

Access

Read-Write

Data Type

Constraints

An IPv6 address without a zone index. This type, derived from the type ipv6-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v6-pool/domain-name-server

Path

/dhcp-server/v6-pool/domain-name-server

Node Type

leaf-list

Description

IP address of DNS server.

Access

Read-Write

Data Type

Constraints

An IPv6 address without a zone index. This type, derived from the type ipv6-address, may be used in situations where the zone is known from the context and no zone index is needed.

/dhcp-server/v6-pool/default-lease-time

Path

/dhcp-server/v6-pool/default-lease-time

Node Type

leaf

Description

Default lease time.

Access

Read-Write

Data Type

Constraints

Valid range: 30 to 100000000

/dhcp-server/v6-pool/max-lease-time

Path

/dhcp-server/v6-pool/max-lease-time

Node Type

leaf

Description

Maximum lease time.

Access

Read-Write

Data Type

Constraints

Valid range: 30 to 100000000

/dhcp-server/v6-pool/vlan

Path

/dhcp-server/v6-pool/vlan

Node Type

leaf

Description

Bind this VLAN to dhcp pool.

Access

Read-Write

Data Type

/dhcp-server/interfaces

Path

/dhcp-server/interfaces

Node Type

list

Description

List of interfaces enabled to the DHCP pool

Access

Read-Write

/dhcp-server/interfaces/name

Path

/dhcp-server/interfaces/name

Node Type

leaf

Description

The interface name

Access

Read-Write

Data Type

/dhcp-server/interfaces/enabled

Path

/dhcp-server/interfaces/enabled

Node Type

leaf

Access

Read-Write

Data Type

Constraints

Valid in [true, false]