mssuperscope : Microsoft DHCP superscope object.¶
This object represents a superscope feature of Microsoft DHCP server. You can use a superscope to group and activate multiple ranges via a single object.
Object Reference¶
References to mssuperscope are object references.
The name part of the Microsoft DHCP superscope object reference has the following components:
The name of the Microsoft DHCP superscope
The name of the network view where the Microsoft DHCP superscope resides
- Example:
mssuperscope/ZG5zLmJpbmRfY25h:scopename/networkviewname
Restrictions¶
The object does not support the following operations:
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): disable, name, network_view.
The following fields are required to create this object:
Field |
Notes |
|---|---|
name |
|
ranges |
comment¶
- comment¶
The superscope descriptive comment.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
dhcp_utilization¶
- dhcp_utilization¶
The percentage of the total DHCP usage of the ranges in the superscope.
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¶
Utilization level of the DHCP range objects that belong to the superscope.
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 the superscope is disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
The disable is part of the base object.
dynamic_hosts¶
- dynamic_hosts¶
The total number of DHCP leases issued for the DHCP range objects that belong to the superscope.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The dynamic_hosts cannot be updated.
dynamic_hosts 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 value for DHCP range usage after which an alarm will be active.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The high_water_mark cannot be updated.
high_water_mark cannot be written.
high_water_mark_reset¶
- high_water_mark_reset¶
The percentage value for DHCP range usage after which an alarm will be reset.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The high_water_mark_reset cannot be updated.
high_water_mark_reset cannot be written.
low_water_mark¶
- low_water_mark¶
The percentage value for DHCP range usage below which an alarm will be active.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The low_water_mark cannot be updated.
low_water_mark cannot be written.
low_water_mark_reset¶
- low_water_mark_reset¶
The percentage value for DHCP range usage below which an alarm will be reset.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The low_water_mark_reset cannot be updated.
low_water_mark_reset cannot be written.
name¶
- name¶
The name of the Microsoft DHCP superscope.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The name is part of the base object.
network_view¶
- network_view¶
The name of the network view in which the superscope 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.
ranges¶
- ranges¶
The list of DHCP ranges that are associated with the superscope.
Type
A/An range object array.
This field supports nested return fields as described here.
Create
The field is required on creation.
Search
The field is not available for search.
static_hosts¶
- static_hosts¶
The number of static DHCP addresses configured in DHCP range objects that belong to the superscope.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The static_hosts cannot be updated.
static_hosts cannot be written.
total_hosts¶
- total_hosts¶
The total number of DHCP addresses configured in DHCP range objects that belong to the superscope.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The total_hosts cannot be updated.
total_hosts cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
comment |
String |
N |
N |
N |
: = ~ |
dhcp_utilization |
Unsigned int |
N |
Y |
N |
N/A |
dhcp_utilization_status |
String |
N |
Y |
N |
N/A |
disable |
Bool |
N |
N |
Y |
N/A |
dynamic_hosts |
Unsigned int |
N |
Y |
N |
N/A |
extattrs |
Extattr |
N |
N |
N |
ext |
high_water_mark |
Unsigned int |
N |
Y |
N |
N/A |
high_water_mark_reset |
Unsigned int |
N |
Y |
N |
N/A |
low_water_mark |
Unsigned int |
N |
Y |
N |
N/A |
low_water_mark_reset |
Unsigned int |
N |
Y |
N |
N/A |
name |
String |
Y |
N |
Y |
: = ~ |
network_view |
String |
N |
N |
Y |
= |
ranges |
[obj] |
Y |
N |
N |
N/A |
static_hosts |
Unsigned int |
N |
Y |
N |
N/A |
total_hosts |
Unsigned int |
N |
Y |
N |
N/A |
