< Home

Data Model

The data model files matching DHCP server are huawei-dhcp.yang and huawei-address-management.yang.

Table 1 huawei-dhcp.yang data model

Object

Description

Value Range

Remarks

/huawei-dhcp:dhcp-config/dhcpv4-config/enable

Indicates whether DHCP is enabled.

The value is of the Boolean type:
  • true: DHCP is enabled.
  • false: DHCP is disabled.
The default value is false.

NA

/huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/enable

Indicates whether the DHCP server function is enabled.

The value is of the Boolean type:
  • true: The DHCP server function is enabled.
  • false: The DHCP server function is disabled.
The default value is false.

NA

/huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/user-defined-options/user-defined-option/option-code

Indicates the value of a user-defined option.

The value is an integer in the range from 1 to 254, except the values 1, 3, 6, 15, 44, 46, 50, 51, 52, 53, 54, 55, 57, 58, 59, 61, 82, 120, 121, and 184.

NA

/huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/user-defined-options/user-defined-option

Indicates the type of a user-defined option:
  • ip-address: IP address
  • ascii-string: ASCII character string
  • cipher-string: ciphertext character string
  • hex-string: hexadecimal character string
  • ip-address: The value is in dotted decimal notation.
  • ascii-string: The value is a string of 1 to 255 characters.
  • cipher-string: The value is a string of 1 to 64 plaintext characters or 32 to 104 ciphertext characters.
  • hex-string: The value is a hexadecimal string with an even number (in the range of 2 to 254) of characters, for example, hh or hhhh. The value can contain a combination of digits 0 to 9, uppercase letters A to F, and lowercase letters a to f.

NA

/huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/logging/type

Enables the logging function during IP address allocation of the DHCP server.

The value is an enumerated type. The value is renew-success, indicating that a log is generated when an address lease is successfully renewed.

NA

/huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/ip-range/ip-subnet

Indicates the range of the IP addresses allocated by the DHCP server to DHCP clients. The object includes:

  • start-ip-address: specifies the start IP address.
  • end-ip-address: specifies the end IP address.
  • start-ip-address: The start IP address is in dotted decimal notation.
  • end-ip-address: The end IP address is in dotted decimal notation.

NA

huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/mask/mask/ip-prefix/ip-prefix

Specifies the subnet mask of the IP address allocated to a DHCP client.

The value is in dotted decimal notation.

NA

huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/mask/mask/length/length

Specifies the subnet mask of the IP address allocated to a DHCP client.

The value is an integer in the range from 0 to 32.

NA

huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/conflict-recycle

Enables automatic reclaim of conflicting IP addresses and sets the interval for automatic reclaim. The object includes:

  • day: specifies the automatic reclaim interval, in days.
  • hour: specifies the automatic reclaim interval, in hours.
  • minute: specifies the automatic reclaim interval, in minutes.
  • day: The value is an integer in the range from 0 to 999, in days. The default value is 0.
  • hour: The value is an integer in the range from 0 to 23, in hours. The default value is 0.
  • minute: The value is an integer in the range from 0 to 59, in minutes. The default value is 0.

NA

/huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/gateway

Configures the default gateway address allocated by the DHCP server to DHCP clients.

The value is in dotted decimal notation.

NA

huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/sip-server

Configures the SIP server IP address allocated by the DHCP server to DHCP clients.

The value is in dotted decimal notation.

NA

huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/boot-file

Configures the name of the configuration file allocated by the DHCP server to DHCP clients.

The value is a string of 1 to 127 case-sensitive characters without spaces.

NA

huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/next-server

Specifies the network server IP address that is allocated by the DHCP server to DHCP clients and to be used during startup.

The value is in dotted decimal notation.

NA

huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/pool-type/interface-pool/interface-pool/option121

Configures the Option 121 (classless static route) that the DHCP server allocates to DHCP clients.

The value is in dotted decimal notation.

NA

/huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/global-configuration/ping

Configures the maximum number of ping packets sent by the DHCP server and the maximum response time of a ping packet. The object includes:

  • packet-number: indicates the maximum number of ping packets to be sent.
  • interval: indicates the maximum response time of a ping packet.
  • packet-number: The value is an integer in the range from 0 to 10. The value 0 indicates that no ping operation is performed.
  • interval: The value is an integer in the range from 0 to 10000, in milliseconds. The value 0 indicates that no ping operation is performed.

NA

/huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/global-configuration/database

Indicates whether the function of saving the current DHCP data to a storage device is enabled. The object includes:

  • enable: indicates that the function of saving the current DHCP data to a storage device is enabled.
  • recover: indicates that DHCP data is restored from a storage device.
  • write-delay: specifies the interval at which DHCP data is saved.
  • enable: This value can be set only to true.
  • recover: –
  • write-delay: The value is an integer in the range from 300 to 86400, in seconds. The default value is 7200s.

NA

/huawei-dhcp:dhcp-config/dhcpv4-config/dhcp-server-configuration/dhcp-servers/dhcp-server/enable

Indicates whether an interface is configured to use the global address pool.

The value is of the Boolean type:
  • true: indicates that an interface is configured to use a global address pool.
  • false: indicates that an interface is not configured to use a global address pool.
The default value is false.

NA

Table 2 huawei-address-management.yang data model

Object

Description

Value Range

Remarks

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/name

Indicates the name of a global address pool.

The value is a string of 1 to 64 characters without spaces. It can contain digits, letters, and special characters such as underscores (_), hyphens (-), and periods (.). It cannot be set to - or --.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/network

Indicates the available network segment addresses in a global address pool. The object includes:
  • ip-address: specifies the network address segment.
  • mask: specifies the network mask.
  • mask-length: specifies the network mask length.
  • ip-address: The value is in dotted decimal notation.
  • mask: The value is in dotted decimal notation.
  • mask-length: The value is an integer in the range from 1 to 32.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/lease

Configures the lease time of IP addresses in a global address pool. The object includes:
  • unlimited: indicates that the lease is not limited.
  • lease-time: specifies the lease time, which consists of day, hour, and minute.
  • unlimited: -
  • day: The value is an integer in the range from 0 to 999, in days. The default value is 1.
  • hour: The value is an integer in the range from 0 to 23, in hours. The default value is 0.
  • minute: The value is an integer in the range from 0 to 59, in minutes. The default value is 0.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/excluded-address/ip-subnet

Indicates the IP addresses that cannot be allocated to DHCP clients from a global address pool. The object includes:
  • start-ip-address: specifies the start IP address.
  • end-ip-address: specifies the end IP address.
  • start-ip-address: The value is in dotted decimal notation.
  • end-ip-address: The value is in dotted decimal notation.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/static-binding/address-binding

Configures statically bound IP addresses in a global address pool. The object includes:
  • ip-address: specifies a bound IP address.
  • mac-address: specifies a user MAC address.
  • ip-address: The value is in dotted decimal notation.
  • mac-address: The value is in H-H-H format. An H is a hexadecimal number of 1 to 4 digits.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/gateway

Configures the gateway address allocated to DHCP clients.

The value is in dotted decimal notation.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/dns/dns-server/ip-address

Configures the DNS server IP address allocated to DHCP clients.

The value is in dotted decimal notation.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/user-defined-options

Configures user-defined options.

-

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/section

Configures an IP address segment in a global address pool. The object includes:
  • section-id: specifies the ID of an IP address segment.
  • start-address: specifies the start IP address.
  • end-address: specifies the end IP address.
  • section-id: The value is an integer in the range from 0 to 255.
  • start-address: The value is in dotted decimal notation.
  • end-address: The value is in dotted decimal notation.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/conflict-recycle

Enables automatic reclaim of conflicting IP addresses in a global address pool and sets the automatic reclaim interval. The object includes:
  • day: specifies the automatic reclaim interval, in days.
  • hour: specifies the automatic reclaim interval, in hours.
  • minute: specifies the automatic reclaim interval, in minutes.
  • day: The value is an integer in the range from 0 to 999, in days. The default value is 0.
  • hour: The value is an integer in the range from 0 to 23, in hours. The default value is 0.
  • minute: The value is an integer in the range from 0 to 59, in minutes. The default value is 0.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/logging/log-type

Enables the logging function during IP address allocation of the DHCP server.

The value is an enumerated type:

  • allocation-fail: A log is displayed when address allocation fails.
  • allocation-success: A log is displayed when address allocation succeeds.
  • release: A log is displayed when addresses are released.
  • renew-fail: A log is displayed when an address lease renewal fails.
  • renew-success: A log is displayed when an address lease renewal succeeds.
  • detect-conflict: A log is displayed when an address conflict occurs.
  • recycle-conflict: A log is displayed when conflicting addresses are reclaimed.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/boot-file

Configures the name of the startup configuration file for DHCP clients.

The value is a string of 1 to 127 case-sensitive characters without spaces.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/sip-server

Configures the SIP server IP address or domain name allocated to DHCP clients. The object includes:
  • ip-address: specifies a SIP server IP address.
  • domain-name: specifies a SIP server domain name.
  • ip-address: The value is in dotted decimal notation.
  • domain-name: The value is a string of 1 to 63 characters.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/sname

Configures the name of the server from which DHCP clients obtain the startup configuration file.

The value is a string of 1 to 63 case-sensitive characters without spaces.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/next-server

Configures a server IP address for a DHCP client after the client automatically obtains an IP address.

The value is in dotted decimal notation.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/option121

Configures a classless static route for DHCP clients. The object includes:

  • destination-ip: specifies the destination IP address and mask.
  • gateway-address: specifies the gateway IP address.
  • destination-ip: The value is an integer in the range from 0 to 32 or is in dotted decimal notation.
  • gateway-address: The value is in dotted decimal notation.

NA

/huawei-address-management:address-management/ipv4/ip-pools/ip-pool/option184

Configures the Option 184. The object includes:
  • ncp-ip: specifies the IP address of the network call processor (NCP).
  • as-ip: specifies the IP address of the backup NCP.
  • fail-over: specifies the IP address (ip-address) and dialer string (dialer-string) of a failover route.
  • voice-vlan: specifies the ID of a voice VLAN.
  • ncp-ip: The value is in dotted decimal notation.
  • as-ip: The value is in dotted decimal notation.
  • ip-address: The value is in dotted decimal notation.
  • dialer-string: The value is a string of 1 to 64 characters.
  • voice-vlan: The value is an integer in the range from 1 to 4094.

NA

/huawei-address-management:address-management-v4-statistics-table/ip-pool-statistics

Displays statistics about IPv4 address pools. The object includes:

  • pool-name: specifies the name of an IP address pool. The IP address pool may be a global address pool or an interface address pool. If this parameter is not specified, statistics about all address pools are displayed.
  • request-from: displays statistics with a specified entry index.
  • request-num: specifies the number of displayed statistics records.

-

NA

/huawei-address-management:address-management-v4-bindings-table/dynamic-bindings

Displays information about allocated addresses in an IPv4 address pool. The object includes:

  • pool-name: specifies the name of an IP address pool. The IP address pool may be a global address pool or an interface address pool. If this parameter is not specified, information about all allocated addresses is displayed.
  • ip-section: displays information about allocated IP addresses within a specified IP address range in an address pool.
  • request-from: displays information about allocated IP addresses with a specified entry index.
  • request-num: specifies the number of displayed allocated address records.

-

NA

Copyright © Huawei Technologies Co., Ltd.
Copyright © Huawei Technologies Co., Ltd.
Next topic >