Syslog Adapter parameters shows the complete list of parameters that can be defined for a notification forwarded to the Global Manager by the Syslog Adapter.

Note:

If no parameter values are set within the MODIFY_ATTRIBUTES rule, then the values set in the Output variables section are used.

Table 1. Syslog Adapter parameters

Parameter

Corresponding standard notification attribute or description

Valid values

AGG_EVENTNAME

This is the event name of the aggregate notification and is required if you are creating an aggregate.

<string>

AGG_ELEMENTNAME

This is the name of the topology element where the aggregate event occurs. This field is optional. If this field is not defined, the ElementClassName and ElementName of the trap definition are used, if available. Otherwise, the ClassName and InstanceName are used.

If you define this field and specify an object-handle that does not exist in the topology, then the aggregate is not created.

<object-handle>

AGG_EVENTTEXT

This is the description of the aggregate notification (event). This field is optional.

<string>

CATEGORY

Category

Any string

CLASSNAME

ClassName and DisplayClassName

Any string

CLEARONACKNOWLEDGE

ClearOnAcknowledge

TRUE or FALSE

CLEAR_SYSLOG

Controls whether a given syslog message clears an already existing notification or results in a notify.

The default is FALSE, all syslog messages result in notifications.

All syslog messages result in notifications unless the syslog messages are processed by subsequent MODIFY_ATTRIBUTES rules, which override the default.

TRUE or FALSE

DISCARD

Controls whether a given syslog message is discarded or processed.

The default is TRUE, all syslog messages are discarded.

To override the default and process a syslog message, create a rule to process this syslog message. Within this rule, DISCARD should be set to FALSE.

TRUE or FALSE

ELEMENTCLASSNAME

ElementClassName

Valid Class Name in VMware Smart Assurance topology

ELEMENTINSTANCENAME

ElementName

Valid Instance Name in VMware Smart Assurance topology

EVENTNAME

EventName (describing the notification) and the EventDisplayName

Any string

EVENTTEXT

EventText

Any string

EVENTTYPE

EventType

MOMENTARY or DURABLE

EXPIRATION

Defines the expiration time in seconds for the notification. Zero indicates that the notification will not expire. 7200 is the default value.

If you use zero, you should use some method to eventually clear the notification. For example, you can configure the Syslog Adapter to send clear state notifications or set the ClearOnAcknowlege parameter to TRUE.

Integer

INMAINTENANCE

InMaintenance

TRUE or FALSE

INSTANCENAME

InstanceName (of the object associated with the notification) and InstanceDisplayName

Any string

LOGFILE

The name of the file used by the SNMP Trap Receiver to log information for this trap. If this parameter is ’NONE’ or not defined, no information is logged.

Filename

SEVERITY

Severity

Any integer from 1 to 5

STATE

Describes the state of the notification.

This option is deprecated; its function is replaced by CLEAR_SYSLOG.

NOTIFY or CLEAR

SYSNAMEORADDR

A valid value describes either the system name or address of the entity that sent the trap. Values for this parameter override values in ElementClass and ElementInstance.

Any string

UNKNOWNAGENT

Describes whether Adapter Platform should ignore traps related to unknown topology elements or create elements for the traps.

CREATE or IGNORE

USERDEFINED1-10

UserDefined1-10

Any string