filtermac : DHCP MAC Address Filter object.

An Infoblox appliance can filter address requests by the MAC address and/or vendor prefix (i.e., the first 6 hexadecimal characters of the MAC address) of a requesting host. The filter instructs the appliance to either grant or deny an address request if the requesting host matches the filter.

Object Reference

References to filtermac are object references. The name part of a DHCP MAC Address Filter object reference has the following components:

  • Name of DHCP MAC Address Filter object.

Example: filtermac/SW5mb2Jsb3ggQXBwbGlhbmNl:filter1

Restrictions

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 MAC 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.

default_mac_address_expiration

default_mac_address_expiration

The default MAC expiration time of the DHCP MAC Address Filter object.

By default, the MAC address filter never expires; otherwise, it is the absolute interval when the MAC address filter expires. The maximum value can extend up to 4294967295 secs. The minimum value is 60 secs (1 min).

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

disable

disable

Determines if the DHCP Fingerprint object is disabled or not.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enforce_expiration_times

enforce_expiration_times

The flag to enforce MAC address expiration of the DHCP MAC Address Filter object.

Type

Bool.

Create

The default value is True.

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 MAC 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.

never_expires

never_expires

Determines if DHCP MAC Filter never expires or automatically expires.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

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.

reserved_for_infoblox

reserved_for_infoblox

This is reserved for writing comments related to the particular MAC address filter. The length of comment cannot exceed 1024 bytes.

Type

String.

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 : = ~
default_mac_address_expiration Unsigned int N N N N/A
disable Bool N N N N/A
enforce_expiration_times Bool 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 : = ~
never_expires Bool N N N N/A
options [struct] N N N N/A
reserved_for_infoblox String N N N N/A