This object represents a subset of the Microsoft Server DHCP properties.
References to msserver:dhcp are object references. The name part of a Microsoft Server DHCP properties object reference has the following components:
- The address of the Microsoft Server to which the DHCP properties apply.
Example: msserver:dhcp/ZG5zLm5ldHdvcmtfdmlldyQxMTk:1.0.0.1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): address.
The address or FQDN of the DHCP Microsoft Server.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
Notes
The address is part of the base object.
The address cannot be updated.
address cannot be written.
Comment from Microsoft Server
Type
String.
Search
The field is not available for search.
Notes
The comment cannot be updated.
comment cannot be written.
The percentage of the total DHCP utilization of DHCP objects belonging to the DHCP Microsoft Server multiplied by 1000. This is the percentage of the total number of available IP addresses from all the DHCP objects belonging to the DHCP Microsoft Server versus the total number of all IP addresses in all of the DHCP objects on the DHCP Microsoft Server.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The dhcp_utilization cannot be updated.
dhcp_utilization cannot be written.
A string describing the utilization level of DHCP objects that belong to the DHCP Microsoft Server.
Type
String.
Search
The field is not available for search.
Notes
The dhcp_utilization_status cannot be updated.
dhcp_utilization_status cannot be written.
The total number of DHCP leases issued for the DHCP objects on the DHCP Microsoft Server.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The dynamic_hosts cannot be updated.
dynamic_hosts cannot be written.
Timestamp of the last synchronization attempt
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_sync_ts cannot be updated.
last_sync_ts cannot be written.
The login name of the DHCP Microsoft Server.
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
login_name is associated with the field use_login (see use flag).
The login password of the DHCP Microsoft Server.
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
login_password is associated with the field use_login (see use flag).
login_password is not readable.
Network view to update
Type
String.
Search
The field is not available for search.
Notes
The network_view cannot be updated.
network_view cannot be written.
Defines what control to apply on the DHCP server
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Whether Microsoft server is read only
Type
Bool.
Search
The field is not available for search.
Notes
The read_only cannot be updated.
read_only cannot be written.
Microsoft server address
Type
String.
Search
The field is not available for search.
Notes
The server_name cannot be updated.
server_name cannot be written.
The number of static DHCP addresses configured in DHCP objects that belong to the DHCP Microsoft Server.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The static_hosts cannot be updated.
static_hosts cannot be written.
Status of the Microsoft DHCP Service
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Detailed status of the DHCP status
Type
String.
Search
The field is not available for search.
Notes
The status_detail cannot be updated.
status_detail cannot be written.
Timestamp of the last update
Type
Timestamp.
Search
The field is not available for search.
Notes
The status_last_updated cannot be updated.
status_last_updated cannot be written.
Flag indicating if the DHCP supports Failover
Type
Bool.
Search
The field is not available for search.
Notes
The supports_failover cannot be updated.
supports_failover cannot be written.
The minimum number of minutes between two synchronizations.
Type
Unsigned integer.
Create
The default value is 2.
Search
The field is not available for search.
Notes
synchronization_interval is associated with the field use_synchronization_interval (see use flag).
The total number of DHCP addresses configured in DHCP objects that belong to the DHCP Microsoft Server.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The total_hosts cannot be updated.
total_hosts cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| address | String | N | Y | Y | : = ~ |
| comment | String | N | Y | N | N/A |
| dhcp_utilization | Unsigned int | N | Y | N | N/A |
| dhcp_utilization_status | String | N | Y | N | N/A |
| dynamic_hosts | Unsigned int | N | Y | N | N/A |
| last_sync_ts | Timestamp | N | Y | N | N/A |
| login_name | String | N | N | N | N/A |
| login_password | String | N | N | N | N/A |
| network_view | String | N | Y | N | N/A |
| next_sync_control | String | N | N | N | N/A |
| read_only | Bool | N | Y | N | N/A |
| server_name | String | N | Y | N | N/A |
| static_hosts | Unsigned int | N | Y | N | N/A |
| status | String | N | N | N | N/A |
| status_detail | String | N | Y | N | N/A |
| status_last_updated | Timestamp | N | Y | N | N/A |
| supports_failover | Bool | N | Y | N | N/A |
| synchronization_interval | Unsigned int | N | N | N | N/A |
| total_hosts | Unsigned int | N | Y | N | N/A |
| use_login | Bool | N | N | N | N/A |
| use_synchronization_interval | Bool | N | N | N | N/A |
msserver:adsites:site : Active Directory Site object.
