Mandatory parameters are denoted by an * (asterisk).
header | type | description | required | encoding | sample | object_headers | |||
---|---|---|---|---|---|---|---|---|---|
key* | string | The primary identifier of an individual object. | 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:
| TRUE | string | |||||
match_value* | string | The value to match. | TRUE | string | |||||
dhcp_options | array | 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_value | |
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.
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 |