The fixed address template used to create a fixed address objects in a quick and consistent way. Fixed address object created from a fixed address template will inherit most properties defined in fixed address template object so most of the fixed address template properties are the same as the fixed address object properties.
References to fixedaddresstemplate are object references.
The name part of a DHCP Fixed Address template object reference has the following components:
- Name of the fixed address template
Example: fixedaddresstemplate/ZG5zLmJpbmRfY25h:template_name
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 |
|---|---|
| name |
The boot file name for the fixed address. 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 fixed address. 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).
A descriptive comment of a fixed address template object.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Notes
The comment is part of the base object.
The dynamic DNS domain name the appliance uses specifically for DDNS updates for this fixed address.
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 fixed address.
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.
Determines if 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).
Determines if 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.
If this field is set to False, the appliance returns all 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).
This field contains the logic filters to be applied on this fixed address.
This list corresponds to the match rules that are written to the dhcpd configuration file.
Type
A/An Logic Filter rule struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
logic_filter_rules is associated with the field use_logic_filter_rules (see use flag).
The name of a fixed address template 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 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).
The number of addresses for this fixed address.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
The start address offset for this fixed address.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
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 PXE lease time value for a DHCP Fixed Address 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).
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: logic_filter_rules
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.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| bootfile | String | N | N | N | N/A |
| bootserver | String | N | N | N | N/A |
| comment | String | N | N | Y | : = ~ |
| ddns_domainname | String | N | N | N | N/A |
| ddns_hostname | String | N | N | N | N/A |
| deny_bootp | 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 |
| ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| logic_filter_rules | [struct] | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| nextserver | String | N | N | N | N/A |
| number_of_addresses | Unsigned int | N | N | N | N/A |
| offset | Unsigned int | N | N | N | N/A |
| options | [struct] | N | N | N | N/A |
| pxe_lease_time | Unsigned int | 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_logic_filter_rules | Bool | N | N | N | N/A |
| use_nextserver | Bool | N | N | N | N/A |
| use_options | Bool | N | N | N | N/A |
| use_pxe_lease_time | Bool | N | N | N | N/A |
fixedaddress : DHCP Fixed Address object.