Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Mandatory parameters are denoted by an * (asterisk).

header

type

description

required

encoding

sample

object_headers

key

string

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

TRUE

string

name

string

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

FALSE

string

comment

string

The description for the fixed address. May contain 0 to 1024 characters. Can 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, currently match only for IPv6 protocol.

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 FQDN type and it defaults to empty.

FALSE

string

dhcp_options_action

string

The inheritance setting for dhcp_options.
Valid values are:
inherit: Use the inherited value.
block_: Don't use the inherited value.
Defaults to inherit.

FALSE

string

inherit

dhcp_options_value

array

The inheritance configuration for a field of type of OptionItem.

FALSE

nios

dhcp_options_value_action

fiin_header_option_server_address_action

string

The inheritance configuration for header_option_server_address field.

FALSE

string

inherit

fiin_header_option_server_name_action

string

The inheritance configuration for header_option_server_name field.

FALSE

string

inherit

fiin_header_option_filename_action

string

The inheritance configuration for header_option_filename field.

FALSE

string

inherit

header_option_server_address

string

The configuration for header option server address field.

FALSE

string

header_option_server_name

string

The configuration for header option server name field.

FALSE

string

header_option_filename

string

The configuration for header option filename field.

FALSE

string

  • No labels