CustomCmd - createLocalTabularCustomCmd
CustomCmd - createLocalTabularCustomCmd
Description :
This command creates a custom tabular command that can run on a local host.
Return type : DBKey
Command Input :
Variable Name | Variable Type | Description |
|---|---|---|
Name | String | Name of the custom command. |
objectType | Integer | The type of server object that this command can run against (SERVER - 5004, DIRECTORY - 8, FILE - 7). |
OS | Integer | ID of the operating system (Unknown - 51, AIX - 35, HPUX - 5, LINUX - 3, SOLARIS - 2, WINDOWS - 1). |
Command | String | Command string. |
runtimeArgs | Boolean | Whether or not the user can enter additional arguments at execution time. |
executeType | Integer | If you want to run this command once against all hosts, set this variable to 0. If you want to run this command separately against each host, set this variable to 1. |
windowType | Integer | If you want to open a separate window for each host this command runs on, set this variable to 1. If you want to use the same window for all hosts, set this variable to 2. |
quickLaunch | Boolean | If this command is designed to execute against just one host, set this variable to true. If this command is designed to let the user choose additional hosts after specifying the initial target host, set this variable to false. |
useHeaders | Boolean | If this is true, the first row of output will be treated as sortable table headers. |
useStringDelimiter | Boolean | Set this to true if a delimiter encloses string fields in the commands' output. |
delimiter | String | The delimiter associated with the useStringDelimiter option. This is ignored if useStringDelimiter is false. |
separator | String | The separator will be used to split the command output into multiple fields. |
Example
The following example creates a local tabular custom command that allows you to execute nover when browsing a Linux server. It enables the usage of table headers and sets up a delimiter of " and a separator of ,.
Script
#
# script constants
#
SERVER_TYPE=5004
DIRECTORY_TYPE=8
FILE_TYPE=7
UNKNOWN_OS=51
AIX_OS=35
HPUX_OS=5
LINUX_OS=3
SOLARIS_OS=2
WINDOWS_OS=1
MULTIWINDOW_TYPE=1
SINGLEWINDOW_TYPE=2
MULTIHOST_TYPE=1
SINGLEHOST_TYPE=0
blcli CustomCmd createLocalTabularCustomCmd "Server Overview" $SERVER_TYPE $LINUX_OS "nover -u -c -h %H" false $SINGLEHOST_TYPE $SINGLEWINDOW_TYPE true true true /" ,