VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
VMware Sase Platform API VMware SD-WAN Orchestration API v2 Data Structures

EnterpriseAlertsResource

Properties

string
_href Optional
string
comment Optional
string as date-time
created Optional
EdgeResource
edge Optional
integer
firstNotificationSeconds Optional
string as date-time
lastContact Optional
LinkResource
link Optional
string
locale Optional
integer
maxNotifications Optional
string as date-time
modified Optional
string
name Optional

Possible values are: EDGE_DOWN , EDGE_UP , LINK_DOWN , LINK_UP , VPN_TUNNEL_DOWN , EDGE_HA_FAILOVER , EDGE_SERVICE_DOWN , GATEWAY_SERVICE_DOWN , VNF_VM_EVENT , VNF_VM_DEPLOYED , VNF_VM_POWERED_ON , VNF_VM_POWERED_OFF , VNF_VM_DEPLOYED_AND_POWERED_OFF , VNF_VM_DELETED , VNF_VM_ERROR , VNF_INSERTION_EVENT , VNF_INSERTION_ENABLED , VNF_INSERTION_DISABLED , TEST_ALERT , EDGE_CSS_TUNNEL_DOWN , EDGE_CSS_TUNNEL_UP , NVS_FROM_EDGE_TUNNEL_DOWN , NVS_FROM_EDGE_TUNNEL_UP , VNF_IMAGE_DOWNLOAD_EVENT , VNF_IMAGE_DOWNLOAD_IN_PROGRESS , VNF_IMAGE_DOWNLOAD_COMPLETED , VNF_IMAGE_DOWNLOAD_FAILED , PGW_NNI_INTERFACE_UP , PGW_NNI_INTERFACE_DOWN , PGW_NNI_BGP_ENABLED , PGW_NNI_BGP_DISABLED

string as date-time
nextNotificationTime Optional
integer
notificationIntervalSeconds Optional
array of EnterpriseAlertNotification
notifications Optional
integer
remainingNotifications Optional
integer
resetIntervalSeconds Optional
string
state Optional

Possible values are: PENDING , ACTIVE , CLOSED

string as date-time
stateSetTime Optional
string
timezone Optional
string as date-time
triggerTime Optional
string
type Optional

Possible values are: EDGE_DOWN , EDGE_UP , LINK_DOWN , LINK_UP , VPN_TUNNEL_DOWN , EDGE_HA_FAILOVER , EDGE_SERVICE_DOWN , GATEWAY_SERVICE_DOWN , VNF_VM_EVENT , VNF_VM_DEPLOYED , VNF_VM_POWERED_ON , VNF_VM_POWERED_OFF , VNF_VM_DEPLOYED_AND_POWERED_OFF , VNF_VM_DELETED , VNF_VM_ERROR , VNF_INSERTION_EVENT , VNF_INSERTION_ENABLED , VNF_INSERTION_DISABLED , TEST_ALERT , EDGE_CSS_TUNNEL_DOWN , EDGE_CSS_TUNNEL_UP , NVS_FROM_EDGE_TUNNEL_DOWN , NVS_FROM_EDGE_TUNNEL_UP , VNF_IMAGE_DOWNLOAD_EVENT , VNF_IMAGE_DOWNLOAD_IN_PROGRESS , VNF_IMAGE_DOWNLOAD_COMPLETED , VNF_IMAGE_DOWNLOAD_FAILED , PGW_NNI_INTERFACE_UP , PGW_NNI_INTERFACE_DOWN , PGW_NNI_BGP_ENABLED , PGW_NNI_BGP_DISABLED

JSON Example

{
	"_href": "string",
	"comment": "string",
	"created": "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",
		"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"
	},
	"firstNotificationSeconds": 0,
	"lastContact": "string",
	"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",
			"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"
		},
		"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
	},
	"locale": "string",
	"maxNotifications": 0,
	"modified": "string",
	"name": "EDGE_DOWN",
	"nextNotificationTime": "string",
	"notificationIntervalSeconds": 0,
	"notifications": [
		{
			"created": "string",
			"emailEnabled": 0,
			"emailList": "string",
			"emailText": "string",
			"enterpriseUserList": [
				{
					"email": "string",
					"emailEnabled": 0,
					"enabled": 0,
					"mobileEnabled": 0,
					"mobilePhone": "string",
					"smsEnabled": 0,
					"username": "string"
				}
			],
			"mobileEnabled": 0,
			"mobileList": "string",
			"mobileText": "string",
			"modified": "string",
			"smsEnabled": 0,
			"smsList": "string",
			"smsText": "string",
			"snmpEnabled": 0,
			"snmpList": "string"
		}
	],
	"remainingNotifications": 0,
	"resetIntervalSeconds": 0,
	"state": "PENDING",
	"stateSetTime": "string",
	"timezone": "string",
	"triggerTime": "string",
	"type": "EDGE_DOWN"
}
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
Property Of

EnterpriseAlertsSchema

Generated on: 01 Jun 23 10:48 UTC
Feedback

Was this page helpful?

© 2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us