Alarm Extended Commands

There are five extended commands for managing alarms.

Alarm Command Parameters

The following parameters can be used by the extended commands for alarms. For details about the a and m parameters, refer to Predefined Parameters and Flags.

ack

The value of the ack parameter is a comma-separated list of values that indicate whether the alarms being managed have been acknowledged. Legal values for the ack parameter are ACK (Acknowledged) and NOACK (Not Acknowledged).

command

The value of the command parameter is the alarm action to be performed.

domain

The value of the domain parameter is the name of the Sun Management Center domain for which alarms are to be managed. If no domain is specified, the Default Domain is used.

mgtObj

The value of the mgtObj parameter is the name of the managed object for which alarms are to be managed.

note

The value of the note parameter is a text annotation for the command being run.

property

The value of the property parameter is the name of the property for which alarms are to be managed.

propInst

The value of the propInst parameter is the name of the specific property instance for which alarms are to be managed.

qualifier

The value of the qualifier parameter is the name of the qualifier that is associated with the managed property whose alarms are to be managed.

severity

The value of the severity parameter is a comma-separated list of severity values for the alarms being managed. The following values are allowed for the severity parameter:

• ERR — Error

• WRN — Warning

• INF — Informative

• IRR — Irrational

• DWN — Down

• DIS — Disabled

• OFF — Off

state

The value of the state parameter is a comma-separated list of state values for the alarms being managed. Legal values for the state parameter are Open, Closed, and Fixed.

Alarm Commands

You can examine alarm values and set alarm actions with the following commands:

ackAlarms

Description

The ackAlarms command acknowledges alarms in an agent or a list of agents.

Syntax

ackAlarms a=host[:port][,host[:port]]* [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [note=reason]

Parameters

a, domain, m, mgtObj, property, propInst, qualifier, severity, state, and note.

If no value is specified for the state parameter, state defaults to Open.

delAlarms

Description

The delAlarms command deletes alarms in an agent or a list of agents.

Syntax

delAlarms a=host[:port][,host[:port]]* [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [ack=ACK|NOACK] [note=reason]

Parameters

a, domain, m, mgtObj, property, propInst, qualifier, severity, state, ack, and note.

If no value is specified for the state parameter, state defaults to Closed.

getAlarms

Description

The getAlarms command retrieves alarm information for an agent or a set of agents.

Syntax

getAlarms a=host[:port][,host[:port]]* [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [ack=ACK|NOACK]

Parameters

a, domain, m, mgtObj, property, propInst, qualifier, severity, state, and ack.

If no parameters are specified, getAlarms returns all alarm information.

runAlarmAction

Description

The runAlarmAction command runs a manual or delayed alarm action for all alarms under a domain of an agent or a list of agents.

Syntax

runAlarmAction a=host[:port][,host[:port]]* [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [ack=ACK|NOACK]

Parameters

a, domain, m, mgtObj, property, propInst, qualifier, severity, state, and ack.

setAlarmAction

Description

The setAlarmAction command sets a manual or delayed alarm action for all alarms under a domain of an agent or a list of agents.

Syntax

setAlarmAction a=host[:port][,host[:port]]* command=command [domain=domain] [m=module[+instance][mgtObj=managedObject [property=property [propInst=propertyInstance] [qualifier=qualifier]]]] [severity=DIS|DWN|ERR|INF|IRR|OFF|WRN] [state=OPEN|CLOSED|FIXED] [ack=ACK|NOACK]

To set up email alerts for an alarm, the command format can either be

command="email.sh:<email-id>:<message>" or

command="email:<email-id>:<message>"

Parameters

a, command, domain, m, mgtObj, property, propInst, qualifier, severity, state, and ack.

Alarm Command Examples

The following command retrieves all alarms with severity of ERR or DWN from the host haiku:

> getAlarms a=haiku severity=ERR,DWN