[{"label":"Latest (2022-09-01)","version":"latest"},{"version":"v1.0"}]
vmware-sase-platform

Get Edge Non Sdwan Tunnel Status via Edge

Description

Fetch Edge non-SD-WAN tunnel status

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/nonSdWanTunnelStatus
Copy

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


string
edgeLogicalId Required

The logicalId GUID for the target edge


Query Parameters

Query Parameters

integer
end Optional

Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.


string
include Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.


string
sortBy Optional

sortBy query param to sort the resultset. Format of sortBy is <ASC | DESC>


integer
start Optional

Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.


InlineApiSdwanV2EnterprisesEnterpriseLogicalIdEdgesEdgeLogicalIdNonSdWanTunnelStatus_state
state Optional

Filter by non-SD-WAN tunnel state


string
state[in] Optional

Filter by state[in]


string
state[isNot] Optional

Filter by state[isNot]


string
state[is] Optional

Filter by state[is]


string
state[notIn] Optional

Filter by state[notIn]


Response

Response

Response Body

Response Body

200 OK

Returns EdgeNonSDWANTunnelStatus of type application/json

Request successfully processed

{
	"_href": "string",
	"data": [
		{
			"link": {
				"_href": "string",
				"alertsEnabled": false,
				"backupState": "UNCONFIGURED",
				"created": "string",
				"displayName": "string",
				"edge": {
					"_href": "string",
					"activationKey": "string",
					"activationKeyExpires": "string",
					"activationState": "UNASSIGNED",
					"activationTime": "string",
					"alertsEnabled": false,
					"bastionState": "UNCONFIGURED",
					"buildNumber": "string",
					"created": "string",
					"customInfo": "string",
					"description": "string",
					"deviceFamily": "string",
					"deviceId": "string",
					"dnsName": "string",
					"edgeState": "NEVER_ACTIVATED",
					"edgeStateTime": "string",
					"endpointPkiMode": "CERTIFICATE_DISABLED",
					"enterprise": {
						"_href": "string",
						"accountNumber": "string",
						"alertsEnabled": false,
						"bastionState": "UNCONFIGURED",
						"city": "string",
						"contactEmail": "string",
						"contactMobile": "string",
						"contactName": "string",
						"contactPhone": "string",
						"country": "string",
						"created": "string",
						"description": "string",
						"domain": "string",
						"endpointPkiMode": "CERTIFICATE_DISABLED",
						"gatewayPool": {
							"_href": "string"
						},
						"lat": 0,
						"locale": "string",
						"logicalId": "string",
						"lon": 0,
						"modified": "string",
						"name": "string",
						"operatorAlertsEnabled": false,
						"postalCode": "string",
						"prefix": "string",
						"state": "string",
						"streetAddress": "string",
						"streetAddress2": "string",
						"timezone": "string"
					},
					"factoryBuildNumber": "string",
					"factorySoftwareVersion": "string",
					"haLastContact": "string",
					"haPreviousState": "UNCONFIGURED",
					"haSerialNumber": "string",
					"haState": "UNCONFIGURED",
					"isLive": false,
					"lastContact": "string",
					"links": [
						{
							"_href": "string"
						}
					],
					"logicalId": "string",
					"lteRegion": "string",
					"modelNumber": "string",
					"modemBuildNumber": "string",
					"modemFirmwareVersion": "string",
					"modified": "string",
					"name": "string",
					"operatorAlertsEnabled": false,
					"platformBuildNumber": "string",
					"platformFirmwareVersion": "string",
					"selfMacAddress": "string",
					"serialNumber": "string",
					"serviceState": "IN_SERVICE",
					"serviceUpSince": "string",
					"site": {
						"_href": "string",
						"city": "string",
						"contactEmail": "string",
						"contactMobile": "string",
						"contactName": "string",
						"contactPhone": "string",
						"country": "string",
						"created": "string",
						"lat": 0,
						"locale": "string",
						"lon": 0,
						"modified": "string",
						"name": "string",
						"postalCode": "string",
						"shippingAddress": "string",
						"shippingAddress2": "string",
						"shippingCity": "string",
						"shippingContactName": "string",
						"shippingCountry": "string",
						"shippingPostalCode": "string",
						"shippingSameAsLocation": false,
						"shippingState": "string",
						"state": "string",
						"streetAddress": "string",
						"streetAddress2": "string",
						"timezone": "string"
					},
					"softwareUpdated": "string",
					"softwareVersion": "string",
					"systemUpSince": "string"
				},
				"interface": "string",
				"internalId": "string",
				"ipAddress": "string",
				"ipV6Address": "string",
				"isp": "string",
				"lastActive": "string",
				"lastEvent": "string",
				"lastEventState": "UNKNOWN",
				"lat": 0,
				"linkMode": "ACTIVE",
				"logicalId": "string",
				"lon": 0,
				"macAddress": "string",
				"modified": "string",
				"netmask": "string",
				"networkSide": "UNKOWN",
				"networkType": "UNKNOWN",
				"operatorAlertsEnabled": false,
				"org": "string",
				"serviceState": "IN_SERVICE",
				"state": "UNKNOWN",
				"userOverride": false
			},
			"local_interface_ip": "string",
			"local_public_ip": "string",
			"nvs_ip": "string",
			"pathId": "string",
			"provider": {
				"_href": "string",
				"type": "string"
			},
			"segment": {
				"_href": "string"
			},
			"site": {
				"_href": "string",
				"city": "string",
				"contactEmail": "string",
				"contactMobile": "string",
				"contactName": "string",
				"contactPhone": "string",
				"country": "string",
				"created": "string",
				"lat": 0,
				"locale": "string",
				"lon": 0,
				"modified": "string",
				"name": "string",
				"postalCode": "string",
				"shippingAddress": "string",
				"shippingAddress2": "string",
				"shippingCity": "string",
				"shippingContactName": "string",
				"shippingCountry": "string",
				"shippingPostalCode": "string",
				"shippingSameAsLocation": false,
				"shippingState": "string",
				"state": "string",
				"streetAddress": "string",
				"streetAddress2": "string",
				"timezone": "string"
			},
			"state": "PENDING",
			"timestamp": "string"
		}
	],
	"metaData": {
		"limit": 0,
		"more": false,
		"nextPageLink": "string",
		"prevPageLink": "string"
	}
}
string
_href Optional


Errors

Errors

400

ValidationError


401

Unauthorized


404

Resource not found


429

Rate Limit Exceeded


500

Internal server error

Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/nonSdWanTunnelStatus


Feedback

Was this page helpful?