User Manual · 2014. 5. 21. · User Manual Get Console Settings Console Settings Auto Connect...

User Manual

Get Console

Version: 1.04

Date: 30th September 2011

User Manual Get Console

Table of Contents What is Get Console App? ............................................................................................................................ 4

Get Console App Requirement ..................................................................................................................... 4

Settings.......................................................................................................................................................... 5

Console Settings ........................................................................................................................................ 5

Auto Connect ........................................................................................................................................ 5

Baud Rate .............................................................................................................................................. 5

Stop Bits ................................................................................................................................................ 5

Flow Control .......................................................................................................................................... 6

Parity (Default: Off) ............................................................................................................................... 6

Console Logging (Default: Off) .............................................................................................................. 6

Terminal Settings ...................................................................................................................................... 6

Columns (Default: 80) ........................................................................................................................... 7

Rows (Default: 24) ................................................................................................................................. 7

Scrollback (Default: 100) ....................................................................................................................... 7

Clear on Connect ................................................................................................................................... 7

Keyboard Auth (SSH) ............................................................................................................................. 7

Bell Behavior ......................................................................................................................................... 7

Colour Scheme ...................................................................................................................................... 7

ANSI Colour ........................................................................................................................................... 8

Text Size ................................................................................................................................................ 8

Command Shortcuts ............................................................................................................................. 8

Password List ......................................................................................................................................... 9

Keyboard Settings ................................................................................................................................... 10

Backspace Key ..................................................................................................................................... 10

Enter Key ............................................................................................................................................. 10

Use Option as Ctrl ............................................................................................................................... 10

Remote settings ...................................................................................................................................... 11

Remote Server .................................................................................................................................... 11

Private Server ...................................................................................................................................... 12


Secure Connection (Default: Off) ........................................................................................................ 12

Username ............................................................................................................................................ 12

Password ............................................................................................................................................. 12

About CCC ............................................................................................................................................... 13

Version ................................................................................................................................................ 13

Copyright ............................................................................................................................................. 13

About CCC ........................................................................................................................................... 13

Connect to ................................................................................................................................................... 14

Connect Serial ......................................................................................................................................... 14

Connect Telnet/SSH ................................................................................................................................ 15

Quick Connect ..................................................................................................................................... 15

To disconnect session ......................................................................................................................... 15

Saved Connections .............................................................................................................................. 16

Share Session .......................................................................................................................................... 17

Once connected .................................................................................................................................. 17

Possible error messages ...................................................................................................................... 17

To disconnect shared session ............................................................................................................. 18

Keyboard Show/Hide .................................................................................................................................. 18

Shortcuts Show/Hide .................................................................................................................................. 18

Quick Commands ........................................................................................................................................ 19

Ctrl-Shift-6 ................................................................................................................................................... 19

File Manager ............................................................................................................................................... 19

Local Files ................................................................................................................................................ 20

Remote Files ............................................................................................................................................ 20

(download file list) .............................................................................................................................. 20

Stored passwords ........................................................................................................................................ 20

Console Log files.......................................................................................................................................... 21

Clipboard ..................................................................................................................................................... 21

Paste Clipboard to Console ..................................................................................................................... 21

Paste Editor to Console ........................................................................................................................... 21

What is Get Console App? Get Console is an Apple App Store distributed terminal application for Apple iPads and iPhones that

allows IT engineers to connect and control RS232 serial ports (such as to the console port of Cisco

devices), Telnet or SSH(v2). Before Get Console, the only App Store applications available for Network

engineers were restricted to using telnet or ssh (which Get Console does as well). With the Get Console

app, IT engineers can perform router maintenance, troubleshooting and disaster recovery operations

directly on the Cisco, Juniper and other serial device console port using the instant on, portable iPad,

iPhone or iPod Touch - all WITHOUT jailbreaking. The Get Console app features detailed logging,

configuration repository access, command and keyboard shortcuts and instant remote access (via the

get-console.com website) through the Apple 3G or WIFI connection to share the terminal window

The below drawing summarizes the components of Get Console

Get Console App Requirement - iPhone3 +

- iPad1 onwards

- Get Console RJ-45 or serial cable or Wifi configured to connect to the network device

- Wifi/3G connection for sharing session

Apple iPad runing

Get Console App

“mobile terminal”

Field Device:

cisco router,

juniper firewall,

sun server etc

Get Console

Public or Private

Server

Remote PC /

MAC based User

C2-RJ45

Serial Cable

OR

Telnet/SSHv2 over

WIFI/3G

3G / WIFI

(internet)

Web or Telnet

Remote PC directly controls Field Device

Local Terminal

session

Tunnels serial

session via HTTPS

http://itunes.apple.com/us/app/get-console/id412067943?mt=8&ls=1


Settings

Console Settings

Auto Connect

Get-console app automatically connects to the physical cable connection (RJ-45 or serial) when it’s

plugged into the iPhone/iPad port.

Options:

- On

- Off

Baud Rate

Allows the choice of different baud rates to suit communication with the network device

Options:

- 1200 Baud

- 2400 Baud

- 4800 Baud

- 9600 Baud

- 19200 Baud

- 38400 Baud

- 57600 Baud

Stop Bits

Options:

- 1 Stop Bit

- 2 Stop Bits


Flow Control

Options:

- None

- Hardware (RTS/CTS)

- Software (XON/XOFF)

Parity (Default: Off)

Options:

- Off

- Odd

- Even

Console Logging (Default: Off)

Logs all printable output to file stored on iOS device. The log files can be uploaded to www.get-

console.com website or extracted via iTunes

Options:

- On

- Off

Terminal Settings

http://www.get-console.com/



Columns (Default: 80)

Supports any column width up to 132 characters wide

Rows (Default: 24)

Supports any number of rows on the screen

Scrollback (Default: 100)

Number of lines retained by the console for review. Setting this above 250 will impact performance on

iPhone4 and below. iPad2 supports 500 scrollback without impact due to improved hardware

specifications.

Clear on Connect

Clears scrollback from previous session when a new connection is made

Options:

- On

- Off

Keyboard Auth (SSH)

Allows for interactive keyboard password authentication in addition to the usual SSL security.

Options:

- On

- Off

Bell Behavior

Allows the iOS device to create an alert when there is an event or stay silent.

Options:

- Play Alert (bell/vibrate phone)

- Do Nothing (silent)

Colour Scheme

Changes the colour scheme of the text and background of the console

Options:

- White on Black White text on Black background

- Black on White Black text on White background

- White on Black/Grey White text on Black/Grey background

- Green on Black Green text on Black background

- Rainbow Helps debugging by colouring different parts of the screen o Blue: Left and right border o Red: Upper border of the scrollback limit o Black: Active area of the console within the

scrollback limit


ANSI Colour

Allows up to 256 colours on terminal window

Options:

- On

- Off

Text Size

Set font size in the terminal window

Smaller –------------------------------------------------------------------------------------------------------------------- Larger

Command Shortcuts

Add command shortcuts here for use in terminal via dropdown icon

Rows on the right: Hold button to rearrange the order of the command shortcuts

Stop sign on the left: Changes the rows on the right to delete button which then can delete the saved

command shortcut


Password List

Add passwords here for quick use in terminal via dropdown icon

Rows on the right: Enables the order of the passwords to be rearranged top to bottom

Stop sign on the left: Changes the rows on the right to delete button which then can delete the saved

command shortcut


Keyboard Settings

Note that it is possible to use get-console app with a Bluetooth keyboard and the settings configured

here will affect the Bluetooth keyboard.

Backspace Key

Options:

- Control-H

- Control-? (127)

Enter Key

Options:

- Carriage Return

- Line Feed

- CR + LF

Use Option as Ctrl

Options:

- On

- Off


Remote settings

Remote Server

Select the closest public server for session sharing with a remote user, or if Private Server has been

installed then select Private Server.

Both versions of the Get Console Server acts as a connection broker and proxy between the Apple

iPad/iPhone terminal session and the remote users sitting at PCs, allowing the remote PC user to control

the terminal session connected to the Apple iPad/iPhone.

Public versions of the Server are hosted in US, UK and New Zealand. These can be used at no charge by

any registered purchasers of the Get Console App to allow any remote PC to access the terminal session

via the public website www.get-console.com. The performance of the end to end terminal varies greatly

on the current load of the server and the latency of both the Apple device and the Remote PC users

from the selected public server.

Options:

- Asia Pacific

- Europe

- North America

- Private Server The Private Server is hosted on a customer’s own network, and secured by their own network security policy

- Disabled The option to share remote session will be disabled



Private Server

If Private Server is selected for Remote Server, set its hostname or IP address in this field.

Below is diagram representation of the working of the Private Server

For more info, please view the Get Console Private Server manual.

Secure Connection (Default: Off)

Use SSL for session sharing for more secure connection

Options:

- On

- Off

Username

Registered email address on www.get-console.com – it’s free to register. Or if Private Server has been

chosen, the user name for use with the Private Server login

Password

Password for your registered account on www.get-console.com website. Or if Private Server has been

chosen, the password for use with the Private Server login.




About CCC

Version

Version number of the Get Console App. Certain features are only available in later versions.

Copyright

Year and holder of the copyright

About CCC

About Cisco Console Companion – Now called Get Console, displays version, copyright information,

developers, LibSSH2 license, etc.


Connect to

Connect Serial Connects the console to the network device via serial cable

Possible errors:

- Connection error: Failed to connect. Is the cable connected.

If this error is seen and there is a cable plugged into the iOS device, then check that the iOS device is

detecting the cable by going to the iOS devices general settings -> about -> console cable. This will

show the cable hardware and firmware detected. Get Console only works with the Redpark C2-RJ45

cable. If you have a C2-RJ45 cable connected but it is not detected by the apple iOS operating

system, then check it is seated correctly, and if still having issues contact the cable vendor for a

replacement.


Connect Telnet/SSH

Quick Connect

- SSH

o Hostname: Enter hostname or IP address of the device to connect to via SSH

o Port (Default: 22): Enter port number of the device to connect to via SSH

- Telnet

o Hostname: Enter hostname or IP address of the device to connect to via Telnet

o Port (Default: 23): Enter port number of the device to connect to via Telnet

- Serial

o Connects the console to the network device via serial cable

To disconnect session

Go to Connect to -> Disconnect Session


Saved Connections

New Connection

- Connection Settings

o SSH

Description: Enter the name of the connection to be saved

Hostname: Enter the hostname or IP address of the device to connect to via SSH

Port (Default: 22): Enter the port number of the device to connect to via SSH

o Telnet


Hostname: Enter the hostname or IP address of the device to connect to via

Telnet

Port (Default: 23): Enter the port number of the device to connect to via Telnet

o Serial


[Saved Connection 1]

Connects to a previously saved connection (SSH, Telnet or Serial)

Edit Connection: Change the detail of the above saved connection


Share Session Shares current session to a remote server according to the options defined in Settings -> Remote

Settings

Once connected

Options Function

- OK Return to the console

- Copy Copy the remote console code to the clipboard so that it can be used in txt message or other iOS device message

- Email Email the remote console code to a recipient with instructions how to connect to the shared session

Possible error messages

- Failed to connect to read from remote control server:

o Please check your internet connection and that the configurations defined in Settings ->

Remote Settings are correct. If everything is correctly configured at your end, then try

again, and if still having issues with a public Get Console server, try to use an alternative

one (ie Asia Pacific rather than North America) . If having problems with a Private Server

contact the Server administrator.


To disconnect shared session

Go to Connect to -> Disconnect “Session number”

Keyboard Show/Hide

Shows or Hides the onscreen keyboard to increase screen real estate, especially useful for debugging in

the iPhone with its smaller screen.

Shortcuts Show/Hide

Shows or hides the semi translucent bar of shortcuts above the keyboard. Hiding the bar can be useful

when trying to read the line at the bottom of the screen


Quick Commands

Shows a dropdown of commands defined under Settings -> Terminal Settings -> Command Shortcuts. A

few shortcuts have already been defined by default and user can add their own custom command

shortcuts for use in the terminal

Defaults:

- <break>

- <esc>

- <pipe>

Ctrl-Shift-6

Suspends telnet session, press “X” after pressing the above button to terminate the suspended telnet

session

File Manager


Local Files Shows the list of files available in the local store. Files available here are originally obtained from the

Remote files (see below)

Remote Files

(download file list)

Shows the list of files available in the get-console.com website for the user account defined in Settings -

> Remote settings. Clicking on the file will download the file to the local store, the file will then be

available offline and can be accessed via the File Manager -> Local files

Stored passwords

Shows a dropdown box containing passwords previously defined in Settings -> Terminal Settings ->

Password List. These passwords can be used as shortcut instead of typing the entire password all over

again


Console Log files

Shows a list of log files captured for each session of the terminal. Each session will be recorded in

console logging option is turned on under Settings -> Console Settings

Each file can be clicked on, and the users will be given an option to either delete it, delete all log files,

copy the content of the log into clipboard or upload the log file to user account space for the get-

console.com website.

Clipboard

Paste Clipboard to Console Pastes the content of the clipboard to the console

Paste Editor to Console Pastes whatever is in the editor (the box containing the content of the clipboard) to the console. This

allows the user to modify the content of the clipboard first before pasting to the console.

Once the editor is closed, the content of the clipboard will revert to the original clipboard again unless

the edited “Editor” is copied and pasted which then replaces the clipboard content.

User Manual · 2014. 5. 21. · User Manual Get Console Settings Console Settings Auto Connect...

Documents

Transcript of User Manual · 2014. 5. 21. · User Manual Get Console Settings Console Settings Auto Connect...