dhcp:statistics : DHCP Statistics object.

DHCP Statistics object is used to display information about DHCP utilization status, number of static and dynamic hosts, overall DHCP utilization in percentage. DHCP Statistics object supports references on following objects: network, range, sharednetwork, msserver:dhcp, member:dhcpproperties.

Note that get by reference is not allowed for this object. Search result returns the dhcp:statistics object itself (not a list).

Note that read by reference is not supported.

Object Reference

References to dhcp:statistics are object references. There is no name part in a DHCP statistics object reference.

Example: dhcp:statistics/5ldHdvcmskMTEuMC4

Restrictions

The object does not support the following operations:

• Create (insert)
• Delete
• Modify (update)
• Permissions
• Global search (searches via the search object)
• Scheduling
• CSV export

The object cannot be managed on Cloud Platform members.

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): dhcp_utilization, dhcp_utilization_status, dynamic_hosts, static_hosts, total_hosts.

dhcp_utilization

dhcp_utilization

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

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The dhcp_utilization is part of the base object.

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 DHCP object.

Type

String.

Valid values are:

• FULL
• HIGH
• LOW
• NORMAL

Search

The field is not available for search.

Notes

The dhcp_utilization_status is part of the base object.

The dhcp_utilization_status cannot be updated.

dhcp_utilization_status cannot be written.

dynamic_hosts

dynamic_hosts

The total number of DHCP leases issued for the DHCP object.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The dynamic_hosts is part of the base object.

The dynamic_hosts cannot be updated.

dynamic_hosts cannot be written.

static_hosts

static_hosts

The number of static DHCP addresses configured in the DHCP object.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The static_hosts is part of the base object.

The static_hosts cannot be updated.

static_hosts cannot be written.

total_hosts

total_hosts

The total number of DHCP addresses configured in the DHCP object.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The total_hosts is part of the base object.

The total_hosts cannot be updated.

total_hosts cannot be written.

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.

statistics_object

statistics_object

The DHCP object to browse DHCP statistics for.

Type

String.

This field supports nested return fields as described here.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

statistics_object is a search-only field.

Fields List

Field	Type	Req	R/O	Base	Search
dhcp_utilization	Unsigned int	N	Y	Y	N/A
dhcp_utilization_status	String	N	Y	Y	N/A
dynamic_hosts	Unsigned int	N	Y	Y	N/A
static_hosts	Unsigned int	N	Y	Y	N/A
total_hosts	Unsigned int	N	Y	Y	N/A

Search-only Fields List

Field	Type	Search
statistics_object	String	=