Management Plane API >
Security
>
Services
>
Firewall
List all firewall status for supported contexts
Request:
Method:
GET
URI Path(s):
/api/v1/firewall/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/firewall/status
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
FirewallStatusListResult
+
FirewallStatusListResult
(
schema
)
Name
Description
Type
Notes
_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
_schema
Schema for this resource
string
Readonly
_self
Link to this resource
SelfResourceLink
Readonly
cursor
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
Readonly
result_count
Count of results found (across all pages), set only on first page
integer
Readonly
results
array of
FirewallStatus
Required
Readonly
sort_ascending
If true, results are sorted in ascending order
boolean
Readonly
sort_by
Field by which records are sorted
string
Readonly
Example Response:
{ "result_count": 1, "results": [ { "resource_type": "FirewallStatus", "id": "5863495c-ffe8-4d44-8ea7-371f9fe2d97f", "display_name": "5863495c-ffe8-4d44-8ea7-371f9fe2d97f", "global_status": "DISABLED", "context": "transport_nodes", "_last_modified_user": "admin", "_last_modified_time": 1498698220680, "_protection": "NOT_PROTECTED", "_revision": 1 } ] }
Required Permissions:
read
Feature:
firewall_general
Description:
Fetches firewall status for all supported context types. Supported context type is 'transport_nodes'.
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable