Get Dhcp Statistics

Get Dhcp Statistics

Returns the statistics of the given dhcp server.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/dhcp/servers/{server-id}/statistics
COPY
Path Parameters
string
server-id
Required

server-id


Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns DhcpStatistics of type(s) application/json
{
    "errors": 0,
    "releases": 0,
    "informs": 0,
    "declines": 0,
    "dhcp_server_id": "string",
    "nacks": 0,
    "offers": 0,
    "discovers": 0,
    "acks": 0,
    "timestamp": 0,
    "requests": 0,
    "ip_pool_stats": [
        {
            "allocated_percentage": 0,
            "pool_size": 0,
            "allocated_number": 0,
            "dhcp_ip_pool_id": "string"
        }
    ]
}
integer As int64 As int64
errors
Required

The total number of DHCP errors

integer As int64 As int64
releases
Required

The total number of DHCP RELEASE packets

integer As int64 As int64
informs
Required

The total number of DHCP INFORM packets

integer As int64 As int64
declines
Required

The total number of DHCP DECLINE packets

string
dhcp_server_id
Required

dhcp server uuid

integer As int64 As int64
nacks
Required

The total number of DHCP NACK packets

integer As int64 As int64
offers
Required

The total number of DHCP OFFER packets

integer As int64 As int64
discovers
Required

The total number of DHCP DISCOVER packets

integer As int64 As int64
acks
Required

The total number of DHCP ACK packets

integer As int64 As int64
timestamp
Required

timestamp of the statistics

integer As int64 As int64
requests
Required

The total number of DHCP REQUEST packets

ip_pool_stats
Optional

The DHCP ip pool usage statistics


400
Returns BadRequest of type(s) application/json
Operation doesn't return any data structure

403
Returns Forbidden of type(s) application/json
Operation doesn't return any data structure

404
Returns NotFound of type(s) application/json
Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure

500
Operation doesn't return any data structure

503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure

Services Operations
POST
Add Dne Key Manager
POST
Add Dne Key Policy
POST
Add Dne Rule In Section
POST
Add Dne Rules In Section Create Multiple
POST
Add Dne Section
POST
Add Dne Section With Rules Create With Rules
POST
Add Member Add Member
POST
Add Rule In Section
POST
Add Rules In Section Create Multiple
POST
Add Section
POST
Add Section With Rules Create With Rules
POST
Check Member If Exists Check If Exists
POST
Create Dhcp Ip Pool
POST
Create Dhcp Profile
POST
Create Dhcp Server
POST
Create Dhcp Static Binding
POST
Create Metadata Proxy
DELETE
Delete Dhcp Ip Pool
DELETE
Delete Dhcp Profile
DELETE
Delete Dhcp Server
DELETE
Delete Dhcp Static Binding
DELETE
Delete Dne Key Manager
DELETE
Delete Dne Key Policy
DELETE
Delete Dne Rule
DELETE
Delete Dne Section
DELETE
Delete Metadata Proxy
DELETE
Delete Rule
DELETE
Delete Section
GET
Get Dhcp Lease Info
GET
Get Dhcp Statistics
GET
Get Dhcp Status
GET
Get Dne Global Config
GET
Get Dne Key Manager
GET
Get Dne Key Policy
GET
Get Dne Key Policy Stats
GET
Get Dne Rule
GET
Get Dne Rules
GET
Get Dne Rules By Key Policy
GET
Get Dne Rule State
GET
Get Dne Rule Stats
GET
Get Dne Section
GET
Get Dne Section State
POST
Get Dne Section With Rules List With Rules
GET
Get Exclude List
GET
Get Firewall Stats
GET
Get Firewall Status
GET
Get Metadata Proxy Statistics
GET
Get Metadata Proxy Status
GET
Get Network Encryption Status
GET
Get Rule
GET
Get Rules
GET
Get Rule State
GET
Get Section
GET
Get Section State
POST
Get Section With Rules List With Rules
GET
List Dhcp Ip Pools
GET
List Dhcp Profiles
GET
List Dhcp Servers
GET
List Dhcp Static Bindings
GET
List Dne Key Managers
GET
List Dne Key Policies
GET
List Dne Sections
GET
List Firewall Status
GET
List Metadata Proxy
GET
List Sections
GET
Read Dhcp Ip Pool
GET
Read Dhcp Profile
GET
Read Dhcp Server
GET
Read Dhcp Static Binding
GET
Read Metadata Proxy
POST
Remove Member Remove Member
PUT
Reset Default Dne Key Policy To System Default
POST
Revise Dne Rule Revise
POST
Revise Dne Section Revise
POST
Revise Dne Section With Rules Revise With Rules
POST
Revise Rule Revise
POST
Revise Section Revise
POST
Revise Section With Rules Revise With Rules
POST
Revoke Dne Key Policy Revoke
POST
Rotate Dne Key Policy Rotate
PUT
Update Dhcp Ip Pool
PUT
Update Dhcp Profile
PUT
Update Dhcp Server
PUT
Update Dhcp Static Binding
PUT
Update Dne Global Config
PUT
Update Dne Key Manager
PUT
Update Dne Key Policy
PUT
Update Dne Rule
PUT
Update Dne Section
POST
Update Dne Section With Rules Update With Rules
PUT
Update Exclude List
PUT
Update Firewall Status
PUT
Update Metadata Proxy
POST
Update Network Encryption Status Update Status
PUT
Update Rule
PUT
Update Section
POST
Update Section With Rules Update With Rules