| _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 |
| children |
Subtree for this type within policy tree
Subtree for this type within policy tree containing nested elements. Note that
this type is applicable to be used in Hierarchical API only.
|
array of ChildPolicyConfigResource
Children are not allowed for this type |
|
| 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_path |
Edge cluster path or label of type PolicyEdgeCluster
The reference to the edge cluster using the policy path of the edge cluster or label of type PolicyEdgeCluster.
Auto assigned if only one edge cluster is configured
on enforcement-point.
Modifying edge cluster will reallocate DHCP server to the new edge cluster.
Please note that re-allocating edge-cluster will result in losing of all exisitng
DHCP lease information.
Change edge cluster only when losing DHCP leases is not a real problem,
e.g. cross-site migration or failover and all client hosts will be reboot and
get new IP addresses.
|
string |
|
| enable_standby_relocation |
Stand-By Relocation
If no "preferred-edge-paths" were defined, and the "enable-standby-relocation"=true,
once a new edge-node was added to the edge-cluster, the stand-by node of the DHCP
could possibly be moved to another edge-node.
But there is no guarantee that the stand-by will be moved.
Please note, if the dhcp-server-config was applied to a gateway, and this gateway has
defined its own edge-cluster and preferred edge-nodes, then the edge-cluster and nodes
defined in dhcp-server-config will be ignored.
|
boolean |
Default: "False" |
| id |
Unique identifier of this resource |
string |
Sortable |
| lease_time |
IP address lease time in seconds
IP address lease time in seconds.
|
integer |
Deprecated
Minimum: 60
Maximum: 4294967295
Default: "86400" |
| marked_for_delete |
Indicates whether the intent object is marked for deletion
Intent objects are not directly deleted from the system when a delete
is invoked on them. They are marked for deletion and only when all the
realized entities for that intent object gets deleted, the intent object
is deleted. Objects that are marked for deletion are not returned in
GET call. One can use the search API to get these objects.
|
boolean |
Readonly
Default: "False" |
| origin_site_id |
A unique identifier assigned by the system for knowing which site owns an object
This is a UUID generated by the system for knowing which site owns an object.
This is used in NSX+.
|
string |
Readonly |
| overridden |
Indicates whether this object is the overridden intent object
Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
|
boolean |
Readonly
Default: "False" |
| owner_id |
A unique identifier assigned by the system for the ownership of an object
This is a UUID generated by the system for knowing who owns this object.
This is used in NSX+.
|
string |
Readonly |
| parent_path |
Path of its parent
Path of its parent |
string |
Readonly |
| path |
Absolute path of this object
Absolute path of this object |
string |
Readonly |
| preferred_edge_paths |
Edge node path
Policy paths to edge nodes on which the DHCP servers run. The first edge node
is assigned as active edge, and second one as stanby edge. If only one edge node
is specified, the DHCP servers will run without HA support.
When this property is not specified, edge nodes are auto-assigned during
realization of the DHCP server.
|
array of string |
Maximum items: 2 |
| realization_id |
A unique identifier assigned by the system for realizing intent
This is a UUID generated by the system for realizing the entity object.
In most cases this should be same as 'unique_id' of the entity. However,
in some cases this can be different because of entities have migrated their
unique identifier to NSX Policy intent objects later in the timeline and did
not use unique_id for realization. Realization id is helpful for users to
debug data path to correlate the configuration with corresponding intent.
|
string |
Readonly |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| remote_path |
Path of the object on the remote end.
This is the path of the object on the local managers when queried on the NSX+ service,
and path of the object on NSX+ service when queried from the local managers.
|
string |
Readonly |
| resource_type |
Must be set to the value DhcpServerConfig |
string |
|
| server_address |
DHCP server address in CIDR format
DHCP server address in CIDR format. Prefix length should be less than
or equal to 30. DHCP server is deployed as DHCP relay service.
This property is deprecated, use server_addresses instead. Both
properties cannot be specified together with different new values.
|
string |
Deprecated
Format: ip-cidr-block |
| server_addresses |
DHCP server address in CIDR format
DHCP server address in CIDR format. Both IPv4 and IPv6 address families
are supported.
Prefix length should be less than or equal to 30 for IPv4 address
family and less than or equal to 126 for IPv6.
When not specified, IPv4 value is auto-assigned to 100.96.0.1/30.
Ignored when this object is configured at a Segment.
|
array of string |
Maximum items: 2 |
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| unique_id |
A unique identifier assigned by the system
This is a UUID generated by the GM/LM to uniquely identify
entities in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
|
string |
Readonly |