Esx.Settings.Notification

Esx.Settings.Notification
Esx.Settings.Notification

The Esx.Settings.Notification schema contains properties to describe any info/warning/error messages that Tasks can raise.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "type": "string",
    "id": "string",
    "time": "string",
    "message": "Vapi.Std.LocalizableMessage Object",
    "resolution": "Vapi.Std.LocalizableMessage Object",
    "originator": "string",
    "retriable": false
}
string
type
Optional

Type of the notification.

Possible values:

  • INFO
  • WARNING
  • ERROR

For more information see: Esx.Settings.Notification.Type.

This property was added in vSphere API 7.0.2.0.

This property is optional because it was added in a newer version than its parent node.

string
id
Required

The notification id.

This property was added in vSphere API 7.0.0.0.

string As date-time As date-time
time
Required

The time the notification was raised/found.

This property was added in vSphere API 7.0.0.0.

message
Required

The notification message.

This property was added in vSphere API 7.0.0.0.

resolution
Optional

The resolution message, if any.

This property was added in vSphere API 7.0.0.0.

Only set if there is a resolution available for this notification.

string
originator
Optional

The originator of the notification.

This property was added in vSphere API 7.0.2.0.

Only set if there is an originator available for this notification.

boolean
retriable
Optional

Indicates whether the error is retriable.

This property was added in vSphere API 7.0.2.0.

Only set for the notification when a retriable error was reported by the task.

Property Of