Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

header

type

description

required

encoding

sample

object_headers

HEADER-ipamdhcp-v2-fixedaddress*

string

The primary identifier of the header stating the type of object.

TRUE

string

key*

string

The primary identifier of an individual object.
For Fixed Address, a combination of space and address is used as the key.
Example: ipspace,10.0.0.1

TRUE

string

name

string

The name of the fixed address. May contain 1 to 256 characters. May include UTF-8.

FALSE

string

comment

string

The description of the fixed address. May contain 0 to 1024 characters. May include UTF-8.

FALSE

string

ip_space*

string

The IP space that the address exists in.

TRUE

string

address*

string

The reserved address.

TRUE

string

match_type*

string

Indicates how to match the client:

  • mac: match the client MAC address for both IPv4 and IPv6

  • client_text or client_hex: match the client identifier for IPv4 only

  • relay_text or relay_hex: match the circuit ID or remote ID in the DHCP relay agent option (82) for IPv4 only

  • duid: match the DHCP unique identifier; currentl,y match only for IPv6

TRUE

string

match_value*

string

The value to match.

TRUE

string

dhcp_options

arraystring

The list of DHCP options. May be either a specific option or a group of options.

FALSE

nios

dhcp_options_type

dhcp_options_group

dhcp_options_code

dhcp_options_valueexpanddhcp

tags

string

The tags for the fixed address, in JSON format.

FALSE

expandtags

hostname

string

The DHCP host name associated with this fixed address. It is of the FQDN type, and it defaults to empty.

FALSE

string

dhcp_options_action

string

The inheritance setting for dhcp_options.
Valid values:

  • "inherit": Use the inherited value.
    ”block_”: Do not use the inherited value.

The default value is "inherit".

FALSE

string

inherit

dhcp_options_value

array

The configuration of inheritance for a field of type OptionItem.

FALSE

nios

dhcp_options_value_action

fiin_header_option_server_address_action

string

The configuration of inheritance for the header_option_server_address field.

FALSE

string

inherit

fiin_header_option_server_name_action

string

The configuration of inheritance for the header_option_server_name field.

FALSE

string

inherit

fiin_header_option_filename_action

string

The configuration of inheritance for the header_option_filename field.

FALSE

string

inherit

header_option_server_address

string

The configuration for the header_option_server_address field.

FALSE

string

header_option_server_name

string

The configuration for the header_option_server_name field.

FALSE

string

header_option_filename

string

The configuration for the header_option_filename field.

FALSE

string