Important

   

Starting version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about BMC Network Automation 8.9.02 and previous versions. For TrueSight Network Automation 8.9.03 and later releases, see the TrueSight Network Automation documentation.

Terminal commands

This topic describes the following available terminal commands:

clear

Clear the screen.

clear

connect

Connect to a device.

connect [-i] [-prompt] [-non-priv] [-aux] [-c changeID] [-t taskID] [-a annotation] [-d dynname=value] device-name
ArgumentDescription

-i

Displays interactive prompts for each job parameter such as changeID, task ID, annotation, dynamic fields, and so forth.

-prompt

Displays a prompt for the user name and password instead of using the login credential in the DSP.

-non-priv

Logs into non-privileged mode if the user is set up to access the DSP as the source for login credentials.

-aux

Specifies that the connection to the device be made using its auxiliary interface; if the device has no auxiliary interface, an error is returned. If the -aux option is omitted, the primary interface is used.

-c

changeID

-t

taskID

-a

annotation

-d

The value of a dynamic field in dynamic-file-name=dynamic-field-value. For multi-value dynamic fields, separate the values by comma. There can be more than one -d option. Use one -d option for each dynamic field.

device-name

Name of the device.

You can use the Tab key to auto-complete the device name.

For example, if there are fewer matching entries than the value specified in the Number of Devices Displayed By SSH Proxy When Press Tab field on the Admin > System Admin >System Parameters page, all the device names are displayed. You can then type the remaining unique characters and connect to that device. However, if there are more matching entries than the value specified in the Number of Devices Displayed By SSH Proxy When Press Tab field, the console displays that there are too many entries, and you must then type additional characters to be matched.

device-info

Display device information. The device-name can contain wildcard characters supported by your SSH terminal.

device-info [-d] device-name
ArgumentDescription

-d

Displays the dynamic fields.

device-name

Name of the device. The device-name can contain wildcard characters supported by your SSH terminal.

You can use the Tab key to auto-complete the device name.

For example, if there are fewer matching entries than the value specified in the Number of Devices Displayed By SSH Proxy When Press Tab field on the Admin > System Admin >System Parameters page, all the device names are displayed. You can then type the remaining unique characters and connect to that device. However, if there are more matching entries than the value specified in the Number of Devices Displayed By SSH Proxy When Press Tab field, the console displays that there are too many entries, and you must then type additional characters to be matched.

exit

Close the proxy session.

exit

help

Display a list of the commands that you can use. The optional command displays a list of options for that command.

help [command] ? [command]

Example

bcan-test-01:bca-networks$ ?
clear Clear the screen.
connect Connect to a device.
device-info Display device information.
exit Close the proxy session.
help [help|?] <command> - Display usage for the specified command.
history Display a list of commands executed in the current session.
list-devices Display a list of available devices.

history

Display a list of the commands executed in the current session.

history

list-devices

Display a list of the devices for which you have permission to view. The device-name can contain wildcard characters supported by your SSH terminal.

list-devices [device-name]
ArgumentDescription
device-name

Name of the device. The device-name can contain wildcard characters supported by your SSH terminal.

Was this page helpful? Yes No Submitting... Thank you

Comments