[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Get DNS Forwarder Status
DescriptionGet current status of tier-1 DNS forwarder.
- no enforcement point path specified: Status will be evaluated on each enforcement point.
- {enforcement_point_path}: Status will be evaluated only on the given enforcement point.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/status
Path Parameters
Path Parameters
string
tier-1-id
Required
Tier-1 id
Query Parameters
Query Parameters
string
enforcement_point_path
Optional
String Path of the enforcement point
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
AggregateDNSForwarderStatus
of type(s) application/json
{
"intent_path": "string",
"status_per_enforcement_point": [
{
"enforcement_point_path": "string",
"resource_type": "NsxTDNSForwarderStatus"
}
]
}
string
intent_path
Required
String path of the DNS forwarder intent.
status_per_enforcement_point
Optional
List of DNS forwarder status per enforcement point.
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
PowerCLI Client SDK Example
Invoke-GetTier1DNSForwarderStatus -tier1Id "Mytier1Id" -enforcementPointPath "MyenforcementPointPath"
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/status
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get-dns-forwarder-status
x-vmw-nsx-module: PolicyDNSStatistics
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 1s Operations
delete
get
patch
