Virtualization, Servers and Storage : How-to Manage Object Request Notifications

Created by JM Lopez, last modified on Jul 11, 2024

Introduction

When you submit a virtual machine deployment request, change request, snapshot request or any other request, the backing API would send an email notification upon submission and completion. However, if you wish to opt-out to receiving notifications or pick and choose which kind of notifications you wish to receive, you can do that by using either the API, the VSS Command Line Interface, or The Cloud Portal.

This how-to provides the steps to customize your account Object Notifications and choose a preferred notification format using the VSS Portal and CLI.

Enable/Disable notification

VSS Portal

  1. Login to the https://vss-portal.eis.utoronto.ca 

  2. Go to the top-right corner where your Gravatar image is shown.

  3. Click on Settings

  4. Check the desired notification settings: all, none or submission, error, completion.

  5. Click on Save.

Command-Line Interface

Using https://vss-cli.eis.utoronto.ca or a local VSS CLI install

  1. Display your existing notification preferences with vss-cli account get notification request

    vss-cli account get notification request

ALL                 : True
NONE                : False
COMPLETION          : False
ERROR               : False
SUBMISSION          : False

  2. To disable all email notification, execute vss-cli account set notification request none

    vss-cli account set notification request none

Notifications triggered by requests have been disabled.
ALL                 : False               
NONE                : True                
COMPLETION          : False               
ERROR               : False               
SUBMISSION          : False

  3. If you are interested in only receiving email notifications when an error happened, execute vss-cli account set notification request error

    vss-cli account set notification request error

Notifications triggered by request error have been enabled.
ALL                 : False               
NONE                : False               
COMPLETION          : False               
ERROR               : True                
SUBMISSION          : False

  4. To enable multiple notifications, please include the options as follows:

    vss account set notification request error completion

Notifications triggered by request error have been enabled.
ALL                 : False               
NONE                : False               
COMPLETION          : True               
ERROR               : True                
SUBMISSION          : False

For more information about user notifications, please refer to User Notification Settings

Notification format

VSS Portal

  1. Login to the https://vss-portal.eis.utoronto.ca 

  2. Go to the top-right corner where your Gravatar image is shown.

  3. Click on Settings

  4. Check the desired notification format: html or text

  5. Click on Save.

Command-Line Interface

Using https://vss-cli.eis.utoronto.ca or a local VSS CLI install

  1. Display your existing notification format with vss-cli account get notification format

    vss-cli account get notification format

ALL                 : html

  2. We are currently supporting two formats: html or text. If you are more comfortable receiving text rather than html, please run the following command:

    vss-cli account set notification format text

ALL                 : text

From now on, all incoming notifications will be using text format instead of HTML.



Attachments:

Screenshot 2018-02-06 11.36.15.png (image/png)
Screenshot 2018-02-06 11.50.45.png (image/png)
Screenshot 2019-04-01 11.43.16.png (image/png)
Screenshot 2019-04-01 11.43.22.png (image/png)
Screenshot 2019-04-01 11.43.22.png (image/png)
Screenshot 2019-04-01 11.48.50.png (image/png)
Screenshot 2019-04-01 11.50.50.png (image/png)