filternac : DHCP NAC Filter object.

If NAC authentication is configured, the appliance receives authentication responses from NAC authentication servers, and it grants or denies a lease request if the authentication response matches conditions defined by the NAC filters.

Only superuser can add/modify/delete NAC filters.

Object Reference

References to filternac are object references. The name part of a DHCP NAC Filter object reference has the following components:

  • Name of DHCP NAC Filter object

Example: filternac/SW5mb2Jsb3ggQXBwbGlhbmNl:filter1

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  

comment

comment

The descriptive comment of a DHCP NAC Filter 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 NAC Filter 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

The length of time the DHCP server leases an IP address to a client. The lease time applies to hosts that meet the filter criteria.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

name

name

The name of a DHCP NAC 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.

options

options

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.

Fields List

Field Type Req R/O Base Search
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 : = ~
options [struct] N N N N/A