filteroption : DHCP filter option object.

In the ISC DHCP terms, it defines a class of clients that match a particular (option, value) pair. To define an option filter, add Option to the DHCP Filter object.

Only superuser can add/modify/delete option filters.

Object Reference

References to filteroption are object references.

The name part of the filteroption object reference has the following components:

• Name of the Filter Option object

Example: filteroption/ZG5zLm5ldHdvcmtfdmlldyQxMTk:default

Restrictions

The object does not support the following operations:

• Permissions

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): comment, name.

The following fields are required to create this object:

Field	Notes
name

apply_as_class

apply_as_class

Determines if apply as class is enabled or not. If this flag is set to “true” the filter is treated as global DHCP class, e.g it is written to dhcpd config file even if it is not present in any DHCP range.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

bootfile

bootfile

A name of boot file of a DHCP filter option object.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

bootserver

bootserver

Determines the boot server of a DHCP filter option object. You can specify the name and/or IP address of the boot server that host needs to boot.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

comment

comment

The descriptive comment of a DHCP filter option object.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The comment is part of the base object.

expression

expression

The conditional expression of a DHCP filter option object.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

extattrs

extattrs

Extensible attributes associated with the object.

For valid values for extensible attributes, see the following information.

Type

Extensible attributes.

This field allows +/- to be specified as part of the field name when updating the object, see the following information.

Create

The default value is empty.

Search

For how to search extensible attributes, see the following information.

lease_time

lease_time

Determines the lease time of a DHCP filter option object.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

name

name

The name of a DHCP option filter object.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The name is part of the base object.

next_server

next_server

Determines the next server of a DHCP filter option object. You can specify the name and/or IP address of the next server that the host needs to boot.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

option_list

option_list

An array of DHCP option structs that lists the DHCP options associated with the object.

Type

A/An DHCP option struct array.

Create

The default value is:

empty

Search

The field is not available for search.

option_space

option_space

The option space of a DHCP filter option object.

Type

String.

Create

The default value is DHCP.

Search

The field is not available for search.

pxe_lease_time

pxe_lease_time

Determines the PXE (Preboot Execution Environment) lease time of a DHCP filter option object. To specify the duration of time it takes a host to connect to a boot server, such as a TFTP server, and download the file it needs to boot.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

Fields List

Field	Type	Req	R/O	Base	Search
apply_as_class	Bool	N	N	N	N/A
bootfile	String	N	N	N	N/A
bootserver	String	N	N	N	N/A
comment	String	N	N	Y	: = ~
expression	String	N	N	N	N/A
extattrs	Extattr	N	N	N	ext
lease_time	Unsigned int	N	N	N	N/A
name	String	Y	N	Y	: = ~
next_server	String	N	N	N	N/A
option_list	[struct]	N	N	N	N/A
option_space	String	N	N	N	N/A
pxe_lease_time	Unsigned int	N	N	N	N/A