NETCONF Configuration Guide
YANG API Reference
dhcp-server
69 min
module description 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 description no description available 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 description no description available access read write data type /dhcp server/class/rule path /dhcp server/class/rule node type list description no description available 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 constraints valid range /dhcp server/failover path /dhcp server/failover node type container description no description available 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 description no description available 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 description no description available 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 description no description available 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 description no description available access read write data type constraints valid in \[true, false] rpcs show dhcp pool info path access /show dhcp pool info/input read write /show dhcp pool info/input/version read write /show dhcp pool info/output read write /show dhcp pool info/output/data read write /show dhcp pool info/input path /show dhcp pool info/input node type container description no description available access read write /show dhcp pool info/input/version path /show dhcp pool info/input/version node type leaf description the family of the pool access read write data type constraints enumeration with options v4 v6 /show dhcp pool info/output path /show dhcp pool info/output node type container description no description available access read write /show dhcp pool info/output/data path /show dhcp pool info/output/data node type leaf description no description available access read write data type show dhcp pool ip in use path access /show dhcp pool ip in use/input read write /show dhcp pool ip in use/input/version read write /show dhcp pool ip in use/input/address read write /show dhcp pool ip in use/output read write /show dhcp pool ip in use/output/data read write /show dhcp pool ip in use/input path /show dhcp pool ip in use/input node type container description no description available access read write /show dhcp pool ip in use/input/version path /show dhcp pool ip in use/input/version node type leaf description the family of the pool access read write data type constraints enumeration with options v4 v6 /show dhcp pool ip in use/input/address path /show dhcp pool ip in use/input/address node type leaf description no description available access read write data type constraints multiple 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 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 /show dhcp pool ip in use/output path /show dhcp pool ip in use/output node type container description no description available access read write /show dhcp pool ip in use/output/data path /show dhcp pool ip in use/output/data node type leaf description no description available access read write data type
