| _create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly
Sortable |
| _create_user |
ID of the user who created this resource |
string |
Readonly |
| _last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly
Sortable |
| _last_modified_user |
ID of the user who last modified this resource |
string |
Readonly |
| _links |
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink |
Readonly |
| _protection |
Indicates protection status of this resource
Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
|
string |
Readonly |
| _revision |
Generation of this resource config
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int |
|
| _schema |
Schema for this resource |
string |
Readonly |
| _self |
Link to this resource |
SelfResourceLink |
Readonly |
| _system_owned |
Indicates system owned resource |
boolean |
Readonly |
| allocation_ranges |
Ip-ranges
Ip-ranges to define dynamic ip allocation ranges. |
array of IpPoolRange |
Required |
| description |
Description of this resource |
string |
Maximum length: 1024
Sortable |
| display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255
Sortable |
| error_threshold |
Error threshold, valid [80-100], default 100
Error threshold. Alert will be raised if the pool usage reaches the
given threshold.
|
integer |
Minimum: 80
Maximum: 100
Default: "100" |
| gateway_ip |
Gateway ip
Gateway ip address of the allocation. |
IPAddress |
|
| id |
Unique identifier of this resource |
string |
Sortable |
| lease_time |
Lease time
Lease time, in seconds, [60-(2^32-1)]. Default is 86400. |
integer |
Minimum: 60
Maximum: 4294967295
Default: "86400" |
| options |
DHCP options
If an option is defined at server level and not configred at
ip-pool/static-binding level, the option will be inherited to
ip-pool/static-binding. If both define a same-code option, the
option defined at ip-pool/static-binding level take precedence
over that defined at server level.
|
DhcpOptions |
|
| resource_type |
Must be set to the value DhcpIpPool |
string |
|
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| warning_threshold |
Warning threshold, valid [50-80], default 80
Warning threshold. Alert will be raised if the pool usage reaches the
given threshold.
|
integer |
Minimum: 50
Maximum: 80
Default: "80" |