Monitoring Get Enterprise Edge Nvs Tunnel Status

Monitoring Get Enterprise Edge Nvs Tunnel Status

Returns an array where each entry represents an Edge-reported state change in a tunnel to a non-SD-WAN site or service (e.g. a data center or cloud security service). Tunnels are uniqiuely identified by a dataKey which corresponds to an Edge-generated pathId.

Privileges required:

READ NETWORK_SERVICE

Request
URI
POST
https://{api_host}/portal/rest/monitoring/getEnterpriseEdgeNvsTunnelStatus
COPY
Request Body
{
    "enterpriseId": 0,
    "edgeId": 0,
    "tag": "string",
    "providerObjectId": 0
}
integer
enterpriseId
Optional

enterpriseId

integer
edgeId
Optional

edgeId

string
tag
Optional

tag

integer
providerObjectId
Optional

providerObjectId

Responses
200

Request was successfully processed

Returns Array of monitoring_get_enterprise_edge_nvs_tunnel_status_result_item of type(s) application/json 
[
    {
        "id": 0,
        "timestamp": "string",
        "enterpriseId": 0,
        "edgeId": 0,
        "enterpriseObjectId": 0,
        "tag": "string",
        "state": "string",
        "dataKey": "string",
        "data": {
            "name": "string",
            "nvs": "string",
            "link": "string",
            "segmentLogicalId": "string",
            "segmentId": 0,
            "local_interface_ip": "string",
            "local_public_ip": "string",
            "nvs_ip": "string",
            "routing": "string",
            "pathId": "string",
            "ikeIdType": "string",
            "ikeIdValue": "string",
            "state": "string",
            "provider": {},
            "site": {}
        },
        "edgeName": "string",
        "edgeLogicalId": "string",
        "edgeState": "string"
    }
]

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

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

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/portal/rest/monitoring/getEnterpriseEdgeNvsTunnelStatus
On This Page
All Operations
POST
Monitoring Get Aggregate Edge Link Metrics
POST
Monitoring Get Aggregate Enterprise Events
POST
Monitoring Get Aggregates
POST
Monitoring Get Enterprise Aggregate Edge Nvs Tunnel Status
POST
Monitoring Get Enterprise Bgp Peer Status
POST
Monitoring Get Enterprise Edge Bfd Peer Status
POST
Monitoring Get Enterprise Edge Bgp Peer Status
POST
Monitoring Get Enterprise Edge Cluster Status
POST
Monitoring Get Enterprise Edge Link Status
POST
Monitoring Get Enterprise Edge Nvs Tunnel Status
POST
Monitoring Get Enterprise Edge Status
POST
Monitoring Get Network Gateway Status
POST
Monitoring Get Vpn Edge Action Status
POST
Monitoring Get Vpn Site Status
POST
Monitoring Get Wss Location Creation Status