DhcpProfile (schema)

DHCP profile to specify edge cluster and members

DHCP profile to specify edge cluster and members on which the dhcp server
will run. A DhcpProfile can be referenced by different logical DHCP servers.
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
edge_cluster_id Edge cluster uuid

Edge cluster uuid on which the referencing logical DHCP server runs.
string Required
edge_cluster_member_indexes Edge node indexes

The Edge nodes on which the DHCP servers run. If none is provided, the
NSX will auto-select two edge-nodes from the given edge cluster. If only
one edge node is provided, the DHCP servers will run without HA support.
array of integer Minimum items: 0
Maximum items: 2
enable_standby_relocation Flag to enable standby DHCP server relocation

Flag to enable the auto-relocation of standby DHCP Service in case
of edge node failure. Only tier 1 and auto placed DHCP servers are
considered for the relocation.
boolean Default: "False"
id Unique identifier of this resource string Sortable
resource_type Must be set to the value DhcpProfile string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30