User Guide: Vista Manager SNMP Plug-in version 2.9.1

# Action Command

Action Command List
Create Action Commands
Parameters
Special Variables
Action Command Details
Update Action Command

Action Command defines an action to take when some event (error, trap reception etc.) occurs.
You can configure which action to take on a specifc event on Screen Reference > System > Event Filter.

## Action Command List

> Note

> > By clicking a column header (eg. "Command Type" or "Memo"), you can sort the list by the column. Order (ascending or descending) can be toggled by clicking the header.

Table 1: Action Command List
Item | Content
--- | ---
Items per page | Lets you select a number of action commands displayed on a single page.
"Create" button | Lets you add a new action command. Add Action Command page will appear.
Copy to Clipboard | Copies the action command list (ID, command type, memo) to clipboard as a tab-delimited text. It is useful when you want to copy a list to your text editor. You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.
Export to CSV file | Exports the action command list (ID, command type, memo) to a CSV file. You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.
Export to Excel | Exports the action command list (ID, command type, memo) to an Excel book file (.xlsx for Microsoft Excel 2007 or later). You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.
Print | Shows the action command list (ID, command type, memo) on another browser window or tab and opens a print dialog box. You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.
Search field | Lets you filter target subnets by keywords. The search ignores case.
ID | Shows an ID of the action command determined on its creation.
Command Type | Shows the action commands type.
Notes | Shows a note on the action command.
"Edit" button | Opens Update Action Command for the action command.
"Details" button | Opens Action Command Details for the action command.
"Delete" button | Opens "Delete Action Command" dialog box. Clicking "Yes" in the dialog box deletes the action command. Click "No" or "Close (x)" button at the top left of the dialog box allows you to cancel the delete operation and goes back to "Event Filter List" page.
Page Navigation | Lets you view a specific page of the list. First Shows the first page. Previous Shows the previous page. Page Number When you click a page number, the page will be shown. Current page number is grayed out. Next Shows the next page. Last Shows the last page.

## Create Action Commands

This screen lets you create a new action command.

Table 2: Create Action Command
Item | Content
--- | ---
Command Type | Lets you select a command type from the dropdown list of pre-defined types. Send Email: Uses "minimail" email client which is accompanied with the SNMP Plug-in. minimail is a simple email client which can be run from CLI. The program can only send emails and cannot receive them. It can check errors in parameter values only. If you use "Send Mail" action command for an event, test it on Command Prompt and make sure that emails are sent as expected. Run Route Test Command: Runs ping test. You can enter "Parameter" field. Custom Command: Runs an arbitrary program on the server. You can enter "Command" and "Parameter" fields.
Command | Enter a fullpath to the command to run on the server when you specified "Custom Command" for "Command Type". Note You cannot browse programs on SNMP Plug-in's web interface. If you want to browse them, use Server Configuration > Action Command Configuration Utility instead.
Option | You can specify detailed options to a pre-defined or custom command. Refer to Parameters for more details. You can also use special variables related to events in option parameters. Refer to Special Variables about them.
Notes | Lets you add a description of the command. Should be 1 to 4,096 characters in length, with alhabets, numbers, and symbols (including spaces). By default, it has pre-defined text depending on the selected command type. You can change the text to help you later remember what the command does.
"Create" button | Save the newly created action command configuration.

### Parameters

When you use "Send Mail" or "Run Route Test Command" action command, specify the following parameters.
◼ Send Mail
Syntax: <server name> <option>...

- <server name>:
  Mail server name (required)
- <option>:

  Table 3: "Send Mail" option parameters
  Parameter Name | Description
  --- | ---
  SMTPServer | (required) SMTP server name This must be the first parameter after the command name (minimail).
  -p port or --port port | Specify the port number.
  -f addr or --from (((param|addr | Sender email address
  -t addr [,addr .. ] or --to addr [,addr .. ] | (required) recipient email address. Use commas(,) to specify multiple addresses.
  -c addr [,addr .. ] or --cc addr [,addr .. ] | Carbon copy email address. Use commas(,) to specify multiple addresses.
  -b addr [,addr .. ] or --bcc addr [,addr ..] | Blind carbon copy email address. Use commas(,) to specify multiple addresses.
  -r addr or --replyto addr | Reply-To email address
  -s string or --subject string | (required) email subject Note You can use special variables described in Action Command.
  -m "content" or --mailbody "content" | (required if --mailfile is not specified) Specify a body text in double-quotes. Use "\n" for newline. This cannot be used when --mailfile parameter is specified. Note You can use special variables described in Action Command.
  -i filename or --mailfile filename | (required if --mailbody is not specified) Specify a text file name which contains email body text. This cannot be used when --mailbody parameter is specified.
  -a filename or --attach filename | Specify an attachment filename.
  -e {Base64|UUENCODE} or --encode {Base64|UUENCODE} | Specify a Binary-to-ASCII encoding scheme for the attachment. The default is Base64.
  -@ {JIS7|UTF8} or --charset {JIS7|UTF8} | Specifies the character set from either JIS7 or UTF8.
  -B or --OP25B | Specify when using OP25B (Outbound Port 25 Blocking). If -p (or --port) is not specified, -p 587 is applied.
  -S or --SMTPS | Specify when using SMTPS (SMTP over SSL/TLS). If -p (or --port), -B (or --OP25B) is not specified, -p 465 is applied.
  -T or --STARTTLS | Specify when using STARTTLS. -S (or --SMTPS) must be specified when using this option.
  -F or --no-check-certificate | Specify if the certificate is not validated.
  -A or --SMTP-AUTH | Specify when using SMTP authentication (SMTP AUTH).
  -P or --PLAIN | Specify when using PLAIN for SMTP authentication.
  -L or --LOGIN | Specify when using LOGIN for SMTP authentication.
  -C or --CRAM-MD5 | Specify when using CRAM-MD5 for SMTP authentication.
  -D or --DIGEST-MD5 | Specify when using DIGEST-MD5 for SMTP authentication.
  -u username or --userid username | Specify the user name to be used for sending mail.
  -w password or --password password | Specify the user's password for sending mail.

  (*1) You have to specify either -mailbody or -mailfile option but not both.

◼ Run Route Test Command
Syntax: <option> IPaddress

- <option>:

  Table 4: Run Route Test Command option parameters
  Option | Description
  --- | ---
  -Queries | Number of executions
  -ImmediateEnd | Whether or not to quit the test when there's no response from a node on the way to a destination Specify true to quit immediately. Specify false to continue test.
  -TimeOut | Ping timeout (seconds)
  -RetryCount | Ping retry count
  -TTL | TTL
  -Interval | Ping interval (milliseconds)
  -MaxHop | Maximum hops
  -DataSize | ICMP datasize (Byte)
  -Mask | Subnet mask (not supported)

### Special Variables

You can use the following special variables in action command's parameter.
The special variable names begin with "%". When you use them in "Parameter", they will be replaced with their actual values and then passed to the command.

Table 5: Action Command's Special Variables
Node Name | Description
--- | ---
%name | A name of a log event source (e.g. node name)
%adr | An address. IP address is used when both IP and MAC address are available.
%ip | An IP address. IPv4 address is used when both IPv4 and IPv6 address are available.
%ipv4 | An IPv4 address
%ipv6 | An IPv6 address
%mac | A MAC address. If a target node has IPv4, IPv6 and MAC addresses, those addresses are prefered in the order of IPv4, IPv6 and MAC.
%msg | A message (log event detail).
%type | Log Type
%subt | Event
%level | Log Level ("User", "Informational" or "Debug").
%time | Date/Time of a log event.
%aid | Action Command ID number.

> Note

> > Special variable "%aid" is currently not supported.

## Action Command Details

This page shows the action command details.

Table 6: Action Command Details
Item | Content
--- | ---
ID | Shows an ID of the action command determined on its creation.
Command Type | Shows a command type (Sending email, Run Route Test Command or Custom Command).
Command | Shows a command to run on the server when you specified "Custom Command" for "Command Type".
Option | Shows detailed options to a pre-defined or custom command.
Notes | Shows a notes on the action command.
Edit | Opens Update Action Command for the action command.
Remove | Opens "Delete Action Command" dialog box. Clicking "Yes" in the dialog box deletes the action command. Click "No" or "Close (x)" button at the top left of the dialog box allows you to cancel the delete operation and goes back to "Action Command Details" page.

## Update Action Command

This page lets you change the action command configuration.

Table 7: Update Action Command
Item | Content
--- | ---
ID | Shows an ID of the action command determined on its creation.
Command Type | Lets you select a command type from the dropdown list of pre-defined types. Send Email: Uses "minimail" email client which is accompanied with the SNMP Plug-in. minimail is a simple email client which can be run from CLI. The program can only send emails and cannot receive them. It can check errors in parameter values only. If you use "Send Mail" action command for an event, test it on Command Prompt and make sure that emails are sent as expected. Run Route Test Command: Runs ping test. You can enter "Parameter" field. Custom Command: Runs an arbitrary program on the server. You can enter "Command" and "Parameter" fields.
Command | Enter a fullpath to the command to run on the server when you specified "Custom Command" for "Command Type".
Option | You can specify detailed options to a pre-defined or custom command. Refer to Parameters for more details. You can also use special variables related to events in option parameters. Refer to Special Variables about them.
Notes | Lets you add a description of the command. Should be 1 to 4,096 characters in length, with alhabets, numbers, and symbols (including spaces). By default, it has pre-defined text depending on the selected command type. You can change the text to help you later remember what the command does.
"Save" button | Saves the changes to the action command configuration.

06 Sep 2023 11:35