NSX-T Data Center REST API

Get a DHCP server with v4 and/or v6 servers (Deprecated)

Retrieve a logical DHCP server specified by server id.

Request:

Method:

GET

URI Path(s):

/api/v1/dhcp/servers/<server-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

Get https://<nsx-mgr>/api/v1/dhcp/servers/b6a5bffa-f6a9-447c-936f-4633f9eb43a7

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

LogicalDhcpServer+

LogicalDhcpServer (schema)

(Deprecated)

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
attached_logical_port_id	Id of attached logical port The uuid of the attached logical port. Read only.	string	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
dhcp_profile_id	DHCP profile uuid The DHCP profile uuid the logical DHCP server references.	string	Required
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ipv4_dhcp_server	DHCP server for ipv4 addresses The DHCP server for ipv4 addresses allocation service.	IPv4DhcpServer
ipv6_dhcp_server	DHCP server for ipv6 addresses The DHCP server for ipv6 addresses allocation service.	IPv6DhcpServer
resource_type	Must be set to the value LogicalDhcpServer	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type" : "LogicalDhcpServer", "id" : "b6a5bffa-f6a9-447c-936f-4633f9eb43a7", "display_name" : "DHCP-server-2", "dhcp_profile_id" : "faf85fb5-9242-4d24-abca-0ca59b2b669b", "ipv4_dhcp_server" : { "dhcp_server_ip" : "192.168.110.50/24" }, "attached_logical_port_id" : "ecde011f-528f-4ccb-a147-dd45d74103b6", "_create_time" : 1478304339963, "_create_user" : "admin", "_last_modified_user" : "admin", "_system_owned" : false, "_last_modified_time" : 1478304339963, "_revision" : 0 }

Required Permissions:

read

Feature:

dhcp_servers

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable