The Infoblox appliance can screen address requests through relay agent filters (DHCP option 82) that assist the agents in forwarding address assignments across the proper circuit. When a relay agent receives the DHCPDISCOVER message, it can add one or two agent IDs in the DHCP option 82 suboption fields to the message. If the agent ID strings match those defined in a relay agent filter applied to a DHCP address range, the Infoblox appliance either assigns addresses from that range or denies the request (based on previously configured parameters; that is, the Grant lease and Deny lease parameters).
References to filterrelayagent are object references.
The name part of the filterrelayagent object reference has the following components:
- The name of a DHCP relay agent filter object.
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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 |
|---|---|
| circuit_id_name | See the field description for more information |
| circuit_id_substring_length | See the field description for more information |
| circuit_id_substring_offset | See the field description for more information |
| is_circuit_id | See the field description for more information |
| is_circuit_id_substring | See the field description for more information |
| is_remote_id | See the field description for more information |
| is_remote_id_substring | See the field description for more information |
| name | |
| remote_id_name | See the field description for more information |
| remote_id_substring_length | See the field description for more information |
| remote_id_substring_offset | See the field description for more information |
The circuit_id_name of a DHCP relay agent filter object. This filter identifies the circuit between the remote host and the relay agent. For example, the identifier can be the ingress interface number of the circuit access unit, perhaps concatenated with the unit ID number and slot number. Also, the circuit ID can be an ATM virtual circuit ID or cable data virtual circuit ID.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
You must specify circuit_id_name when is_circuit_id is set to “MATCHES_VALUE”.
Search
The field is not available for search.
The circuit ID substring length.
Type
Unsigned integer.
Create
You must specify the circuit ID substring length when is_circuit_id_substring is set to true.
Search
The field is not available for search.
The circuit ID substring offset.
Type
Unsigned integer.
Create
You must specify the circuit ID substring offset when is_circuit_id_substring is set to true.
Search
The field is not available for search.
A descriptive comment of a DHCP relay agent filter object.
Type
String.
Create
The default value is undefined.
Search
The field is available for search via
Notes
The comment is part of the base object.
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.
The circuit ID matching rule of a DHCP relay agent filter object. The circuit_id value takes effect only if the value is “MATCHES_VALUE”.
Type
String.
Create
You must specify a value for is_circuit_id or is_remote_id if the value is not set to “ANY”.
Search
The field is not available for search.
Determines if the substring of circuit ID, instead of the full circuit ID, is matched.
Type
Bool.
Create
You must specify is_circuit_id_substring when is_circuit_id is set to “MATCHES_VALUE”.
Search
The field is not available for search.
The remote ID matching rule of a DHCP relay agent filter object. The remote_id value takes effect only if the value is Matches_Value.
Type
String.
Create
You must specify a value for is_circuit_id or is_remote_id if the value is not set to “ANY”.
Search
The field is not available for search.
Determines if the substring of remote ID, instead of the full remote ID, is matched.
Type
Bool.
Create
You must specify is_remote_id_substring when is_remote_id is set to “MATCHES_VALUE”.
Search
The field is not available for search.
The name of a DHCP relay agent filter object.
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
Notes
The name is part of the base object.
The remote ID name attribute of a relay agent filter object. This filter identifies the remote host. The remote ID name can represent many different things such as the caller ID telephone number for a dial-up connection, a user name for logging in to the ISP, a modem ID, etc. When the remote ID name is defined on the relay agent, the DHCP server will have a trusted relationship to identify the remote host. The remote ID name is considered as a trusted identifier.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
You must specify the remote id name when is_remote_id is set to “MATCHES_VALUE”.
Search
The field is not available for search.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| circuit_id_name | String | Y* | N | N | N/A |
| circuit_id_substring_length | Unsigned int | Y* | N | N | N/A |
| circuit_id_substring_offset | Unsigned int | Y* | N | N | N/A |
| comment | String | N | N | Y | : = ~ |
| extattrs | Extattr | N | N | N | ext |
| is_circuit_id | String | Y* | N | N | N/A |
| is_circuit_id_substring | Bool | Y* | N | N | N/A |
| is_remote_id | String | Y* | N | N | N/A |
| is_remote_id_substring | Bool | Y* | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| remote_id_name | String | Y* | N | N | N/A |
| remote_id_substring_length | Unsigned int | Y* | N | N | N/A |
| remote_id_substring_offset | Unsigned int | Y* | N | N | N/A |
* Required in some cases, see detailed field description above.
filteroption : DHCP filter option object.
