Email report configuration

Edit online

Configure the IBM Cloud Object Storage Manager™ to send one or more reports to one or more email addresses.

The system can be set up to send emails periodically, daily or weekly.

Report emails are in HTML format with a CSV attachment.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Email Report Configuration API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/reportEmailConfiguration.adm HTTP/1.1 Host:{manager.dsnet} scheduled={true|false}&emailAddresses={name@email.com}&reports={driveReport|systemUsageAndConfigurationSummaryReport|failedFruReport|storagePoolUsageReport|deviceSummaryReport|vaultSummaryReport|eventReport|firmwareReport}&scheduleUnit={daily|weekly}&scheduleDailyTime={0..23}&scheduleWeeklyDay={1..7}&scheduleWeeklyTime={0..23}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/reportEmailConfiguration.adm“ -d ”scheduled={true|false}&emailAddresses={name@email.com}&reports={driveReport|systemUsageAndConfigurationSummaryReport|failedFruReport|storagePoolUsageReport|deviceSummaryReport|vaultSummaryReport|eventReport|firmwareReport}&scheduleUnit={daily|weekly}&scheduleDailyTime={0..23}&scheduleWeeklyDay={1..7}&scheduleWeeklyTime={0..23}“

Parameters

Edit online
Table 2. Request parameters for Email Report Configuration (reportEmailConfiguration) API method
Parameter Type Usage Default Description
scheduled Boolean    

Automatically schedule log collection. backupType and related parameters must be provided before automatic backup is enabled.
emailAddresses String    

List of email addresses to send specified reports.
reports String scheduled=true  

List of reports to send to given email addresses.

  • driveReport
  • systemUsageAndConfigurationSummaryReport
  • failedFruReport
  • storagePoolUsageReport
  • deviceSummaryReport
  • vaultSummaryReport
  • eventReport
  • firmwareReport
scheduleUnit String scheduled=true  

Type of schedule to create (daily or weekly). If weekly, the last week's logs are collected. Otherwise, past 24 hours of logs are collected.
scheduleDailyTime Integer scheduleUnit=daily 0

Number 0 - 23, inclusive, representing hour of day to collect logs.
scheduleWeeklyDay Integer scheduleUnit=weekly 1

Number 1 - 7, inclusive, representing day of week to collect logs: Sunday(1), Monday(2), … Saturday(7).
scheduleWeeklyTime Integer scheduleUnit=weekly 0

Number 0 - 23, inclusive, representing hour of day to collect logs.
Note: If no parameters are given, the previous configuration settings are retained.