DhcpStaticBinding (schema)

DHCP static binding

DHCP static binding to define a static ip allocation.
Name Description Type Notes
_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
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
gateway_ip Gateway ip

Gateway ip address of the allocation.
IPAddress
host_name Host name

The host name to be assigned to the host.
string
id Unique identifier of this resource string Sortable
ip_address Ip address

The ip address to be assigned to the host.
IPAddress Required
lease_time Lease time

Lease time, in seconds, [60-(2^32-1)]. Default is 86400.
integer Minimum: 60
Maximum: 4294967295
Default: "86400"
mac_address MAC address

The MAC address of the host.
MACAddress Required
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 DhcpStaticBinding string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30