The system administrator can enable or disable notification messages for events in a cloud.

Notifications are enabled by default. A system administrator can disable them.

This operation is restricted to system administrators.

1

Retrieve the SystemSettings element.

2

Examine the response to locate the link that you can use to retrieve the system's NotificationsSettings element.

This link has a rel attribute value of down and a type attribute value of application/vnd.vmware.admin.notificationsSettings+xml, as shown here:

<Link href="https://vcloud.example.com/admin/extension/settings/notifications"
   rel="down"
   type="application/vnd.vmware.admin.notificationsSettings+xml"/>
3

Enable or disable notifications.

a

Retrieve the NotificationsSettings element.

Make a GET request to the href value of the application/vnd.vmware.admin.notificationsSettings+xml link.

b

Modify the value of the EnableNotifications element to enable or disable notifications.

c

Update the modified element with the new contents.

PUT the modified element to the href value of its rel="edit" link.

This request sets the value of EnableNotifications to true. This is the default value, so you normally would not need to make this request unless notifications had been disabled by a previous request.

Request:

<?xml version="1.0" encoding="UTF-8"?>
<vmext:NotificationsSettings
   xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
   xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
   type="application/vnd.vmware.admin.notificationsSettings+xml">
   <vmext:EnableNotifications>true</vmext:EnableNotifications>
</vmext:NotificationsSettings>

The response contains information extracted from the request, and adds an edit link that you can use to change the value of this element.

Response:

200 OK
...
<vmext:NotificationsSettings
   xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
   xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
   href="https://vcloud.example.com/api/admin/extension/settings/notifications"
   type="application/vnd.vmware.admin.notificationsSettings+xml">
   <vcloud:Link
      rel="edit"
      href="https://vcloud.example.com/api/admin/extension/settings/notifications"
      type="application/vnd.vmware.admin.notificationsSettings+xml" />
   <vmext:EnableNotifications>true</vmext:EnableNotifications>
</vmext:NotificationsSettings>