macfilteraddress : MAC Filter Address object.

MAC filter address is part of the MAC filter.

Object Reference

References to macfilteraddress are object references. The name part of a macfilteraddress object reference has the following components:

  • MAC Address
  • Name of the MAC filter to which this address belongs

Example: macfilteraddress/ZG5OjQ0OjU1OjY2:11%3A22%3A33%3A44%3A55%3A66/macf1

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): authentication_time, comment, expiration_time, filter, guest_custom_field1, guest_custom_field2, guest_custom_field3, guest_custom_field4, guest_email, guest_first_name, guest_last_name, guest_middle_name, guest_phone, is_registered_user, mac, never_expires, reserved_for_infoblox, username.

The following fields are required to create this object:

Field Notes
filter  
mac  

authentication_time

authentication_time

The absolute UNIX time (in seconds) since the address was last authenticated.

Type

Timestamp.

Create

The default value is empty.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

The authentication_time is part of the base object.

comment

comment

Comment for the MAC filter address; maximum 256 characters.

Type

String.

Values with leading or trailing white space are not valid for this field.

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.

expiration_time

expiration_time

The absolute UNIX time (in seconds) until the address expires.

Type

Timestamp.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

The expiration_time is part of the base object.

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.

filter

filter

Name of the MAC filter to which this address belongs.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The filter is part of the base object.

fingerprint

fingerprint

DHCP fingerprint for the address.

Type

String.

Search

The field is available for search via

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

Notes

The fingerprint cannot be updated.

fingerprint cannot be written.

guest_custom_field1

guest_custom_field1

Guest custom field 1.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The guest_custom_field1 is part of the base object.

guest_custom_field2

guest_custom_field2

Guest custom field 2.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The guest_custom_field2 is part of the base object.

guest_custom_field3

guest_custom_field3

Guest custom field 3.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The guest_custom_field3 is part of the base object.

guest_custom_field4

guest_custom_field4

Guest custom field 4.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The guest_custom_field4 is part of the base object.

guest_email

guest_email

Guest e-mail.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The guest_email is part of the base object.

guest_first_name

guest_first_name

Guest first name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The guest_first_name is part of the base object.

guest_last_name

guest_last_name

Guest last name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The guest_last_name is part of the base object.

guest_middle_name

guest_middle_name

Guest middle name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The guest_middle_name is part of the base object.

guest_phone

guest_phone

Guest phone number.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The guest_phone is part of the base object.

is_registered_user

is_registered_user

Determines if the user has been authenticated or not.

Type

Bool.

Search

The field is not available for search.

Notes

The is_registered_user is part of the base object.

The is_registered_user cannot be updated.

is_registered_user cannot be written.

mac

mac

MAC Address.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The mac is part of the base object.

never_expires

never_expires

Determines if MAC address expiration is enabled or disabled.

Type

Bool.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The never_expires is part of the base object.

reserved_for_infoblox

reserved_for_infoblox

Reserved for future use.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The reserved_for_infoblox is part of the base object.

username

username

Username for authenticated DHCP purposes.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

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

Notes

The username is part of the base object.

Fields List

Field Type Req R/O Base Search
authentication_time Timestamp N N Y ! < = >
comment String N N Y : = ~
expiration_time Timestamp N N Y ! < = >
extattrs Extattr N N N ext
filter String Y N Y = ~
fingerprint String N Y N : = ~
guest_custom_field1 String N N Y : = ~
guest_custom_field2 String N N Y : = ~
guest_custom_field3 String N N Y : = ~
guest_custom_field4 String N N Y : = ~
guest_email String N N Y : = ~
guest_first_name String N N Y : = ~
guest_last_name String N N Y : = ~
guest_middle_name String N N Y : = ~
guest_phone String N N Y : = ~
is_registered_user Bool N Y Y N/A
mac String Y N Y = ~
never_expires Bool N N Y =
reserved_for_infoblox String N N Y : = ~
username String N N Y : = ~