Patch

/eventdefinitionconfigs/{id}/

This endpoint modifies the global event definition configuration which includes the default actions triggered by alarms.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Event Definition Configuration ID

Body parameters

object

smtp_host

string

SMTP server host name for alert emails.

smtp_port

string

The port used by the SMTP server to send outgoing emails.

smtp_user

string

User for SMTP authentication

smtp_password

string

Password for SMTP authentication

smtp_use_tls

boolean

Set to true to send email over a TLS connection.

email_subject

string

Optional and global email subject for all alarm notification emails. Leave blank to send alarm info in the subject.

email_sender

string

Global for all alarm notification emails, the sender email that appears in the emails.

email_recipients

Array of string

Default email recipients. These recipients receive notifications of all alarms except those triggered by events that have a different list of email recipients specified in the event definition or for which actions are disabled.

string

syslog_host

string

The syslog server's IP address, for sending event logs to a syslog server.

syslog_port

string

The port number used by the syslog server to listen on for syslog requests.

syslog_protocol

string

The protocol used for communicating with the remote syslog server.

Valid values[ "tcp", "udp" ]

syslog_secure_audit

boolean

/var/log/secure logs audit

syslog_vms_audit

boolean

VMS audit

syslog_shell_audit

boolean

CNode and DNode shell commands

syslog_ipmi_audit

boolean

CNode and DNode IPMI commands

audit_logs_retention

integer

Audit logs retention in days

quota_email_suffix

string

A default suffix to add to append to user names to form an email address. This is used as the email recipient address for sending a user user quota alert emails. It is only used if an email address is not found for the user on a provider.

quota_email_provider

string

Specify which query context should be used to query providers for user quota alert emails. 'Aggregated' will perform an aggregated query of all providers. Alternatively, you can specify a specific provider if connected to the cluster.

Valid values[ "aggregated", "ldap", "ad" ]

quota_email_interval

string

The minimal interval time between quota alert emails sent to a user.

quota_email_hourly_limit

integer

Maximum quota alert emails VMS will send per hour

disable_actions

boolean

Set to true to disable default actions for events.

enabled

boolean

info_value

string

Maps INFO severity to a different severity value. Default: INFO

Valid values[ "INFO", "MINOR", "MAJOR", "CRITICAL" ]

minor_value

string

Maps MINOR severity to a different severity value. Default: MINOR

Valid values[ "INFO", "MINOR", "MAJOR", "CRITICAL" ]

major_value

string

Maps MAJOR severity to a different severity value. Default: MAJOR

Valid values[ "INFO", "MINOR", "MAJOR", "CRITICAL" ]

critical_value

string

Maps CRITICAL severity to a different value. Default: CRITICAL

Valid values[ "INFO", "MINOR", "MAJOR", "CRITICAL" ]

Responses

200

Modify Event Definition Configuration