Lists of commands
This section lists the names of the commands that can be used in JP1/IM and the permissions required to execute these commands. Note that the commands are described in alphabetical order from the next section.
- Organization of this page
-
-
Commands related to IM Configuration Management (remote monitoring configuration)
-
Commands related to the Intelligent Integrated Management Base
-
Commands related to the Intelligent Integrated Management Database
-
Commands related to changing the monitoring node status in Central Scope
-
Commands for migrating monitoring object database information in Central Scope
-
Commands for checking the contents of the JP1/IM - Manager definition file
-
Commands for checking the contents of the JP1/IM - View definition file
-
Command that counts the number of nodes managed by JP1/IM - Manager
Legend and notes for tables
Whether a command is supported in the Windows and UNIX environments is indicated in the tables by the following notations and notes:
- Legend:
-
Y: Supported
--: Not supported
- #1
-
In Windows, a superuser means a user with Administrator permissions.
- #2
-
This is a JP1/Base command (related to configuration definition and command execution) for the manager. For details about the command, see the chapter that describes commands in the JP1/Base User's Guide.
- #3
-
In Windows, Administrator permissions are required. (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)
- #4
-
This command is used by the monitored AIX host.
Commands related to startup, termination, and setup
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Sets up JP1/IM - Manager (Central Console) |
-- |
Y |
Superuser |
|
|
Sets up JP1/IM - Manager (Central Scope) |
-- |
Y |
Superuser |
|
|
Starts JP1/IM - Manager automatically |
-- |
Y |
Superuser |
|
|
Terminates JP1/IM - Manager automatically |
-- |
Y |
Superuser |
|
|
Displays the status of JP1/IM - Manager processes |
Y |
Y |
Superuser#1 |
|
|
Updates the status of JP1/IM - Manager processes |
Y |
Y |
Superuser#1 |
|
|
Specifies settings required for operation in a cluster system |
Y |
-- |
Superuser#1 |
|
|
Y |
-- |
Superuser#1 |
||
|
-- |
Y |
Superuser |
||
|
-- |
Y |
Superuser |
||
|
Starts JP1/IM - Manager in a cluster system |
-- |
Y |
Superuser |
|
|
Terminates JP1/IM - Manager in a cluster system |
-- |
Y |
Superuser |
|
|
Forcibly terminates JP1/IM - Manager in a cluster system |
-- |
Y |
Superuser |
|
|
Specifies dependencies between JP1/IM-Manager Service and the JP1/Base Event service |
Y |
-- |
Superuser#1 |
Commands related to IM databases
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Sets up the IM Configuration Management database for storing configuration information |
Y |
Y |
Superuser#1 |
|
|
Cancels setup of the IM Configuration Management database that stores configuration information |
Y |
Y |
Superuser#1 |
|
|
Sets up an integrated monitoring database for storing JP1 events |
Y |
Y |
Superuser#1 |
|
|
Cancels setup of the integrated monitoring database that stores JP1 events |
Y |
Y |
Superuser#1 |
|
|
Outputs to a CSV file JP1 event information registered in the integrated monitoring database |
Y |
Y |
Superuser#1 |
|
|
Backs up the IM database |
Y |
Y |
Superuser#1 |
|
|
Releases free area (free page area) in the IM Configuration Management database |
Y |
Y |
Superuser#1 |
|
|
Restores (recovers) a database from a backup that has been stored |
Y |
Y |
Superuser#1 |
|
|
Reorganizes fragmented free space in a database |
Y |
Y |
Superuser#1 |
|
|
Checks the operating status of the IM database (such as running or stopped) |
Y |
Y |
Superuser#1 |
|
|
Terminates the IM database |
Y |
Y |
Superuser#1 |
|
|
Updates the IM database |
Y |
Y |
Superuser#1 |
Commands related to IM Configuration Management
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Collects virtualization configuration information from HCSM, and outputs it to the virtualization configuration information file |
Y |
Y |
Superuser#1 |
|
|
Collects virtualization configuration information from KVM, and outputs it to the virtualization configuration information file |
Y |
Y |
Superuser#1 |
|
|
Collects virtualization configuration information from SCVMM, and outputs it to the virtualization configuration information file |
Y |
-- |
Superuser#1 |
|
|
Collects virtualization configuration information from vCenter, and outputs it to the virtualization configuration information file |
Y |
Y |
Superuser#1 |
|
|
Collects virtualization configuration information from Hitachi Compute Blade logical partitioning feature, and outputs it to the virtualization configuration information file |
Y |
Y |
Superuser#1 |
|
|
Acquires virtualization configuration information from VMware ESX and outputs it to a virtualization configuration information file |
Y |
Y |
Superuser#1 |
|
|
Outputs the hierarchical configuration (IM configuration) of a system managed by IM Configuration Management, host information, and definition information |
Y |
Y |
Superuser#1 |
|
|
Imports IM Configuration Management information |
Y |
Y |
Superuser#1 |
|
|
Creates from the host input information file and Central Scope export file a Central Scope import file that contains monitoring tree information for a virtualization configuration. Alternatively, creates from the business group information file, monitoring group information file, and Central Scope export file a Central Scope import file to which the monitoring tree information of a business group has been added |
Y |
Y |
Superuser#1 |
|
|
Uses a virtualization configuration information file to update a host input information file |
Y |
Y |
Superuser#1 |
|
|
Updates the virtualization configuration of the specified host |
Y |
Y |
Superuser#1 |
|
|
Sets up an operating environment for the IM Configuration Management processes of JP1/IM - Manager |
-- |
Y |
Superuser |
|
|
Sets up an environment for IM Configuration Management for cluster system operation |
-- |
Y |
Superuser |
|
|
Sets up an environment for IM Configuration Management for cluster system operation |
Y |
-- |
Superuser#1 |
Commands related to IM Configuration Management (remote monitoring configuration)
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Defines the profile of a remote monitoring event log trap on the specified monitored host |
Y |
-- |
Superuser#1 |
|
|
Reloads a remote monitoring event log trap action definition file |
Y |
-- |
Superuser#1 |
|
|
Starts a remote monitoring event log trap |
Y |
-- |
Superuser#1 |
|
|
Displays the operating status of a remote monitoring event log trap |
Y |
-- |
Superuser#1 |
|
|
Stops a remote monitoring event log trap |
Y |
-- |
Superuser#1 |
|
|
Adds or deletes the profile of a remote monitoring log file trap on the specified monitored host |
Y |
Y |
Superuser#1 |
|
|
Reloads the action definition file of a remote monitoring log file trap |
Y |
Y |
Superuser#1 |
|
|
Starts a remote monitoring log file trap |
Y |
Y |
Superuser#1 |
|
|
Displays the operating status of a remote monitoring log file trap |
Y |
Y |
Superuser#1 |
|
|
Stops a remote monitoring log file trap |
Y |
Y |
Superuser#1 |
Commands related to upgrading
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Converts an action definition file from version earlier than 11-50 to version 11-50 or later |
Y |
Y |
Superuser#1 |
|
|
Changes the location of the event acquisition filter from Event Console Service to Event Base Service (when the event acquisition filter is being used for compatibility) |
Y |
Y |
Superuser#1 |
|
|
Migrates JP1/Base command execution logs for version 7 or earlier to a command execution log file for version 8 |
jcocmdconv#2 |
Y |
Y |
Superuser#1 |
|
Upgrades a logical host environment that was set up using a previous version of JP1/IM - Manager or JP1/IM - Manager (Central Console) |
Y |
Y |
Superuser#1 |
|
|
Upgrades a physical host environment from a previous version of JP1/IM - Manager (Central Scope) |
Y |
-- |
Superuser#1 |
|
|
Upgrades a logical host environment that was set up using a previous version of JP1/IM - Manager (Central Scope) |
Y |
-- |
Superuser#1 |
|
|
Upgrades a physical host environment from a previous version of JP1/IM - Manager (Central Scope) |
-- |
Y |
Superuser |
|
|
Upgrades a logical host environment that was set up using a previous version of JP1/IM - Manager (Central Scope) |
-- |
Y |
Superuser |
Commands related to the Intelligent Integrated Management Base
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Collects the configuration information of the system managed by JP1/IM - Manager (Intelligent Integrated Management Base) and creates the IM management node-related files |
Y |
Y |
Superuser#1 |
|
|
Collects system configuration information from the products managed by the Intelligent Integrated Management server, and creates IM management node-related files that are used as input data for the jddupdatetree command |
Y |
Y |
Superuser#1 |
|
|
Sets a user ID and password that are used for JP1/IM - Manager (Intelligent Integrated Management Base) to be authenticated by linked products |
Y |
Y |
Superuser#1 |
|
|
Sets authentication information for the proxy server when REST APIs are executed from plug-ins that are provided by JP1/IM - Manager (Intelligent Integrated Management Base) |
Y |
Y |
Superuser#1 |
|
|
Loads user-defined suggestion definition files and applies them to JP1/IM - Manager (Intelligent Integrated Management Base). |
Y |
Y |
Superuser#1 |
|
|
Takes the Intelligent Integrated Management Base client information registered with the OpenID provider for OpenID authentication linkage, and sets it in JP1/IM - Manager (Intelligent Integrated Management Base). |
Y |
Y |
Superuser#1 |
|
|
Takes the mapping information defined in the single sign-on mapping definition file and applies it to JP1/IM - Manager (Intelligent Integrated Management Base). |
Y |
Y |
Superuser#1 |
|
|
Import the user-defined automatic action definition file and reflect it in the intelligent integrated management infrastructure. |
Y |
Y |
Superuser#1 |
Commands related to the Intelligent Integrated Management Database
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Backup the Intelligent Integrated Management Database. |
Y |
Y |
Superuser#1 |
|
|
Recover the Intelligent Integrated Management Database stored in backup. |
Y |
Y |
Superuser#1 |
|
|
Setup the Intelligent Integrated Management Database and the Trend Data Management Service. |
Y |
Y |
Superuser#1 |
|
|
Un-setup the Intelligent Integrated Management Database and the Trend Data Management Service. |
Y |
Y |
Superuser#1 |
|
|
Stop the Intelligent Integrated Management Database Service and the Trend Data Management Service. |
Y |
Y |
Superuser#1 |
|
|
Checking the operating status of the Intelligent Integrated Management Database Service and the Trend Data Management Service. |
Y |
Y |
Superuser#1 |
|
|
Upgrading Intelligent Integrated Management Database and trend data management service |
Y |
Y |
Superuser#1 |
■About multiple execution of the commands related to the Intelligent Integrated Management Database
The following table shows possible or not possible multiple execution of the commands related to the Intelligent Integrated Management Database.
|
Execute command name |
Executing command name |
||||||
|---|---|---|---|---|---|---|---|
|
jimgndbsetup |
jimgndbunsetup |
jimgndbstop |
jimgndbstatus |
jimgndbbackup |
jimgndbrestore |
jimgndbupdate |
|
|
jimgndbsetup |
Not possible |
Possible |
Not possible |
||||
|
jimgndbunsetup |
Not possible |
Possible |
Not possible |
||||
|
jimgndbstop |
Not possible |
Possible |
Not possible |
||||
|
jimgndbstatus |
Possible |
||||||
|
jimgndbbackup |
Not possible |
Possible |
Not possible |
||||
|
jimgndbrestore |
Not possible |
Possible |
Not possible |
||||
|
jimgndbupdate |
Not possible |
Possible |
Not possible |
||||
Commands related to views
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Starts IM Configuration Management - View |
Y |
-- |
None |
|
|
Registers into or deletes from the Windows Start menu the menu item for starting IM Configuration Management - View |
Y |
-- |
Superuser#1 |
|
|
Opens JP1/IM - View's Login window or Monitoring Tree (Editing) window, or logs in to JP1/IM - Manager from the command line |
Y |
-- |
None |
Commands related to configuration definition
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Distributes configuration definition information to the lower hosts and enables the definition information |
jbsrt_distrib#2 |
Y |
Y |
Superuser#1 |
|
Collects configuration definition information from the lower hosts and updates the configuration definition |
jbsrt_sync#2 |
Y |
Y |
Superuser#1 |
|
Deletes the configuration definition information for the host that executed the command |
jbsrt_del#2 |
Y |
Y |
Superuser#1 |
|
Displays the existing configuration definition information |
jbsrt_get#2 |
Y |
Y |
Superuser#1 |
Commands related to events
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Changes the response status for severe events |
Y |
Y |
None#3 |
|
|
Sets up a JP1/IM - Manager system environment |
Y |
Y |
Superuser#1 |
Commands related to automated actions and command execution
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Checks the definitions of automated actions and merges multiple automated action definition files |
Y |
Y |
Superuser#1 |
|
|
Displays the result of automated action execution |
Y |
Y |
None#3 |
|
|
Displays to standard output the status of the Automatic Action Service that is running and the contents of the automated action definition file that is loaded. |
Y |
Y |
None#3 |
|
|
Reloads the automated action definitions, places the automated action function on standby, or enables or disables the automated action definition. |
Y |
Y |
Superuser#1 |
|
|
Cancels automated actions |
Y |
Y |
Superuser#1 |
|
|
Sets up a command execution environment |
jcocmddef#2 |
Y |
Y |
Superuser#1 |
|
Outputs logs of executed commands |
jcocmdlog#2 |
Y |
Y |
None |
|
Deletes commands that were executed from JP1/IM - View or executed by automated actions |
jcocmddel#2 |
Y |
Y |
Superuser#1 |
|
Checks the status of commands that were executed from JP1/IM - View or executed by automated actions |
jcocmdshow#2 |
Y |
Y |
Superuser#1 |
Commands related to the email notification function
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Sends email to the specified email address |
Y |
-- |
Superuser#1 |
|
|
Sets the password for POP before SMTP authentication or SMTP-AUTH authentication in the email environment definition file |
Y |
-- |
Superuser#1 |
Commands related to correlation event generation
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Changes correlation event generation definitions |
Y |
Y |
Superuser#1 |
|
|
Checks the contents of a correlation event generation definition file |
Y |
Y |
Superuser#1 |
|
|
Places the correlation event generation function in correlation running status |
Y |
Y |
Superuser#1 |
|
|
Displays the status of the correlation event generation function and the correlation event generation definitions that are being used currently |
Y |
Y |
None#3 |
|
|
Places the correlation event generation function in standby status |
Y |
Y |
Superuser#1 |
Commands used in the Central Scope environment setup
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Registers host information into the host information database |
Y |
Y |
Superuser#1 |
|
|
Acquires host information from the host information database |
Y |
Y |
Superuser#1 |
|
|
Creates or re-creates the monitoring object database |
Y |
Y |
Superuser#1 |
Commands related to filters
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Switches the event acquisition filter |
Y |
Y |
Superuser#1 |
|
|
Changes the operating mode of the common exclusion-conditions |
Y |
Y |
Superuser#1 |
Commands related to changing the monitoring node status in Central Scope
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Changes the status of monitoring nodes (monitoring objects or monitoring groups) |
Y |
Y |
Superuser#1 |
Commands for migrating monitoring object database information in Central Scope
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Acquires monitoring object database storage information from JP1/IM - Manager and outputs it locally to a file |
Y |
Y |
Superuser#1 |
|
|
Applies the information output to a file by the jcsdbexport command to the monitoring object database of JP1/IM - Manager |
Y |
Y |
Superuser#1 |
Commands used for troubleshooting
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Creates a Java thread dump of IM Configuration Management - View |
Y |
-- |
None |
|
|
Collects data in the event of a failure in JP1/IM - Manager or JP1/IM - View |
Y |
-- |
None#3 |
|
|
Collects data in the event of a failure in JP1/IM - Manager |
-- |
Y |
Superuser |
|
|
Collects data in the event of a failure in JP1/IM - View |
Y |
-- |
None#3 |
|
|
Outputs a thread dump in the event of a failure in JP1/IM - View |
Y |
-- |
None |
|
|
Outputs a thread dump and a core dump (UNIX only) in the event of a failure in JP1/IM - Manager |
Y |
Y |
Superuser#1 |
|
|
Tests the notification command that is defined in the health check definition file in JP1/IM - Manager |
Y |
Y |
Superuser#1 |
Commands for checking the contents of the JP1/IM - Manager definition file
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Y |
Y |
None#3 |
||
|
Y |
Y |
None#3 |
Commands for checking the contents of the JP1/IM - View definition file
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Y |
N |
None |
||
|
Y |
N |
None |
Command that counts the number of nodes managed by JP1/IM - Manager
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|---|---|---|---|---|
|
Y |
Y |
Superuser#1 |
Commands related to the JP1/IM - Agent
|
Overview of function |
Command name |
Windows |
UNIX |
Required execution permission |
|
|---|---|---|---|---|---|
|
Perform configuration file format checks and test alert rules for Prometheus server |
Y |
Y |
None |
||
|
Collect JP1/IM - Agent failure documentation (integrated agent host) |
Y |
Y |
Superuser#1 |
||
|
Collect documentation for JP1/IM - Agent failures (AIX hosts to be monitored). |
--#4 |
Superuser |
|||
|
Obfuscate the specified secret and store it in the secret manager File |
Y |
Y |
Superuser#1 |
||
|
Perform an early Setup of JP1/IM - Agent |
Y |
Y |
Superuser#1 |
||
|
Setup enable or disable of add-on program of JP1/IM - Agent. |
Y |
Y |
Superuser#1, #3 |
||
|
Setup JP1/IM - Agent to start and stop automatically |
Y |
Y |
Superuser#1, #3 |
||
|
Start JP1/IM - Agent Services |
Y |
Y |
Superuser#1, #3 |
||
|
Stop JP1/IM - Agent Services |
Y |
Y |
Superuser#1, #3 |
||
|
Shut down Node exporter for AIX |
--#4 |
Superuser |
|||
|
Set up a new logical host for JP1/IM - Agent |
Y |
Y |
Superuser#1 |
||
|
Upgrade the logical host after installing the version of JP1/IM - Agent. |
Y |
Y |
Superuser#1 |
||