A roaming host is a specific host that a DHCP server always assigns when a lease request comes from a particular MAC address of the client.
References to roaminghost are object references.
The name part of the roaming host object reference has the following components:
- Name of the roaming host
- Name of the network view
Example: roaminghost/ZG5zLmJpbmRfY25h:somerhost/external
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): address_type, name, network_view.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| dhcp_client_identifier | See the field description for more information |
| ipv6_duid | See the field description for more information |
| mac | See the field description for more information |
| match_client | See the field description for more information |
| name |
The address type for this roaming host.
Type
String.
Create
The default value is IPV4.
Search
The field is available for search via
Notes
The address_type is part of the base object.
The bootfile name for the roaming host. You can configure the DHCP server to support clients that use the boot file name option in their DHCPREQUEST messages.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
bootfile is associated with the field use_bootfile (see use flag).
The boot server address for the roaming host. You can specify the name and/or IP address of the boot server that the host needs to boot.
The boot server IPv4 Address or name in FQDN format.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
bootserver is associated with the field use_bootserver (see use flag).
This field controls whether there is a prepend for the dhcp-client-identifier of a roaming host.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Comment for the roaming host; 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
The DDNS domain name for this roaming host.
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 not available for search.
Notes
ddns_domainname is associated with the field use_ddns_domainname (see use flag).
The DDNS host name for this roaming host.
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 not available for search.
If set to true, BOOTP settings are disabled and BOOTP requests will be denied.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
deny_bootp is associated with the field use_deny_bootp (see use flag).
The DHCP client ID for the roaming host.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required only when match_client is set to CLIENT_ID.
Search
The field is available for search via
Determines whether a roaming host is disabled or not. When this is set to False, the roaming host is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The dynamic DNS updates flag of the roaming host object. If set to True, the DHCP server sends DDNS updates to DNS servers in the same Grid, and to external DNS servers.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_ddns is associated with the field use_enable_ddns (see use flag).
Set this to True if you want the DHCP server to use a different lease time for PXE clients.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
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.
Set this to True to use the roaming host name as its ddns_hostname.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
If this field is set to False, the appliance returns all the DHCP options the client is eligible to receive, rather than only the list of options the client has requested.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ignore_dhcp_option_list_request is associated with the field use_ignore_dhcp_option_list_request (see use flag).
The client hostname of a DHCP roaming host object. This field specifies the host name that the DHCP client sends to the Infoblox appliance using DHCP option 12.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is not available for search.
Notes
The ipv6_client_hostname cannot be updated.
ipv6_client_hostname cannot be written.
The IPv6 DDNS domain name for this roaming host.
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 not available for search.
Notes
ipv6_ddns_domainname is associated with the field use_ipv6_ddns_domainname (see use flag).
The IPv6 DDNS host name for this roaming host.
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 not available for search.
The IPv6 domain name for this roaming host.
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 not available for search.
Notes
ipv6_domain_name is associated with the field use_ipv6_domain_name (see use flag).
The IPv6 addresses of DNS recursive name servers to which the DHCP client can send name resolution requests. The DHCP server includes this information in the DNS Recursive Name Server option in Advertise, Rebind, Information-Request, and Reply messages.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
ipv6_domain_name_servers is associated with the field use_ipv6_domain_name_servers (see use flag).
The DUID value for this roaming host.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required only when ipv6_match_option is set to DUID.
Search
The field is available for search via
Set this to True to enable IPv6 DDNS.
Type
Bool.
Values with leading or trailing white space are not valid for this field.
Create
The default value is False.
Search
The field is not available for search.
Notes
ipv6_enable_ddns is associated with the field use_ipv6_enable_ddns (see use flag).
Set this to True to use the roaming host name as its ddns_hostname.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The identification method for an IPv6 or mixed IPv4/IPv6 roaming host. Currently, the only supported value for this field is “DUID”, which corresponds to identification by DHCPv6 unique ID.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
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:
[ { 'name': 'dhcp-lease-time',
'num': 51,
'use_option': False,
'value': '43200',
'vendor_class': 'DHCP'}]
Search
The field is not available for search.
Notes
ipv6_options is associated with the field use_ipv6_options (see use flag).
If set on creation, the roaming host will be created according to the values specified in the named IPv6 roaming host template.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
The ipv6_template cannot be updated.
ipv6_template is not readable.
The MAC address for this roaming host.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required only when match_client is set to its default value - MAC_ADDRESS.
Search
The field is available for search via
The match-client value for this roaming host. Valid values are:
“MAC_ADDRESS”: The fixed IP address is leased to the matching MAC address.
“CLIENT_ID”: The fixed IP address is leased to the matching DHCP client identifier.
Type
String.
Create
The field is required only when address_type is set to “ipv4” or “both”.
Search
The field is available for search via
The name of this roaming host.
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 name of the network view in which this roaming host resides.
Type
String.
Create
The default value is The default network view.
Search
The field is available for search via
Notes
The network_view is part of the base object.
The name in FQDN and/or IPv4 Address format 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.
Notes
nextserver is associated with the field use_nextserver (see use flag).
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:
[ { 'name': 'dhcp-lease-time',
'num': 51,
'use_option': False,
'value': '43200',
'vendor_class': 'DHCP'}]
Search
The field is not available for search.
Notes
options is associated with the field use_options (see use flag).
The preferred lifetime value for this roaming host object.
Type
Unsigned integer.
Create
The default value is 27000.
Search
The field is not available for search.
Notes
preferred_lifetime is associated with the field use_preferred_lifetime (see use flag).
The PXE lease time value for this roaming host object. Some hosts use PXE (Preboot Execution Environment) to boot remotely from a server. To better manage your IP resources, set a different lease time for PXE boot requests. You can configure the DHCP server to allocate an IP address with a shorter lease time to hosts that send PXE boot requests, so IP addresses are not leased longer than necessary.
A 32-bit unsigned integer that represents the duration, in seconds, for which the update is cached. Zero indicates that the update is not cached.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
Notes
pxe_lease_time is associated with the field use_pxe_lease_time (see use flag).
If set on creation, the roaming host will be created according to the values specified in the named template.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
The template cannot be updated.
template is not readable.
Use flag for: bootfile
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: bootserver
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_domainname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: deny_bootp
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_ddns
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ignore_dhcp_option_list_request
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_ddns_domainname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_domain_name
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_domain_name_servers
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_enable_ddns
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ipv6_options
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: nextserver
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: options
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: preferred_lifetime
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: pxe_lease_time
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: valid_lifetime
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The valid lifetime value for this roaming host object.
Type
Unsigned integer.
Create
The default value is 43200.
Search
The field is not available for search.
Notes
valid_lifetime is associated with the field use_valid_lifetime (see use flag).
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| address_type | String | N | N | Y | = |
| bootfile | String | N | N | N | N/A |
| bootserver | String | N | N | N | N/A |
| client_identifier_prepend_zero | Bool | N | N | N | N/A |
| comment | String | N | N | N | : = ~ |
| ddns_domainname | String | N | N | N | N/A |
| ddns_hostname | String | N | N | N | N/A |
| deny_bootp | Bool | N | N | N | N/A |
| dhcp_client_identifier | String | Y* | N | N | : = ~ |
| disable | Bool | N | N | N | N/A |
| enable_ddns | Bool | N | N | N | N/A |
| enable_pxe_lease_time | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| force_roaming_hostname | Bool | N | N | N | N/A |
| ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| ipv6_client_hostname | String | N | Y | N | N/A |
| ipv6_ddns_domainname | String | N | N | N | N/A |
| ipv6_ddns_hostname | String | N | N | N | N/A |
| ipv6_domain_name | String | N | N | N | N/A |
| ipv6_domain_name_servers | [String] | N | N | N | N/A |
| ipv6_duid | String | Y* | N | N | : = ~ |
| ipv6_enable_ddns | Bool | N | N | N | N/A |
| ipv6_force_roaming_hostname | Bool | N | N | N | N/A |
| ipv6_match_option | String | N | N | N | = |
| ipv6_options | [struct] | N | N | N | N/A |
| ipv6_template | String | N | N | N | N/A |
| mac | String | Y* | N | N | : = ~ |
| match_client | String | Y* | N | N | = |
| name | String | Y | N | Y | : = ~ |
| network_view | String | N | N | Y | = |
| nextserver | String | N | N | N | N/A |
| options | [struct] | N | N | N | N/A |
| preferred_lifetime | Unsigned int | N | N | N | N/A |
| pxe_lease_time | Unsigned int | N | N | N | N/A |
| template | String | N | N | N | N/A |
| use_bootfile | Bool | N | N | N | N/A |
| use_bootserver | Bool | N | N | N | N/A |
| use_ddns_domainname | Bool | N | N | N | N/A |
| use_deny_bootp | Bool | N | N | N | N/A |
| use_enable_ddns | Bool | N | N | N | N/A |
| use_ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| use_ipv6_ddns_domainname | Bool | N | N | N | N/A |
| use_ipv6_domain_name | Bool | N | N | N | N/A |
| use_ipv6_domain_name_servers | Bool | N | N | N | N/A |
| use_ipv6_enable_ddns | Bool | N | N | N | N/A |
| use_ipv6_options | Bool | N | N | N | N/A |
| use_nextserver | Bool | N | N | N | N/A |
| use_options | Bool | N | N | N | N/A |
| use_preferred_lifetime | Bool | N | N | N | N/A |
| use_pxe_lease_time | Bool | N | N | N | N/A |
| use_valid_lifetime | Bool | N | N | N | N/A |
| valid_lifetime | Unsigned int | N | N | N | N/A |
* Required in some cases, see detailed field description above.
rir:organization : Regional Internet Registry organization object.