NSX-T Data Center REST API

Returns the Views based on query criteria defined in ViewQueryParameters. (Deprecated)

If no query params are specified then all the views entitled for the user
are returned. The views to which a user is entitled to include the views
created by the user and the shared views.
Deprecated: This API is deprecated and will be unavailable in later releases.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/ui-views
Request Headers:
n/a
Query Parameters:
ViewQueryParameters+
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ViewList+

Example Response:

{ "views" : [ { "display_name" : "System", "widgets" : [ { "widget_id" : "ContainerConfiguration_Clusters-Status", "weight" : 9000 }, { "widget_id" : "ContainerConfiguration_EPP-Deployment-Status", "weight" : 9100 }, { "widget_id" : "ContainerConfiguration_Fabric-Status", "weight" : 9010 }, { "widget_id" : "DonutConfiguration_All-Transport-Zones-Status", "weight" : 9542 }, { "widget_id" : "DonutConfiguration_Compute-Managers-Status", "weight" : 9543 }, { "widget_id" : "DonutConfiguration_EPP-Deployment-Status", "weight" : 9080 }, { "widget_id" : "DonutConfiguration_Edge-Transport-Nodes", "weight" : 9536 }, { "widget_id" : "DonutConfiguration_Host-Transport-Nodes", "weight" : 9535 }, { "widget_id" : "DonutConfiguration_Node-Cluster-Status", "weight" : 9562 }, { "widget_id" : "LabelValueConfiguration_Backups", "weight" : 9070 } ], "shared" : true, "weight" : 10, "resource_type" : "View", "id" : "dashboard_system", "description" : "Highlights the health of key entities in the NSX infrastructure and backup status of appliance.", "_create_time" : 1672635884575, "_create_user" : "system", "_last_modified_time" : 1672635885284, "_last_modified_user" : "system", "_system_owned" : true, "_protection" : "NOT_PROTECTED", "_revision" : 1 }, { "display_name" : "Networking & Security", "widgets" : [ { "widget_id" : "ContainerConfiguration_Networking-Status", "weight" : 2000 }, { "widget_id" : "ContainerConfiguration_POLICY_VPN-Status", "weight" : 3035 }, { "widget_id" : "ContainerConfiguration_Policy-Load-Balancers-Status", "weight" : 3000 }, { "widget_id" : "ContainerConfiguration_Security-Status", "weight" : 1000 }, { "widget_id" : "ContainerConfiguration_Segments-Status", "weight" : 2020 }, { "widget_id" : "DonutConfiguration_DFW_Sections-Status", "weight" : 2020 }, { "widget_id" : "DonutConfiguration_Groups-Status", "weight" : 1000 }, { "widget_id" : "DonutConfiguration_Load_Balancers-Status", "weight" : 3040 }, { "widget_id" : "DonutConfiguration_Networks-Status", "weight" : 3020 }, { "widget_id" : "DonutConfiguration_Providers-Status", "weight" : 3010 }, { "widget_id" : "DonutConfiguration_Segments-Status", "weight" : 3030 }, { "widget_id" : "SpacerWidgetConfiguration_L2_VPN-Status", "weight" : 4000 }, { "widget_id" : "SpacerWidgetConfiguration_L3_ROUTE_BASED_VPN-Status", "weight" : 4040 }, { "widget_id" : "StatsConfiguration_L2_VPN-Status", "weight" : 4010 }, { "widget_id" : "StatsConfiguration_L3_POLICY_BASED_VPN-Status", "weight" : 4020 }, { "widget_id" : "StatsConfiguration_L3_ROUTE_BASED_VPN-Status", "weight" : 4030 } ], "shared" : true, "weight" : 20, "resource_type" : "View", "id" : "dashboard_policy_networking_n_security", "description" : "Highlights the realization status of key Networking and Security Intent.", "_create_time" : 1672635885297, "_create_user" : "system", "_last_modified_time" : 1672635885733, "_last_modified_user" : "system", "_system_owned" : true, "_protection" : "NOT_PROTECTED", "_revision" : 1 }, { "display_name" : "Networking & Security", "widgets" : [ { "widget_id" : "ContainerConfiguration_Firewall", "weight" : 9040 }, { "widget_id" : "ContainerConfiguration_Load-Balancers-Status", "weight" : 9030 }, { "widget_id" : "ContainerConfiguration_Switching-Status", "weight" : 9060 }, { "widget_id" : "ContainerConfiguration_VPN-Status", "weight" : 9050 }, { "widget_id" : "LabelValueConfiguration_Firewall-Rules-Details", "weight" : 0 }, { "widget_id" : "LabelValueConfiguration_Firewall-Sections-Details", "weight" : 0 }, { "widget_id" : "MultiWidgetConfiguration_Switching-Container-Port-Status", "weight" : 9436 }, { "widget_id" : "MultiWidgetConfiguration_Switching-Logical-Switches-Status", "weight" : 9430 }, { "widget_id" : "MultiWidgetConfiguration_Switching-Switch-Port-Status", "weight" : 9432 }, { "widget_id" : "MultiWidgetConfiguration_Switching-VM-Port-Status", "weight" : 9434 }, { "widget_id" : "StatsConfiguration_Firewall-Members-Excluded", "weight" : 9310 }, { "widget_id" : "StatsConfiguration_Firewall-Rules", "weight" : 9305 }, { "widget_id" : "StatsConfiguration_Firewall-Sections", "weight" : 9300 }, { "widget_id" : "StatsConfiguration_L2VPN-Status", "weight" : 9671 }, { "widget_id" : "StatsConfiguration_L3VPN-Status", "weight" : 9670 }, { "widget_id" : "StatsConfiguration_Load-Balancers-Status", "weight" : 9255 }, { "widget_id" : "StatsConfiguration_Server-Pools-Status", "weight" : 9270 }, { "widget_id" : "StatsConfiguration_Switching-Container-Ports-Admin-Status", "weight" : 9657 }, { "widget_id" : "StatsConfiguration_Switching-Container-Ports-Operational-Status", "weight" : 9414 }, { "widget_id" : "StatsConfiguration_Switching-Logical-Switches-Admin-Status", "weight" : 9400 }, { "widget_id" : "StatsConfiguration_Switching-Logical-Switches-Config-Status", "weight" : 9402 }, { "widget_id" : "StatsConfiguration_Switching-Switch-Ports-Admin-Status", "weight" : 9404 }, { "widget_id" : "StatsConfiguration_Switching-Switch-Ports-Operational-Status", "weight" : 9406 }, { "widget_id" : "StatsConfiguration_Switching-VM-Ports-Admin-Status", "weight" : 9408 }, { "widget_id" : "StatsConfiguration_Switching-VM-Ports-Operational-Status", "weight" : 9410 }, { "widget_id" : "StatsConfiguration_Virtual-Servers-Status", "weight" : 9260 } ], "shared" : true, "weight" : 30, "resource_type" : "View", "id" : "dashboard_adv_networking_n_security", "description" : "Highlights the health of key realized entities for Networking and Security.", "_create_time" : 1672635885752, "_create_user" : "system", "_last_modified_time" : 1672635886232, "_last_modified_user" : "system", "_system_owned" : true, "_protection" : "NOT_PROTECTED", "_revision" : 1 }, { "display_name" : "Compliance Report", "widgets" : [ ], "shared" : true, "weight" : 50, "resource_type" : "View", "id" : "dashboard_compliance", "description" : "Highlights the compliance issues with entities in the deployment.", "_create_time" : 1672635885743, "_create_user" : "system", "_last_modified_time" : 1672635885743, "_last_modified_user" : "system", "_system_owned" : true, "_protection" : "NOT_PROTECTED", "_revision" : 0 }, { "display_name" : "Custom", "widgets" : [ { "label" : { "text" : "NETWORKING" }, "widget_id" : "LabelValueConfiguration_0d5c8a34-616b-44a1-8151-09362f4177e5", "weight" : 10005 } ], "shared" : true, "weight" : 1000, "resource_type" : "View", "id" : "dashboard_custom", "description" : "Custom Dashboard gives flexibility to user to add content on the dashboard, for entities of their choice. Please create views and add widgets using REST API to add content, useful to highlight status or summarize details.", "_create_time" : 1672635884565, "_create_user" : "system", "_last_modified_time" : 1672751592453, "_last_modified_user" : "system", "_system_owned" : true, "_protection" : "NOT_PROTECTED", "_revision" : 1 } ] }

Required Permissions:

read

Feature:

nsx_dashboard

Additional Errors: