network : DHCP Network object.

When DHCP services are configured on an appliance, the network that it serves must be defined. After a network is created, you can either create all the subnets individually, or create a parent network that encompasses the subnets.

Object Reference

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

  • Address of the network
  • CIDR of the network
  • Name of the network view

Example: network/5ldHdvcmskMTEuMC4:10.0.0.0/8/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, network, network_view.

The following fields are required to create this object:

Field Notes
network  

authority

authority

Authority for the DHCP network.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

authority is associated with the field use_authority (see use flag).

auto_create_reversezone

auto_create_reversezone

This flag controls whether reverse zones are automatically created when the network is added.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

The auto_create_reversezone cannot be updated.

auto_create_reversezone is not readable.

bootfile

bootfile

The bootfile name for the network. 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 network. 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 network, 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.

conflict_count

conflict_count

The number of conflicts discovered via network discovery.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The conflict_count cannot be updated.

conflict_count cannot be written.

ddns_domainname

ddns_domainname

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

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

ddns_server_always_updates

ddns_server_always_updates

This field controls whether only the DHCP server is allowed to update DNS, regardless of the DHCP clients requests. Note that changes for this field take effect only if ddns_use_option81 is True.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

ddns_ttl

ddns_ttl

The DNS update Time to Live (TTL) value of a DHCP network object.

The TTL is 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 0.

Search

The field is not available for search.

Notes

ddns_ttl is associated with the field use_ddns_ttl (see use flag).

ddns_update_fixed_addresses

ddns_update_fixed_addresses

By default, the DHCP server does not update DNS when it allocates a fixed address to a client. You can configure the DHCP server to update the A and PTR records of a client with a fixed address. When this feature is enabled and the DHCP server adds A and PTR records for a fixed address, the DHCP server never discards the records.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

ddns_update_fixed_addresses is associated with the field use_ddns_update_fixed_addresses (see use flag).

ddns_use_option81

ddns_use_option81

The support for DHCP Option 81 at the network level.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

ddns_use_option81 is associated with the field use_ddns_use_option81 (see use flag).

delete_reason

delete_reason

The reason for deleting the RIR registration request.

Type

String.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

delete_reason is not readable.

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 network multiplied by 1000. This is the percentage of the total number of available IP addresses belonging to the network versus the total number of all IP addresses in network.

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

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 network is disabled or not. When this is set to False, the network 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 network.

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.

discovered_bgp_as

discovered_bgp_as

Number of the discovered BGP AS.

When multiple BGP autonomous systems are discovered in the network, this field displays “Multiple”.

Type

String.

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

Search

The field is available for search via

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

Notes

The discovered_bgp_as cannot be updated.

discovered_bgp_as cannot be written.

discovered_bridge_domain

discovered_bridge_domain

Discovered bridge domain.

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)

discovered_tenant

discovered_tenant

Discovered tenant.

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)

discovered_vlan_id

discovered_vlan_id

The identifier of the discovered VLAN.

When multiple VLANs are discovered in the network, this field displays “Multiple”.

Type

String.

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

Search

The field is available for search via

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

Notes

The discovered_vlan_id cannot be updated.

discovered_vlan_id cannot be written.

discovered_vlan_name

discovered_vlan_name

The name of the discovered VLAN.

When multiple VLANs are discovered in the network, this field displays “Multiple”.

Type

String.

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

Search

The field is available for search via

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

Notes

The discovered_vlan_name cannot be updated.

discovered_vlan_name cannot be written.

discovered_vrf_description

discovered_vrf_description

Description of the discovered VRF.

When multiple VRFs are discovered in the network, this field displays “Multiple”.

Type

String.

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

Search

The field is available for search via

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

Notes

The discovered_vrf_description cannot be updated.

discovered_vrf_description cannot be written.

discovered_vrf_name

discovered_vrf_name

The name of the discovered VRF.

When multiple VRFs are discovered in the network, this field displays “Multiple”.

Type

String.

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

Search

The field is available for search via

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

Notes

The discovered_vrf_name cannot be updated.

discovered_vrf_name cannot be written.

discovered_vrf_rd

discovered_vrf_rd

Route distinguisher of the discovered VRF.

When multiple VRFs are discovered in the network, this field displays “Multiple”.

Type

String.

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

Search

The field is available for search via

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

Notes

The discovered_vrf_rd cannot be updated.

discovered_vrf_rd cannot be written.

discovery_basic_poll_settings

discovery_basic_poll_settings

The discovery basic poll settings for this network.

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

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_engine_type

discovery_engine_type

The network discovery engine type.

Type

String.

Valid values are:
  • NETMRI
  • NETWORK_INSIGHT
  • NONE
  • UNKNOWN
  • VDISCOVERY

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The discovery_engine_type cannot be updated.

discovery_engine_type cannot be written.

discovery_member

discovery_member

The member that will run discovery for this network.

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

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

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 network. When this is set to False, the network discovery 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 network.

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

endpoint_sources

endpoint_sources

The endpoints that provides data for the DHCP Network 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.

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.

high_water_mark

high_water_mark

The percentage of DHCP network usage threshold above which network 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 network 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.

ipam_email_addresses

ipam_email_addresses

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

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

Notes

ipam_email_addresses is associated with the field use_ipam_email_addresses (see use flag).

ipam_threshold_settings

ipam_threshold_settings

The IPAM Threshold settings for this network.

Type

A/An IPAM Threshold Settings struct.

Create

The default value is:

{ 'reset_value': 85, 'trigger_value': 95}

Search

The field is not available for search.

Notes

ipam_threshold_settings is associated with the field use_ipam_threshold_settings (see use flag).

ipam_trap_settings

ipam_trap_settings

The IPAM Trap settings for this network.

Type

A/An IPAM Trap Settings struct.

Create

The default value is:

{ 'enable_email_warnings': False, 'enable_snmp_warnings': True}

Search

The field is not available for search.

Notes

ipam_trap_settings is associated with the field use_ipam_trap_settings (see use flag).

ipv4addr

ipv4addr

The IPv4 Address of the network.

Type

String.

Create

The default value is undefined.

Search

The field is available for search via

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

last_rir_registration_update_sent

last_rir_registration_update_sent

The timestamp when the last RIR registration update was sent.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_rir_registration_update_sent cannot be updated.

last_rir_registration_update_sent cannot be written.

last_rir_registration_update_status

last_rir_registration_update_status

Last RIR registration update status.

Type

String.

Search

The field is not available for search.

Notes

The last_rir_registration_update_status cannot be updated.

last_rir_registration_update_status cannot be written.

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 on the this network.

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 network 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 network usage threshold below which network 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.

members

members

A list of members or Microsoft (r) servers that serve DHCP for this network.

All members in the array must be of the same type. The struct type must be indicated in each element, by setting the “_struct” member to the struct type.

Type

One of the following: MS DHCP server struct, Grid member serving DHCP struct array.

Create

The default value is:

empty

Search

The field is not available for search.

mgm_private

mgm_private

This field controls whether this object is synchronized with the Multi-Grid Master. If this field is set to True, objects are not synchronized.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

mgm_private is associated with the field use_mgm_private (see use flag).

mgm_private_overridable

mgm_private_overridable

This field is assumed to be True unless filled by any conforming objects, such as Network, IPv6 Network, Network Container, IPv6 Network Container, and Network View. This value is set to False if mgm_private is set to True in the parent object.

Type

Bool.

Search

The field is not available for search.

Notes

The mgm_private_overridable cannot be updated.

mgm_private_overridable cannot be written.

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.

netmask

netmask

The netmask of the network in CIDR format.

Type

Unsigned integer.

Create

The default value is undefined.

Search

The field is not available for search.

network

network

The network address in IPv4 Address/CIDR format. For regular expression searches, only the IPv4 Address portion is supported. Searches for the CIDR portion is always an exact match.

For example, both network containers 10.0.0.0/8 and 20.1.0.0/16 are matched by expression ‘.0’ and only 20.1.0.0/16 is matched by ‘.0/16’.

Type

String.

The field also supports automatic selection of the next available network with selected CIDR in the specified network or network container. You can specify the network or network container in the following ways:

Using a network or network container WAPI reference:

  • func:nextavailablenetwork:<reference>,<CIDR>

Using a network lookup (if the view is not specified, the default view will be used):

  • func:nextavailablenetwork:<network>[,<network view>],<CIDR>

Scheduled and approval operations are not supported when using the automatic network selection.

If you specify a network view for automatic network selection, you should also add a network_view field in the object to be inserted with the same network view because the network view for automatic network selection is not used for the actual object insertion.

NOTE: Automatic selection is supported only for JSON and XML requests.

Examples:

  • func:nextavailablenetwork:network/ZG54dfgsrDFEFfsfsLzA:10.0.0.0/8/default,16
  • func:nextavailablenetwork:10.0.0.0/8,16
  • func:nextavailablenetwork:10.0.0.0/8,external,16

This field can also be retrieved from a function call as part of an object insertion. The supported function calls for this field are:

To find out if the function can be called when _object_parameters matches multiple objects, see the function documentation.

The default parameters are passed to the specified function call and can be overridden by passing different values for the same parameter in _parameters.

To execute the function call, a dictionary must be set in this field with the following parameters:

Mandatory Name Comment
Y _object_function The name of the function.
Y _result_field The field in which the function returns its result.
See comment _object The WAPI object type on which the function calls. Either _object or _object_ref must be set.
See comment _object_ref A WAPI object reference on which the function calls. Either _object or _object_ref must be set.
N _parameters The parameters to be passed to the function.
See comment _object_parameters The parameters used for the object search, mandatory if _object is set.

As part of the insertion, the object identified by _object and _object_parameters will be fetched, and the function identified by _object_function will be called with the parameters specified in _parameters. The result of this function will be retrieved and the field of this function specified in _result_field will be extracted and used as the value for this field.

Note that if the function call returns a list, and the field requires a single value, the first value on the list will be used.

The following example uses a value for the ‘next_available_ip’ field in the 9.0.0.0/8 network, excluding IP addresses 9.0.0.1 and 9.0.0.2:

{
    '_object_function': 'next_available_ip',
    '_parameters': {
        'exclude': ['9.0.0.1', '9.0.0.2'],
    },
    '_result_field': 'ips',
    '_object': 'network',
    '_object_parameters': {
        'network': '9.0.0.0/8',
        'network_view': 'newdefaultnv',
    }
}

Note this function call might not be valid for this particular field, this is just an example.

Create

The field is required on creation.

Search

The field is available for search via

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

Notes

The network is part of the base object.

network_container

network_container

The network container to which this network belongs (if any).

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The network_container cannot be updated.

network_container cannot be written.

network_view

network_view

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

Type

String.

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

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.

The network_view cannot be updated.

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

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

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

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.

rir

rir

The registry (RIR) that allocated the network address space.

Type

String.

Valid values are:
  • NONE
  • RIPE

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The rir cannot be updated.

rir cannot be written.

rir_organization

rir_organization

The RIR organization assoicated with the network.

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

  • ‘=’ (exact equality)

rir_registration_action

rir_registration_action

The RIR registration action.

Type

String.

Valid values are:
  • CREATE
  • DELETE
  • MODIFY
  • NONE

Create

The default value is undefined.

Search

The field is not available for search.

Notes

rir_registration_action is not readable.

rir_registration_status

rir_registration_status

The registration status of the network in RIR.

Type

String.

Valid values are:
  • NOT_REGISTERED
  • REGISTERED

Create

The default value is NOT_REGISTERED.

Search

The field is not available for search.

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

send_rir_request

send_rir_request

Determines whether to send the RIR registration request.

Type

Bool.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

send_rir_request is not readable.

static_hosts

static_hosts

The number of static DHCP addresses configured in the network.

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 Network 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 network is created according to the values specified in the selected 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 network.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The total_hosts cannot be updated.

total_hosts cannot be written.

unmanaged

unmanaged

Determines whether the DHCP IPv4 Network is unmanaged or not.

Type

Bool.

Create

The default value is False.

Search

The field is available for search via

  • ‘=’ (exact equality)

unmanaged_count

unmanaged_count

The number of unmanaged IP addresses as discovered by network discovery.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The unmanaged_count cannot be updated.

unmanaged_count cannot be written.

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_authority

use_authority

Use flag for: authority

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

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_ddns_ttl

use_ddns_ttl

Use flag for: ddns_ttl

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ddns_update_fixed_addresses

use_ddns_update_fixed_addresses

Use flag for: ddns_update_fixed_addresses

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ddns_use_option81

use_ddns_use_option81

Use flag for: ddns_use_option81

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_ipam_email_addresses

use_ipam_email_addresses

Use flag for: ipam_email_addresses

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ipam_threshold_settings

use_ipam_threshold_settings

Use flag for: ipam_threshold_settings

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ipam_trap_settings

use_ipam_trap_settings

Use flag for: ipam_trap_settings

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_mgm_private

use_mgm_private

Use flag for: mgm_private

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

use_zone_associations

use_zone_associations

Use flag for: zone_associations

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

utilization

utilization

The network utilization in percentage.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The utilization cannot be updated.

utilization cannot be written.

utilization_update

utilization_update

The timestamp when the utilization statistics were last updated.

Type

Timestamp.

Search

The field is not available for search.

Notes

The utilization_update cannot be updated.

utilization_update cannot be written.

vlans

vlans

List of VLANs assigned to Network.

Type

A/An VLAN link struct array.

Create

The default value is:

empty

Search

The field is not available for search.

zone_associations

zone_associations

The list of zones associated with this network.

Type

A/An Zone association struct array.

Create

The default value is:

empty

Search

The field is not available for search.

Notes

zone_associations is associated with the field use_zone_associations (see use flag).

Function Calls

expand_network

This function reduces the subnet masks of a network by joining all networks that fall under it. All the ranges and fixed addresses of the original networks are reparented to the new joined network. Any network containers that fall inside the bounds of the joined network are removed. The member assignments for all the encompassed networks are joined together. The default router, broadcast address, and subnet mask overrided from the joined network, including the ranges and fixed addresses, are all cleaned up.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

auto_create_reversezone ( Bool. ) Determines whether or not to automatically create reverse-mapping zones.

option_delete_ea ( String. Valid values are: “RETAIN”, “REMOVE” ) The option to be applied on deleted networks with existing extensible attribute.

prefix ( Unsigned integer. ). This parameter is mandatory. The netmask of the networks after the expand operation.

Output fields

network ( String. ) The reference to the resulting network that is created after the expand operation.

next_available_ip

This function retrieves the next available IP in the network.

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.

next_available_network

This function will retrieve the next available network in the network.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

cidr ( Unsigned integer. ) The CIDR of the requested network(s). This is a required parameter.

exclude ( String array. ) An array of networks you want to exclude from the results.

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

Output fields

networks ( String array. ) The requested network(s).

next_available_vlan

This function retrieves the next available VLANs for network to assign by given VLAN View/Range as parent.

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

Input fields

exclude ( String array. ) A list of VLAN IDs to exclude.

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

Output fields

vlans ( A/An vlan object array. ) The requested VLANs. The default value is “[]”.

resize

This function will resize the current network.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

auto_create_reversezone ( Bool. ) Determines whether or not to automatically create reverse-mapping zones.

prefix ( Unsigned integer. ). This parameter is mandatory. The netmask of the network after resizing.

reason ( String. ) The reason for resizing the network.

send_rir_request ( Bool. ) Determines if it is required to send a request to update RIR registration.

Output fields

None

split_network

This function will split the current network into multiple smaller networks.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

add_all_subnetworks ( Bool. ) If this flag is True, then all possible subnets will be added. Otherwise, only networks with fixed addresses will be added.

auto_create_reversezone ( Bool. ) Determines whether or not to automatically create reverse-mapping zones for the subnets.

inherit_attributes ( Bool. ) Determines if extensible attributes from the pre-split network will be inherited by the resulting networks.

prefix ( Unsigned integer. ). This parameter is mandatory. The appropriate subnet mask for each subnet created after splitting the network.

Output fields

None

Search-only Fields

These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.

contains_address

contains_address

When specified in searches, the returned network is the smallest network that contains this IPv4 Address.

If specified, all other search attributes are ignored, except for network_view.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

contains_address is a search-only field.

member

member

Used for searching networks by members that serve the network. The input value must be “dhcpmember,ipv4address[,name]” to search by Grid DHCP member by its IPv4 address, or “ipv6dhcpmember,ipv6address[,name]” to search by Grid DHCP member by its IPv6 address, or “msdhcpserver,ipv4address” to search by Microsoft DHCP server.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

member is a search-only field.

Fields List

Field Type Req R/O Base Search
authority Bool N N N N/A
auto_create_reversezone 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 : = ~
conflict_count Unsigned int N Y N N/A
ddns_domainname String N N N N/A
ddns_generate_hostname Bool N N N N/A
ddns_server_always_updates Bool N N N N/A
ddns_ttl Unsigned int N N N N/A
ddns_update_fixed_addresses Bool N N N N/A
ddns_use_option81 Bool N N N N/A
delete_reason String 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
discovered_bgp_as String N Y N : = ~
discovered_bridge_domain String N N N : = ~
discovered_tenant String N N N : = ~
discovered_vlan_id String N Y N : = ~
discovered_vlan_name String N Y N : = ~
discovered_vrf_description String N Y N : = ~
discovered_vrf_name String N Y N : = ~
discovered_vrf_rd String N Y N : = ~
discovery_basic_poll_settings struct N N N N/A
discovery_blackout_setting struct N N N N/A
discovery_engine_type String N Y N =
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
endpoint_sources [obj] N Y N N/A
extattrs Extattr N N N ext
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
ipam_email_addresses [String] N N N N/A
ipam_threshold_settings struct N N N N/A
ipam_trap_settings struct N N N N/A
ipv4addr String N N N = ~
last_rir_registration_update_sent Timestamp N Y N N/A
last_rir_registration_update_status String N Y 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
members [struct] N N N N/A
mgm_private Bool N N N N/A
mgm_private_overridable Bool N Y N N/A
ms_ad_user_data struct N Y N N/A
netmask Unsigned int N N N N/A
network String Y N Y = ~
network_container String N Y N =
network_view String N N Y =
nextserver String 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
restart_if_needed Bool N N N N/A
rir String N Y N =
rir_organization String N N N =
rir_registration_action String N N N N/A
rir_registration_status String N N N N/A
same_port_control_discovery_blackout Bool N N N N/A
send_rir_request Bool N N N N/A
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
unmanaged Bool N N N =
unmanaged_count Unsigned int N Y N N/A
update_dns_on_lease_renewal Bool N N N N/A
use_authority 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_ddns_ttl Bool N N N N/A
use_ddns_update_fixed_addresses Bool N N N N/A
use_ddns_use_option81 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_ipam_email_addresses Bool N N N N/A
use_ipam_threshold_settings Bool N N N N/A
use_ipam_trap_settings 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_mgm_private 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_update_dns_on_lease_renewal Bool N N N N/A
use_zone_associations Bool N N N N/A
utilization Unsigned int N Y N N/A
utilization_update Timestamp N Y N N/A
vlans [struct] N N N N/A
zone_associations [struct] N N N N/A

Search-only Fields List

Field Type Search
contains_address String =
member String =

Table Of Contents

Previous topic

natgroup : Network Address Translation group object.

Next topic

network_discovery : Network discovery object.