User Guide: SNMP plug-in version 2.9.1 for VST-VRT

# 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 Name | Contents
--- | ---
Number of items displayed on the 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 The first page is displayed. Previous Displays the page immediately before the current display page. Page Number Click the number to display the corresponding page. The currently displayed page is highlighted with a gray button background. Next Displays the next page after the currently displayed page. Last Display the final page.

## Create Action Commands

This screen lets you create a new action command.

Table 2: Create Action Command
Item Name | Contents
--- | ---
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.
Command | This menu item is not supported.
Parameters | Specify detailed options for the parameters provided by default in SNMP Plug-in.
Notes | Lets you add a description of the command. You can specify half-width alphabets, numbers, and symbols within 4096 characters. 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" 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
  Option | Description
  --- | ---
  -p|--port xxx | Port number
  -f|--from xxx | Sender email address
  -t|--to xxx[,yyy] | Recipient email address (required) Use commas (,) to specify multiple addresses.
  -c|--cc xxx[,yyy] | Carbon copy email address Use commas (,) to specify multiple addresses.
  -b|--bcc xxx | Blind carbon copy email address Use commas (,) to specify multiple addresses.
  -r|--replyto xxx | Reply-To email address
  -s|--subject xxx | Email subject
  -m|--mailbody "xxx yyy" | Email body text (enclosed with double-quotes) Specify a body text in double-quotes. Use "\n" for newline.
  -@|--charset xxx | Character set (JIS7|UTF8)
  -B or --OP25B | Use Outbound Port 25 Blocking (OP25B) 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|--SMTP-AUTH | Use SMTP authentication
  -P|--PLAIN | Using PLAIN with SMTP authentication
  -L|--LOGIN | Using LOGIN with SMTP authentication
  -C|--CRAM-MD5 | Using CRAM-MD5 with SMTP authentication
  -D|--DIGEST-MD5 | Using DIGEST-MD5 with SMTP authentication
  -u|--userid xxx | User ID, Username, etc.
  -w|--password xxx | Passwords and other similar passwords

### Special Variables

You can use the following special variables in action command's parameter.
A special variable is a string beginning with a percent sign (%). When you use them in "Parameter", they will be replaced with their actual values and then passed to the command.

Table 4: 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 | IPv4 address
%ipv6 | An IPv6 address
%mac | 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 5: Action Command Details
Item Name | Contents
--- | ---
ID | Shows an ID of the action command determined on its creation.
Command Type | Shows a command type (Sending email).
Command | Blank because it is not supported
Parameters | Specify detailed options for the parameters provided by default in SNMP Plug-in.
Notes | Shows a notes on the action command.
Edit | Opens Update Action Command for the action command.
Delete | 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 6: Update Action Command
Item Name | Contents
--- | ---
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.
Command | Blank because it is not supported
Parameters | Specify detailed options for the parameters provided by default in SNMP Plug-in. 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. You can specify half-width alphabets, numbers, and symbols within 4096 characters. 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.

01 Sep 2023 11:34