Get Dhcp Lease Info | NSX-T Data Center REST API

Get Dhcp Lease Info

Get lease info of a given dhcp server id. If a "pool_id" is specified, the lease info of the pool are returned. If an "address" is specified, only the lease info the this address is returned. The "address" can be a single IP, an ip-range, or a mac address. "pool_id" and "address" are mutually excluded. Either a "pool_id" or an "address" can be provided, but not both.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/dhcp/servers/{server-id}/leases

COPY

Path Parameters

string

server-id

Required

server-id

Query Parameters

string

address

Optional

can be an ip address, or an ip range, or a mac address

string

pool_id

Optional

The uuid of dhcp ip pool

string

source

Optional

Data source type.

Possible values are : realtime, cached,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns DhcpLeases of type(s) application/json

{
    "timestamp": 0,
    "leases": [
        {
            "subnet": "string",
            "lease_time": "string",
            "mac_address": "string",
            "expire_time": "string",
            "start_time": "string",
            "ip_address": "string"
        }
    ],
    "dhcp_server_id": "string"
}

integer As int64 As int64

timestamp

Required

timestamp of the lease info

array of DhcpLeasePerIP

leases

Optional

The lease info list of the server

string

dhcp_server_id

Required

dhcp server uuid

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error