You can use the command-line interface (CLI) to access the CloudBridge appliance remotely for interactive or scripted configuration, monitoring, and file transfer.
The CLI uses two access mechanisms: SSH, for interactive and script access, and SFTP, for transferring files into and out of the appliance. Alternatively, RS-232 access is available locally, through a null modem cable.
After accessing the appliance, you can enter commands. Command syntax is straightforward. Numeric fields use decimal values. String fields can include embedded spaces if the string is enclosed in double quotation marks.
To access the CLI through SSH, open an SSH connection to the appliance's management IP address. Following is an example of the login sequence:
ssh email@example.com Last login: Fri Jun 20 14:50:22 2008 from xx.xx.xx.xx Login: admin Password: xxxxxxxx Command Line Interpreter - Version 1.0 Copyright 2008 Citrix Systems. All Rights Reserved. (admin)>
Windows systems, by default, do not include an SSH package, so you might need to install a package such as PuTTY. If so, you use "putty" instead of "ssh" to access the appliance.
The logon sequence has two steps:
- Log on as user cli, which has a null password. You are then prompted to log in with proper credentials for the appliance.
- Log on as a valid appliance user, typically Admin, but with any user name and password that would work on the appliance’s GUI.
After you log on, all the CLI commands are available.
You can use a terminal emulator to log on to a local appliance's CLI through a null modem cable connected to the appliance's RS-232 serial port. Set the terminal emulator to 115,200 baud, 8 data bits, 1 stop bit, no parity. The login procedure is the same as with SSH.
To allow file transfers to and from the appliance, enable and activate a special account, for which the user name is transfer. This account is disabled by default. To enable it, log on through SSH or RS-232 and enter the following CLI command:
set access –type transfer –password <password>
This command enables the transfer account and sets its password to the password that you specify. Once enabled, the transfer account cannot be disabled. However, you can effectively disable it by using the same command to assign a very long and difficult to remember password.
To activate the transfer account, use the SFTP utility (or an equivalent Windows utility such as PSFTP) to log on to the appliance, with user name transfer and the password that you specified when you enabled the account. Some CLI commands can accept uploaded files as a command argument, or create files for download. After file transfer is enabled, you can use SFTP or an equivalent utility to transfer files. When transferring files, do not use path names on the appliance side of the transfer. Transfer all files into or out of the default directory. File names should contain only the letters a-z and A-Z, the numerals 0-9, and the period and hyphen characters.