range : DHCP Range object.

A DHCP range defines the specified range of IP addresses in a network. A DHCP range should be added for a network so the Infoblox appliance can assign IP addresses within that specified range to DHCP clients. If the client is on a network that is assigned a DHCP range, the device distributes an available IP address from that range to the DHCP client, or to a DHCP relay agent if the request came through an agent. The DHCP range should also be assigned with a device. If devices are in a grid, the particular member serving DHCP for the DHCP range must be specified. If the server is an independent device, this device must be specified as the member that serves the DHCP range.

Object Reference

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

  • Start address of the range
  • End address of the range
  • Name of the view

Example: range/ZG5zLmJpbmRfY25h:12.0.10.0/12.0.30.0/external

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, end_addr, network, network_view, start_addr.

The following fields are required to create this object:

Field Notes
end_addr  
start_addr  

always_update_dns

always_update_dns

This field controls whether only the DHCP server is allowed to update DNS, regardless of the DHCP clients requests.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

bootfile

bootfile

The bootfile name for the range. 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).

bootserver

bootserver

The bootserver address for the range. 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).

cloud_info

cloud_info

Structure containing all cloud API related information for this object.

Type

A/An Cloud Information struct.

Create

The default value is empty.

Search

The field is not available for search.

comment

comment

Comment for the range; 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.

ddns_domainname

ddns_domainname

The dynamic DNS domain name the appliance uses specifically for DDNS updates for this range.

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

ddns_generate_hostname

ddns_generate_hostname

If this field is set to True, the DHCP server generates a hostname and updates DNS with it when the DHCP client request does not contain a hostname.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

ddns_generate_hostname is associated with the field use_ddns_generate_hostname (see use flag).

deny_all_clients

deny_all_clients

If True, send NAK forcing the client to take the new address.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

deny_bootp

deny_bootp

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

dhcp_utilization

dhcp_utilization

The percentage of the total DHCP utilization of the range multiplied by 1000. This is the percentage of the total number of available IP addresses belonging to the range versus the total number of all IP addresses in the range.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The dhcp_utilization cannot be updated.

dhcp_utilization cannot be written.

dhcp_utilization_status

dhcp_utilization_status

A string describing the utilization level of the range.

Type

String.

Valid values are:
  • FULL
  • HIGH
  • LOW
  • NORMAL

Search

The field is not available for search.

Notes

The dhcp_utilization_status cannot be updated.

dhcp_utilization_status cannot be written.

disable

disable

Determines whether a range is disabled or not. When this is set to False, the range is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

discover_now_status

discover_now_status

Discover now status for this range.

Type

String.

Valid values are:
  • COMPLETE
  • FAILED
  • NONE
  • PENDING
  • RUNNING

Search

The field is not available for search.

Notes

The discover_now_status cannot be updated.

discover_now_status cannot be written.

discovery_basic_poll_settings

discovery_basic_poll_settings

The discovery basic poll settings for this range.

Type

A/An Basic Poll Settings struct.

Create

The default value is:

  { 'auto_arp_refresh_before_switch_port_polling': True,
'cli_collection': True,
'complete_ping_sweep': False,
'device_profile': False,
'netbios_scanning': False,
'port_scanning': False,
'smart_subnet_ping_sweep': False,
'snmp_collection': True,
'switch_port_data_collection_polling': 'PERIODIC',
'switch_port_data_collection_polling_interval': 3600}

Search

The field is not available for search.

Notes

discovery_basic_poll_settings is associated with the field use_discovery_basic_polling_settings (see use flag).

discovery_blackout_setting

discovery_blackout_setting

The discovery blackout setting for this range.

Type

A/An Blackout Setting struct.

Create

The default value is:

{ 'enable_blackout': False}

Search

The field is not available for search.

Notes

discovery_blackout_setting is associated with the field use_blackout_setting (see use flag).

discovery_member

discovery_member

The member that will run discovery for this range.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

Notes

discovery_member is associated with the field use_enable_discovery (see use flag).

dynamic_hosts

dynamic_hosts

The total number of DHCP leases issued for the range.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The dynamic_hosts cannot be updated.

dynamic_hosts cannot be written.

email_list

email_list

The e-mail lists to which the appliance sends DHCP threshold alarm e-mail messages.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

Notes

email_list is associated with the field use_email_list (see use flag).

enable_ddns

enable_ddns

The dynamic DNS updates flag of a DHCP range 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).

enable_dhcp_thresholds

enable_dhcp_thresholds

Determines if DHCP thresholds are enabled for the range.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

enable_dhcp_thresholds is associated with the field use_enable_dhcp_thresholds (see use flag).

enable_discovery

enable_discovery

Determines whether a discovery is enabled or not for this range. When this is set to False, the discovery for this range is disabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

enable_discovery is associated with the field use_enable_discovery (see use flag).

enable_email_warnings

enable_email_warnings

Determines if DHCP threshold warnings are sent through email.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_ifmap_publishing

enable_ifmap_publishing

Determines if IFMAP publishing is enabled for the range.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

enable_ifmap_publishing is associated with the field use_enable_ifmap_publishing (see use flag).

enable_immediate_discovery

enable_immediate_discovery

Determines if the discovery for the range should be immediately enabled.

Type

Bool.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

enable_immediate_discovery is not readable.

enable_pxe_lease_time

enable_pxe_lease_time

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.

enable_snmp_warnings

enable_snmp_warnings

Determines if DHCP threshold warnings are send through SNMP.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

end_addr

end_addr

The IPv4 Address end address of the range.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

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

Notes

The end_addr is part of the base object.

endpoint_sources

endpoint_sources

The endpoints that provides data for the DHCP Range object.

Type

A/An ciscoise:endpoint object array.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The endpoint_sources cannot be updated.

endpoint_sources cannot be written.

exclude

exclude

These are ranges of IP addresses that the appliance does not use to assign to clients. You can use these exclusion addresses as static IP addresses. They contain the start and end addresses of the exclusion range, and optionally, information about this exclusion range.

Type

A/An Exclusion range struct array.

Create

The default value is:

empty

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.

failover_association

failover_association

The name of the failover association: the server in this failover association will serve the IPv4 range in case the main server is out of service.

server_association_type must be set to ‘FAILOVER’ or ‘FAILOVER_MS’ if you want the failover association specified here to serve the range.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

  • ‘=’ (exact equality)

fingerprint_filter_rules

fingerprint_filter_rules

This field contains the fingerprint filters for this DHCP range.

The appliance uses matching rules in these filters to select the address range from which it assigns a lease.

Type

A/An Filter rule struct array.

Create

The default value is:

empty

Search

The field is not available for search.

high_water_mark

high_water_mark

The percentage of DHCP range usage threshold above which range usage is not expected and may warrant your attention. When the high watermark is reached, the Infoblox appliance generates a syslog message and sends a warning (if enabled).

A number that specifies the percentage of allocated addresses. The range is from 1 to 100.

Type

Unsigned integer.

Create

The default value is 95.

Search

The field is not available for search.

high_water_mark_reset

high_water_mark_reset

The percentage of DHCP range usage below which the corresponding SNMP trap is reset.

A number that specifies the percentage of allocated addresses. The range is from 1 to 100. The high watermark reset value must be lower than the high watermark value.

Type

Unsigned integer.

Create

The default value is 85.

Search

The field is not available for search.

ignore_dhcp_option_list_request

ignore_dhcp_option_list_request

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

ignore_id

ignore_id

Indicates whether the appliance will ignore DHCP client IDs or MAC addresses. Valid values are “NONE”, “CLIENT”, or “MACADDR”. The default is “NONE”.

Type

String.

Valid values are:
  • CLIENT
  • MACADDR
  • NONE

Create

The default value is NONE.

Search

The field is not available for search.

Notes

ignore_id is associated with the field use_ignore_id (see use flag).

ignore_mac_addresses

ignore_mac_addresses

A list of MAC addresses the appliance will ignore.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

is_split_scope

is_split_scope

This field will be ‘true’ if this particular range is part of a split scope.

Type

Bool.

Search

The field is not available for search.

Notes

The is_split_scope cannot be updated.

is_split_scope cannot be written.

known_clients

known_clients

Permission for known clients. This can be ‘Allow’ or ‘Deny’. If set to ‘Deny’ known clients will be denied IP addresses.

Known clients include roaming hosts and clients with fixed addresses or DHCP host entries. Unknown clients include clients that are not roaming hosts and clients that do not have fixed addresses or DHCP host entries.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

Notes

known_clients is associated with the field use_known_clients (see use flag).

lease_scavenge_time

lease_scavenge_time

An integer that specifies the period of time (in seconds) that frees and backs up leases remained in the database before they are automatically deleted. To disable lease scavenging, set the parameter to -1. The minimum positive value must be greater than 86400 seconds (1 day).

Type

Integer.

Create

The default value is -1.

Search

The field is not available for search.

Notes

lease_scavenge_time is associated with the field use_lease_scavenge_time (see use flag).

logic_filter_rules

logic_filter_rules

This field contains the logic filters to be applied to this range.

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

low_water_mark

low_water_mark

The percentage of DHCP range usage below which the Infoblox appliance generates a syslog message and sends a warning (if enabled).

A number that specifies the percentage of allocated addresses. The range is from 1 to 100.

Type

Unsigned integer.

Create

The default value is 0.

Search

The field is not available for search.

low_water_mark_reset

low_water_mark_reset

The percentage of DHCP range usage threshold below which range usage is not expected and may warrant your attention. When the low watermark is crossed, the Infoblox appliance generates a syslog message and sends a warning (if enabled).

A number that specifies the percentage of allocated addresses. The range is from 1 to 100. The low watermark reset value must be higher than the low watermark value.

Type

Unsigned integer.

Create

The default value is 10.

Search

The field is not available for search.

mac_filter_rules

mac_filter_rules

This field contains the MAC filters to be applied to this range.

The appliance uses the matching rules of these filters to select the address range from which it assigns a lease.

Type

A/An Filter rule struct array.

Create

The default value is:

empty

Search

The field is not available for search.

member

member

The member that will provide service for this range.

server_association_type needs to be set to ‘MEMBER’ if you want the server specified here to serve the range. For searching by this field you should use a HTTP method that contains a body (POST or PUT) with Dhcp Member structure and the request should have option _method=GET.

Type

A/An Grid member serving DHCP struct.

Create

The default value is empty.

Search

The field is available for search via

  • ‘=’ (exact equality)

ms_ad_user_data

ms_ad_user_data

The Microsoft Active Directory user related information.

Type

A/An Active Directory User Data struct.

Search

The field is not available for search.

Notes

The ms_ad_user_data cannot be updated.

ms_ad_user_data cannot be written.

ms_options

ms_options

This field contains the Microsoft DHCP options for this range.

Type

A/An Microsoft DHCP Options struct array.

Create

The default value is:

empty

Search

The field is not available for search.

Notes

ms_options is associated with the field use_ms_options (see use flag).

ms_server

ms_server

The Microsoft server that will provide service for this range.

server_association_type needs to be set to ‘MS_SERVER’ if you want the server specified here to serve the range. For searching by this field you should use a HTTP method that contains a body (POST or PUT) with MS DHCP server structure and the request should have option _method=GET.

Type

A/An MS DHCP server struct.

Create

The default value is empty.

Search

The field is available for search via

  • ‘=’ (exact equality)

nac_filter_rules

nac_filter_rules

This field contains the NAC filters to be applied to this range.

The appliance uses the matching rules of these filters to select the address range from which it assigns a lease.

Type

A/An Filter rule struct array.

Create

The default value is:

empty

Search

The field is not available for search.

name

name

This field contains the name of the Microsoft scope.

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.

network

network

The network to which this range belongs, in IPv4 Address/CIDR format.

Type

String.

Create

The default value is undefined.

Search

The field is available for search via

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

Notes

The network is part of the base object.

network_view

network_view

The name of the network view in which this range resides.

Type

String.

Create

The default value is The default network view.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The network_view is part of the base object.

nextserver

nextserver

The name in FQDN and/or IPv4 Address 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).

option_filter_rules

option_filter_rules

This field contains the Option filters to be applied to this range.

The appliance uses the matching rules of these filters to select the address range from which it assigns a lease.

Type

A/An Filter rule struct array.

Create

The default value is:

empty

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:

[ { '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).

port_control_blackout_setting

port_control_blackout_setting

The port control blackout setting for this range.

Type

A/An Blackout Setting struct.

Create

The default value is:

{ 'enable_blackout': False}

Search

The field is not available for search.

Notes

port_control_blackout_setting is associated with the field use_blackout_setting (see use flag).

pxe_lease_time

pxe_lease_time

The PXE lease time value of a DHCP Range 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).

recycle_leases

recycle_leases

If the field is set to True, the leases are kept in the Recycle Bin until one week after expiration. Otherwise, the leases are permanently deleted.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

Notes

recycle_leases is associated with the field use_recycle_leases (see use flag).

relay_agent_filter_rules

relay_agent_filter_rules

This field contains the Relay Agent filters to be applied to this range.

The appliance uses the matching rules of these filters to select the address range from which it assigns a lease.

Type

A/An Filter rule struct array.

Create

The default value is:

empty

Search

The field is not available for search.

restart_if_needed

restart_if_needed

Restarts the member service.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

restart_if_needed is not readable.

same_port_control_discovery_blackout

same_port_control_discovery_blackout

If the field is set to True, the discovery blackout setting will be used for port control blackout setting.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

same_port_control_discovery_blackout is associated with the field use_blackout_setting (see use flag).

server_association_type

server_association_type

The type of server that is going to serve the range.

Type

String.

Valid values are:
  • FAILOVER
  • MEMBER
  • MS_FAILOVER
  • MS_SERVER
  • NONE

Create

The default value is NONE.

Search

The field is available for search via

  • ‘=’ (exact equality)

split_member

split_member

The Microsoft member to which the split scope is assigned. See split_scope_exclusion_percent for more information

Type

A/An MS DHCP server struct.

Create

The default value is empty.

Search

The field is not available for search.

Notes

The split_member cannot be updated.

split_member is not readable.

split_scope_exclusion_percent

split_scope_exclusion_percent

This field controls the percentage used when creating a split scope.

Valid values are numbers between 1 and 99. If the value is 40, it means that the top 40% of the exclusion will be created on the DHCP range assigned to ms_server and the lower 60% of the range will be assigned to DHCP range assigned to split_member

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

The split_scope_exclusion_percent cannot be updated.

split_scope_exclusion_percent is not readable.

start_addr

start_addr

The IPv4 Address starting address of the range.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

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

Notes

The start_addr is part of the base object.

static_hosts

static_hosts

The number of static DHCP addresses configured in the range.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The static_hosts cannot be updated.

static_hosts cannot be written.

subscribe_settings

subscribe_settings

The DHCP Range Cisco ISE subscribe settings.

Type

A/An Cisco ISE subscribe settings struct struct.

Create

The default value is empty.

Search

The field is not available for search.

Notes

subscribe_settings is associated with the field use_subscribe_settings (see use flag).

template

template

If set on creation, the range 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.

total_hosts

total_hosts

The total number of DHCP addresses configured in the range.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The total_hosts cannot be updated.

total_hosts cannot be written.

unknown_clients

unknown_clients

Permission for unknown clients. This can be ‘Allow’ or ‘Deny’. If set to ‘Deny’, unknown clients will be denied IP addresses.

Known clients include roaming hosts and clients with fixed addresses or DHCP host entries. Unknown clients include clients that are not roaming hosts and clients that do not have fixed addresses or DHCP host entries.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

Notes

unknown_clients is associated with the field use_unknown_clients (see use flag).

update_dns_on_lease_renewal

update_dns_on_lease_renewal

This field controls whether the DHCP server updates DNS when a DHCP lease is renewed.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

update_dns_on_lease_renewal is associated with the field use_update_dns_on_lease_renewal (see use flag).

use_blackout_setting

use_blackout_setting

Use flag for: discovery_blackout_setting , port_control_blackout_setting, same_port_control_discovery_blackout

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_bootfile

use_bootfile

Use flag for: bootfile

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_bootserver

use_bootserver

Use flag for: bootserver

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ddns_domainname

use_ddns_domainname

Use flag for: ddns_domainname

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ddns_generate_hostname

use_ddns_generate_hostname

Use flag for: ddns_generate_hostname

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_deny_bootp

use_deny_bootp

Use flag for: deny_bootp

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_discovery_basic_polling_settings

use_discovery_basic_polling_settings

Use flag for: discovery_basic_poll_settings

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_email_list

use_email_list

Use flag for: email_list

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_enable_ddns

use_enable_ddns

Use flag for: enable_ddns

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_enable_dhcp_thresholds

use_enable_dhcp_thresholds

Use flag for: enable_dhcp_thresholds

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_enable_discovery

use_enable_discovery

Use flag for: discovery_member , enable_discovery

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_enable_ifmap_publishing

use_enable_ifmap_publishing

Use flag for: enable_ifmap_publishing

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ignore_dhcp_option_list_request

use_ignore_dhcp_option_list_request

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_ignore_id

use_ignore_id

Use flag for: ignore_id

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_known_clients

use_known_clients

Use flag for: known_clients

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_lease_scavenge_time

use_lease_scavenge_time

Use flag for: lease_scavenge_time

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_logic_filter_rules

use_logic_filter_rules

Use flag for: logic_filter_rules

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ms_options

use_ms_options

Use flag for: ms_options

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_nextserver

use_nextserver

Use flag for: nextserver

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_options

use_options

Use flag for: options

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_pxe_lease_time

use_pxe_lease_time

Use flag for: pxe_lease_time

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_recycle_leases

use_recycle_leases

Use flag for: recycle_leases

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_subscribe_settings

use_subscribe_settings

Use flag for: subscribe_settings

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_unknown_clients

use_unknown_clients

Use flag for: unknown_clients

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_update_dns_on_lease_renewal

use_update_dns_on_lease_renewal

Use flag for: update_dns_on_lease_renewal

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Function Calls

next_available_ip

This function retrieves the next available IP in the range.

This function supports multiple object matches when called as part of an atomic insertion operation.

Input fields

exclude ( String array. ) A list of IP addresses to exclude.

num ( Unsigned integer. ) The number of IP addresses you are requesting.

Output fields

ips ( String array. ) The requested IP addresses.

Fields List

Field Type Req R/O Base Search
always_update_dns Bool N N N N/A
bootfile String N N N N/A
bootserver String N N N N/A
cloud_info struct N N N N/A
comment String N N Y : = ~
ddns_domainname String N N N N/A
ddns_generate_hostname Bool N N N N/A
deny_all_clients Bool N N N N/A
deny_bootp Bool N N N N/A
dhcp_utilization Unsigned int N Y N N/A
dhcp_utilization_status String N Y N N/A
disable Bool N N N N/A
discover_now_status String N Y N N/A
discovery_basic_poll_settings struct N N N N/A
discovery_blackout_setting struct N N N N/A
discovery_member String N N N N/A
dynamic_hosts Unsigned int N Y N N/A
email_list [String] N N N N/A
enable_ddns Bool N N N N/A
enable_dhcp_thresholds Bool N N N N/A
enable_discovery Bool N N N N/A
enable_email_warnings Bool N N N N/A
enable_ifmap_publishing Bool N N N N/A
enable_immediate_discovery Bool N N N N/A
enable_pxe_lease_time Bool N N N N/A
enable_snmp_warnings Bool N N N N/A
end_addr String Y N Y = ~
endpoint_sources [obj] N Y N N/A
exclude [struct] N N N N/A
extattrs Extattr N N N ext
failover_association String N N N =
fingerprint_filter_rules [struct] N N N N/A
high_water_mark Unsigned int N N N N/A
high_water_mark_reset Unsigned int N N N N/A
ignore_dhcp_option_list_request Bool N N N N/A
ignore_id String N N N N/A
ignore_mac_addresses [String] N N N N/A
is_split_scope Bool N Y N N/A
known_clients String N N N N/A
lease_scavenge_time Integer N N N N/A
logic_filter_rules [struct] N N N N/A
low_water_mark Unsigned int N N N N/A
low_water_mark_reset Unsigned int N N N N/A
mac_filter_rules [struct] N N N N/A
member struct N N N =
ms_ad_user_data struct N Y N N/A
ms_options [struct] N N N N/A
ms_server struct N N N =
nac_filter_rules [struct] N N N N/A
name String N N N N/A
network String N N Y = ~
network_view String N N Y =
nextserver String N N N N/A
option_filter_rules [struct] N N N N/A
options [struct] N N N N/A
port_control_blackout_setting struct N N N N/A
pxe_lease_time Unsigned int N N N N/A
recycle_leases Bool N N N N/A
relay_agent_filter_rules [struct] N N N N/A
restart_if_needed Bool N N N N/A
same_port_control_discovery_blackout Bool N N N N/A
server_association_type String N N N =
split_member struct N N N N/A
split_scope_exclusion_percent Unsigned int N N N N/A
start_addr String Y N Y = ~
static_hosts Unsigned int N Y N N/A
subscribe_settings struct N N N N/A
template String N N N N/A
total_hosts Unsigned int N Y N N/A
unknown_clients String N N N N/A
update_dns_on_lease_renewal Bool N N N N/A
use_blackout_setting Bool 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_ddns_generate_hostname Bool N N N N/A
use_deny_bootp Bool N N N N/A
use_discovery_basic_polling_settings Bool N N N N/A
use_email_list Bool N N N N/A
use_enable_ddns Bool N N N N/A
use_enable_dhcp_thresholds Bool N N N N/A
use_enable_discovery Bool N N N N/A
use_enable_ifmap_publishing Bool N N N N/A
use_ignore_dhcp_option_list_request Bool N N N N/A
use_ignore_id Bool N N N N/A
use_known_clients Bool N N N N/A
use_lease_scavenge_time Bool N N N N/A
use_logic_filter_rules Bool N N N N/A
use_ms_options 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
use_recycle_leases Bool N N N N/A
use_subscribe_settings Bool N N N N/A
use_unknown_clients Bool N N N N/A
use_update_dns_on_lease_renewal Bool N N N N/A

Table Of Contents

Previous topic

radius:authservice : The RADIUS authentication service object.

Next topic

rangetemplate : DHCP Range template object.