[{"label":"Latest (v1.0)","version":"latest"}]

vmware-sase-platform

EdgeResource

Properties

string

_href Optional

string

activationKey Optional

string as date-time

activationKeyExpires Optional

string

activationState Optional

Possible values are: UNASSIGNED , PENDING , ACTIVATED , REACTIVATION_PENDING

string as date-time

activationTime Optional

boolean

alertsEnabled Optional

string

bastionState Optional

Possible values are: UNCONFIGURED , STAGE_REQUESTED , UNSTAGE_REQUESTED , STAGED , UNSTAGED , PROMOTION_REQUESTED , PROMOTION_PENDING , PROMOTED

string

buildNumber Optional

string as date-time

created Optional

string

customInfo Optional

string

description Optional

string

deviceFamily Optional

string

deviceId Optional

string

dnsName Optional

string

edgeState Optional

Possible values are: NEVER_ACTIVATED , DEGRADED , OFFLINE , DISABLED , EXPIRED , CONNECTED

string as date-time

edgeStateTime Optional

string

endpointPkiMode Optional

Possible values are: CERTIFICATE_DISABLED , CERTIFICATE_OPTIONAL , CERTIFICATE_REQUIRED

EnterpriseResource

enterprise Optional

string

factoryBuildNumber Optional

string

factorySoftwareVersion Optional

string as date-time

haLastContact Optional

string

haMode Optional

string

haPreviousState Optional

Possible values are: UNCONFIGURED , PENDING_INIT , PENDING_CONFIRMATION , PENDING_CONFIRMED , PENDING_DISSOCIATION , READY , FAILED

string

haSerialNumber Optional

string

haState Optional

Possible values are: UNCONFIGURED , PENDING_INIT , PENDING_CONFIRMATION , PENDING_CONFIRMED , PENDING_DISSOCIATION , READY , FAILED

boolean

isLive Optional

string as date-time

lastContact Optional

This field is deprecated. Please use “edgeState” to get updated edge status calculated by the Orchestrator.

array of BaseApiResource

links Optional

string

logicalId Optional

string

lteRegion Optional

string

modelNumber Optional

string

modemBuildNumber Optional

string

modemFirmwareVersion Optional

string as date-time

modified Optional

string

name Optional

boolean

operatorAlertsEnabled Optional

string

platformBuildNumber Optional

string

platformFirmwareVersion Optional

string

selfMacAddress Optional

string

serialNumber Optional

string

serviceState Optional

Possible values are: IN_SERVICE , OUT_OF_SERVICE , PENDING_SERVICE

string as date-time

serviceUpSince Optional

SiteResource

site Optional

string as date-time

softwareUpdated Optional

string

softwareVersion Optional

string

standbyBuildNumber Optional

string

standbyDeviceId Optional

string

standbyFactoryBuildNumber Optional

string

standbyFactorySoftwareVersion Optional

string

standbyModelNumber Optional

string as date-time

standbyServiceUpSince Optional

string

standbySoftwareVersion Optional

string as date-time

standbySystemUpSince Optional

string as date-time

systemUpSince Optional

JSON Example

{
	"_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",
	"haMode": "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",
	"standbyBuildNumber": "string",
	"standbyDeviceId": "string",
	"standbyFactoryBuildNumber": "string",
	"standbyFactorySoftwareVersion": "string",
	"standbyModelNumber": "string",
	"standbyServiceUpSince": "string",
	"standbySoftwareVersion": "string",
	"standbySystemUpSince": "string",
	"systemUpSince": "string"
}

[{"label":"Latest (v1.0)","version":"latest"}]

vmware-sase-platform

Property Of

BgpSessionResource
ClientDeviceResource
EdgeResourceCollection
EnterpriseAlertsResource
EnterpriseEventResource
EnterpriseHealthStatsResource
EnterpriseLinkStatsRecord
LinkResource
NonSDWANTunnel
SDWANPeerPathDestNodeEdgeLinkSchema
SDWANPeerPathSourceNode

Returned By

Get Enterprise Edge
Create Edge
Update Edge

EdgeResource

Properties

JSON Example

Property Of

Returned By

Was this page helpful?