PowerScaleOneFS CLI Command Reference

Syntax

isi event channels <name>
        [--type | -t {smtp | snmp | connectemc | supportassist}]
        [--enabled {true | false}]
        [--allowed-nodes <integer>]
        [--clear-allowed-nodes]
        [--add-allowed-nodes <integer>]
        [--remove-allowed-nodes <integer>]
        [--excluded-nodes <integer>]
        [--clear-excluded-nodes]
        [--add-excluded-nodes <integer>]
        [--remove-excluded-nodes <integer>]
        [--address <string>]
        [--clear-address]
        [--add-address <string>]
        [--remove-address <string>]
        [--send-as <string>]
        [--subject <string>]
        [--smtp-host <string>]
        [--smtp-port <integer>]
        [--smtp-use-auth <boolean>]
        [--smtp-username <string>]
        [--smtp-password <string>]
        [--smtp-security {STARTTLS | NONE}]
        [--batch {NONE | ALL | CATEGORY | SEVERITY}]
        [--batch-period <integer> <time>]
        [--host <string>]
        [--community <string>]
        [--use-snmp-trap {true | false}]
        [--snmp-use-v3 {true | false}]
        [--snmp-security-name <string>]
        [--snmp-security-level (noAuthNoPriv | authNoPriv | authPriv)]
        [--snmp-auth-protocol (MD5 | SHA)]
        [--snmp-auth-password <string>]
        [--snmp-priv-protocol (AES | DES)]
        [--snmp-priv-password <string>]
        [--snmp-engine-id <string>]
        [--verbose | -v]

Options

<name>

Specifies the name of the channel you want to modify.

<type>

Specifies the mechanism by which alerts are sent.

Type values are case sensitive. The following values are valid:

smtp

Alerts are sent as emails through an SMTP server.

snmp

Alerts are sent through SNMP.

connectemc

Alerts are sent through ConnectEMC.

supportassist

Alerts are sent through supportassist.

--enabled {true | false}

Specifies whether the channel is enabled.

--allowed-nodes <integer>...

Specifies one or more nodes that are allowed to send alerts through the channel. If you do not specify any allowed nodes, all nodes in the cluster will be allowed to send alerts. The value of <integer> is the logical node number (LNN) you want to allow. Specify --allowed-nodes for each additional LNN.

--clear-allowed-nodes

Clears all values for allowed nodes.

--add-allowed-nodes <integer>...

Adds one or more nodes to the allowed nodes list. The value of <integer> is the logical node number (LNN) you want to allow. Specify --add-allowed-nodes for each additional LNN.

--remove-allowed-nodes <integer>...

Removes one or more nodes from the allowed nodes list. The value of <integer> is the logical node number (LNN) you want to remove. Specify --remove-allowed-nodes for each additional LNN.

--excluded-nodes <integer>...

Specifies one or more nodes that are not allowed to send alerts through the channel. The value of <integer> is the logical node number (LNN) you want to exclude. Specify --excluded-nodes for each additional LNN.

--clear-excluded-nodes

Clears all values for excluded nodes.

--add-excluded-nodes <integer>...

Adds one or more nodes to the excluded nodes list. The value of <integer> is the logical node number (LNN) you want to exclude. Specify --add-excluded-nodes for each additional LNN.

--remove-excluded-nodes <integer>...

Removes one or more nodes from the excluded nodes list. The value of <integer> is the logical node number (LNN) you want to remove. Specify --remove-excluded-nodes for each additional LNN.

--address <string>...

For SMTP channels only. Specifies one or more email addresses you want to receive alerts on this channel. The value of <string> is an email address. Specify --address for each additional email address.

--clear-address

For SMTP channels only. Clears all values for email addresses.

--add-address <string>...

For SMTP channels only. Specifies one or more email addresses you want to add to the alert distribution list for this channel. The value of <string> is an email address. Specify --add-address for each additional email address.

--remove-address <string>...

For SMTP channels only. Specifies one or more email addresses you want to remove from the alert distribution list for this channel. The value of <string> is an email address. Specify --remove address for each additional address to remove.

--send-as <string>

For SMTP channels only. Specifies the email address you want to send alerts from on this channel. The value of <string> is an email address.

--subject <string>

For SMTP channels only. Specifies the subject line for emails sent on this channel.

--smtp-host <string>

For SMTP channels only. Specifies the SMTP relay host. Overrides value set in isi email settings.

--smtp-port <integer>

For SMTP channels only. Specifies the SMTP relay port. verrides value set in isi email settings.

--smtp-use-auth {true | false}

For SMTP channels only. Enables or disables SMTP authentication. verrides value set in isi email settings.

--smtp-username <string>

For SMTP channels only. Specifies the username for SMTP authentication. verrides value set in isi email settings.

--smtp-password <string>

For SMTP channels only. Specifies the password for SMTP authentication. verrides value set in isi email settings.

--smtp-security {STARTTLS | NONE}

For SMTP channels only. Enables or disables SMTP encryption. verrides value set in isi email settings.

--batch {NONE | ALL | CATEGORY | SEVERITY}

For SMTP channels only. Specifies how SMTP alerts will be batched.

--batch-period <integer> <time>

For SMTP channels only. Specifies the interval between batched alerts.

The following <time> values are valid:

Y

Specifies years

M

Specifies months

W

Specifies weeks

D

Specifies days

H

Specifies hours

m

Specifies minutes

s

Specifies seconds

--host <string>

For SNMP channels only. Specifies the host name or address

--community <string>

For SNMP channels only. Specifies the community string.

--use-snmp-trap <boolean>

For SNMP channels only. Use snmptrap instead of snmpinform for this channel.

--snmp-use-v3 <boolean>

For SNMP channels only. Specifies using version 3 traps for this channel.

--snmp-security-name <string>

For SNMP channels only. Specifies the name for the version 3 user.

--snmp-security-level {noAuthNoPriv | authNoPriv | authPriv}

Specifies the SNMPv3 security level for this channel. Default value is authPriv.

--snmp-auth-protocol {MD5 | SHA}

Specifies the SNMPv3 authentication algorithm to use for this channel. Default value is SHA.

--snmp-auth-password <string>

Specifies the SNMPv3 authentication password.

--snmp-priv-protocol {AES | DES}

Specifies the SNMPv3 encryption algorithm to use for this channel. Default value is AES

--snmp-priv-password <string>

Specifies the SNMPv3 encryption password.

--snmp-engine-id <string>

Specifies the SNMPv3 engine ID of the receiving trap daemon.

{--verbose | -v}

Displays more detailed information.