Intro to CW SSH CLI
From TDiWiki
Contents |
[edit] Overview
CW SSH CLI is the new command-line utility for those power users who don’t want to use the browser GUI. It contains all of the capabilities of the GUI environment. CW SSH CLI allows you to use your choice of SSH-capable terminal emulator to connect to and look after your ConsoleWorks-managed environment.
[edit] Adding a Console
Adding a Console requires you to specify the following fields in addition to the name:
port (the Host IP)
socket (the port number)
type (the connector type)
certain values may require additional fields such as SSHPWD in our example below which requires username and pswdenc (password).
cw> add CONSOLE TestCnsl port=testcnsl.domain.com socket=22 type=SSHPWD username=root pswdenc=pAssW0rd! Saved CONSOLE TestCnsl
[edit] Editing a Console
You can edit the fields of an existing Console or add additional fields by using the edit command.
cw> edit CONSOLE TESTCNSL description="Put text that describes your console here." Saved CONSOLE TESTCNSL
- note that the console name must be capitalized here or it won't be recognized as a real console.
[edit] Adding a Scan
Adding a Scan requires you to specify the following fields in addition to the name:
description (descriptive text)
cw> add SCAN TestScn description="this is my scan." Saved SCAN TestScn
[edit] Adding an Event
Adding an Event requires you to specify the following fields in addition to the name:
pattern (the text to trigger on)
severity (must be all caps)
cw> add EVENT TestEvnt pattern="test pattern" severity=MAJOR Saved EVENT TestEvnt
[edit] Adding an Automatic Action
Associating an Automatic Action to an Event requires you to specify the following fields:
action (to see the automatic actions available on your system use: list EXTERNAL_AUTOMATIC_ACTION)
consoles or groups (specifies the console(s) where the event occurs)
parameter (required for certain automatic actions)
contact (required for certain automatic actions)
cw> associate EVENT_TO_AUTOMATIC_ACTION TestEvnt mail.sh action=mail.sh consoles=TESTCNSL contact=mail@domain.com Association Added
[edit] Associating Resources
You can associate an Event, Scan, and Console by using the associate command. The order of resource names that you specify is dependent upon the association type.
cw> associate EVENT_TO_SCAN TestEvnt TestScn Association Added cw> associate SCAN_TO_CONSOLE TestScn TestCnsl Association Added
