Edit system alert forward configuration
Enable alert forwarding on each device, which forward system alerts to an SNMP trap server or a Syslog server.
Request
Security
| Any | Super User | System Admin | Security Admin | Operator |
|---|---|---|---|---|
| superUser | systemAdmin |
HTTP method
Syslog
POST /manager/api/{json|xml}/1.0/editSystemAlertForwardConfiguration.adm HTTP/1.1
Host:{manager.dsnet} enabled={true|false}&deviceTypes={device1}&deviceTypes={device2}
&enabledSyslog={true|false}&communityString={community}&facility={Facility}
&ipHostnameSyslog={ip1}&syslogAddressMap[{ip1}]={add|remove}&addHttpAcssLogSyslog={true|false}&addAuditsToSyslog={true|false}
SNMP
POST
/manager/api/{json|xml}/1.0/editSystemAlertForwardConfiguration.adm HTTP/1.1 Host:{manager.dsnet}
enabled={true|false}&deviceTypes={device1}&deviceTypes={device2}
&snmpNotificationType={inform}&snmpVersion=v3&usmUserSecurityLevel={authPriv|authNoPriv|noAuthNoPriv}
&usmUserUsername={user}&usmUserAuthenticationProtocol={SHA1|MD5}
&usmUserPrivacyProtocol={AES256|AES256With3DES|AES128|DES}&ipHostnameSnmpNotification={ip1}
&addHttpAccessLogSnmpNotification={true|false}&snmpNotificationAddressMap[{ip1}]={add|remove}
&addHttpAccessLogSnmpNotification={true|false}&usmUserAuthenticationPassword={password}
&usmUserPrivacyPassword={password}Curl method
Syslog
curl -X POST -u {admin}:{password} --header "Content-Type:
application/x-www-form-urlencoded" -k
'https://{manager.dsnet}/manager/api/{json|xml}/1.0/editSystemAlertForwardConfiguration.adm' -d
'enabled={true|false}&deviceTypes={device1}&deviceTypes={device2}&communityString={community}
&enabledSyslog={true|false}&ipHostnameSyslog={ip1}&syslogAddressMap[{ip1}]=add&facility={facility1}
&addHttpAccessLogSyslog={true|false}&addAuditsToSyslog={true|false}'
SNMP
curl -X POST -u {admin}:{password} --header "Content-Type:
application/x-www-form-urlencoded" -k
'https://{manager.dsnet}/manager/api/{json|xml}/1.0/editSystemAlertForwardConfiguration.adm' -d
'enabled={true|false}&deviceTypes={device1}&deviceTypes={device2}&snmpNotificationType={inform}
&snmpVersion=v3&usmUserSecurityLevel={authPriv|authNoPriv|noAuthNoPriv}&usmUserUsername={user}
&usmUserAuthenticationProtocol={SHA1|MD5}&usmUserPrivacyProtocol={AES256|AES256With3DES|AES128|DES}
&ipHostnameSnmpNotification={ip1}&addHttpAccessLogSnmpNotification={true|false}
&usmUserAuthenticationPassword={password}&usmUserPrivacyPassword={password}'
Parameters
| Parameter | Type | Usage | Default | Description |
|---|---|---|---|---|
| enabled | Boolean | Required |
Enable or disable all alert forwarding.
|
|
| snmpVersion | String | Required: "v2c" or "v3" | "v2c" | Specifies whether SNMPv2c or SNMPv3 is supported. |
| usmUserSecurityLevel | String | Required if version="v3" | Specifies the security level of USM user. | |
| usmUserUsername | String | Required if version="v3" | Specifies the username of the USM user. | |
| usmUserAuthenticationProtocol | String | Required if version="v3" | Specifies the authentication protocol of the USM user (SHA1 or MD5). | |
| usmUserAuthenticationPassword | String | Required if version="v3" | Specifies the authentication password of the USM user. | |
| usmUserPrivacyProtocol | String | Required if version="v3" | Specifies the privacy protocol of the USM user (AES256, AES256With3DES, AES128, DES) | |
| usmUserPrivacyPassword | String | Required if version="v3" | Specifies the privacy password of the USM user. | |
| deviceTypes | Set[{device}] | Required if enabled=true | List of device types to enable alert forwarding on. Device types are manager, accesser,
slicestor, smc, and gateway. At least one device type must be provided. |
|
| communityString | String | Required if version="v2c" | SNMP v2c community string. | |
| snmpNotificationType | String | trap/inform | Specifies whether to alert using SNMP traps or informs. If explicitly set to nothing, SNMP notification alerts are disabled. | |
| ipHostnameSnmpNotification | String | Optional |
Full list of IP/hostname targets to send SNMP notifications. Must contain full set of IP/hostnames. |
|
| snmpNotificationAddressMap | Map[{ipOrHostname}] | Optional |
IP/hostnames to add or remove from the previous list of notification receiver IP/hostnames. |
|
| addHttpAccessLogSnmpNotification | Boolean | Optional |
Include HTTP and Access log in SNMP notification alerts. |
|
| addAuditsToSyslog | Boolean | Optional |
Include Audits in the Syslog alerts. |
|
| enabledSyslog | Boolean | enabled=true |
Enable or disable alert forwarding for Syslog.
|
|
| ipHostnameSyslog | String | Optional |
Full list of IP/hostname targets to send Syslog alerts. Must contain the full set of IP/hostnames. |
|
| syslogAddressMap | Map[{ipOrHostname}] | Optional |
IP/hostnames to add or remove from the previous list of Syslog IP/hostnames. |
|
| facility | String | enabledSyslog=true | Syslog facility value. | |
| addHttpAccessLogSyslog | Boolean | enabledSyslog=true |
Include the HTTP and Access log in the Syslog alert. |
Response
Returns success or failure status.
JSON response example
Default JSON success or failure response that is shown in Default JSON success response and Default JSON failure response.
Parameters
None other than the default response parameters shown in Common response parameters.