Home

Get Console User Manual

Contents

1. Duxg ery Nene i pt Des ys Mm peop MI Tee C j je lo The uwr 8 fing Te n maaa LO C cuq vary 4 2 8 Start and Stop Logging Action Item Note that these actions override the default Terminal settings for Logging If Logging is already enab led in the main App settings there is no need to Start Logging unless it had been previously stop ped with the Stop Logging Action These actions are useful if just a subset of terminal data is requi red to be captured The parameters allow the log file to be appended to the existing session log file rather than a new one be created ACTION TYPE Start Logging v ACTION PARAMETERS Log Name ACTION HELP Start Logging Starts logging console output If console output is already logging this will restart the logging Log Name The name to use as the base for the log file Use blank for default naming l the filename does not contain a then the date and extension txt will be appended To use todays date and time in the log file use SDATE and or STIME in the Log name Le Log Name DeviceLog SDATE_STIME log Overwrite f Log Name is specified and contains a dot and the file already exists this flag controls whether the existing log Me will be overwritten or appended 4 2 9 Upload Log Action Item Upload log file created during the session either because Logging is enabled by default or due to Start Logging earlier action item The log file can be either uploaded to the u
2. 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 or if sup port has been purchased contact Cloudstore User Manual Get Console 7 Appendix A Specific Device Serial Port Pinouts This section includes some pinouts for non Cisco devices that have successfully been tested with Get Console by other customers 1 ADTRAN 550 Comtura Networks iPad to Adtran 550 RJ45 to DB25 Female Adapter 05 17 2012 To Adtran To iPad RJ45 Jack DB25 Female tok Pin 2 BLU XMIT Pin 2 Pin 3 ROV Pin 3 Pin 4 lt y RTS Pin 4 Pin 5 oon CTS Pin 5 DSR Pin 6 Pin 7 ve ji Pin 7 Pin 8 aes DCO Pin 8 nn oie 2 CBX PhoneMail DB9 and DB25 Adaptors User Manual Get Console J lt 2 Comtura Networks iPad to CBX PhoneMail RJ45 to DB9 Male Adapter To iPad 0517 2012 To Equipment RJ45 Jack DB9 Male Pin 1 Pin 1 CTS DCD BLU Pin 2 Pin 2 RCV DSR ORN Pin 3 Pin 3 XMIT RCV BLA Pin 4 Pin 4 DTR GNO RED Pns Pin 5 GNO GNO GRN Pin 6 Pin 6 DSR XMIT YEL Pin 7 Pin 7 RTS DTR ARN Pin 8 Pin f cTs RTS WHT Ping Ri User Manual Get Console jd Comtura Networks iPad to CBX PhoneMail RJ45 to DB25 Male Adapter To iPad 08 17 2012 To Equipment RJ45 Jack DB25 Male Pin 1 Pin 2 BLU saat Pin 2 in n Pin 3 Pin 4 Pin 5 CTS Pin 5 Pin 6
3. wail f r Tenocet he mamun time in seconds to wat Use blank for no tenecut Ru de on tread If lhe bineamd ocre emetic will cunlinauae freer Que ride mari lisa berth to conlie al mexi role Wait For String rule is configured to wait to see End of File and if it does not see it after 2 seconds then it jumps back to an earlier Send String action item that sends the enter key 4 2 3 Send String Action Item Use the send string to send normal ASCII text to the terminal window with or without the enter key after it If escape codes ie CTRL X are needed to be sent instead use the alternative Send Hex 4 Serot Details Action Details ACTION TYPE Send String ACTION PARAMETERS String Send Newline ACTION HELP Send String Ber k thee specified string to the console Sking The siring lo send Send Newline On wil send the string followed by the configured enter character Of will send just the sting To seki ihe Corviewvte cf a kord Vierinetshe rathar Ihan abal iest Ihen comme SVARIARLE in thee Siring Baki Bytes Action item lt Script Deta l Action Details ACTION TYPE Terminate Script wv ACTION HELP lermanate Senpt Stops proceseing scnpt rules User Manual Get Console 4 2 4 Terminate Script Action Item By default when the script completes its last action item it will terminate by itself therefore this ac tion is only used where jumps between rules are configured see Wait for S
4. BEWE CONNECT Port 23 As RAW Columns Delfau Rows Defau NOT be sent Common use of Telnet RAW is to test open connections to web servers and mail servers to see if they are responding on their standard port 80 port 25 2 2 1 4 Serial For making serial connections via any supported method Redpark C2 RJ45 cable 30 pin Apple connector Redpark L2 RJ45 cable Lightning Apple connector Airconsole Serial over Bluetooth Low Energy Airconsole Serial over WIFI For connecting via Airconsole usually enabling Bluetooth on your iOS device is sufficient or alternatively join the Airconsole XX WIFI network Get Console will then auto detect and use Airconsole for Serial connections For detailed instructions on connecting to serial ports via Airconsole see the Airconsole user manual For connecting to serial ports via Redpark cable simple connect the cable to the iOS device first and then to the serial device Select Cable in the Connect with field Regardless of the way the serial port is connected the following pa lt Back Connection Details Connection Name gt gt CONNECT Bax d Rate 38400 Aara Stop Bits 1 Stop Bit Flow Control Nowe Parity Nowe Data Sits 6 Bits Cornect with eve Columas Default User Manual Get Console rameters can be configured on a per session basis other serial settings are inherited from the Main Settings defaults _ Connection Name Define a na
5. ing multibyte characters for non latin text terminals Maintains multiple sessions concurrently including when the App is in the back ground for upto 10 minutes Session import from SecureCRT and PuTTY via Windows tool and iTunes or via Web converter Full Session Scripting using simple Expect X then Send Y type scripting One Tap Secure Screen Sharing allows a remote web user or Get Console user to view and interact with the iPad iPhones terminal window Cloud file system connectivity to both get console com and Dropbox com for dynamically downloading configuration files and scripts and uploading session log files Tight integration with iPhone iPad clipboard and cut copy paste directly from the terminal window Comprehensive logging support Command Shortcuts Stored Passwords Blue tooth Keyboard and many other features Easy share mode provides a non technical user interface for getting iPhone iPad hooked up to a serial device and then allow a remote web user access to it User Manual Get Console RapidSSH is a cut down version of Get Console app The major feature missing is the ability to use a Redpark physical serial cable to connect to equipment RapidSSH only supports Serial connectivity via our Airconsole WIFI Bluetooth Serial adaptor 1 2 App Requirements 1Phone4s iOS version 7 0 or later is required o iPhone 4S iPad2 iPad 3 supports Redpark C2 RJ45V cable o iPhone
6. 5 onwards iPad 4 iPad Air onwards support Redpark L2 RJ45V cable o All Apps and iOS devices support Airconsole serial adaptor WIFI or Bluetooth mode RapidSSH does not support Redpark Cables Serial connectivity in RapidSSH is only possible via an Airconsole adaptor 1 3 Start Screen Get Console 2 01 and later start for the first time with a selection screen to choose which operating mode the app should run in The app will start in this mode by default from then on unless the operating mode is changed in the settings FULL TERMINAL bah elec pr 1 a1 a1 zm Ma ne 4 a u access to Sena devices via the cloud 4 J acai ne ae User Manual Get Console 1 4 Full Terminal Mode Overview The below picture shows the main Get Console window and identifies the major Ul features Get Console s Ul has changed significantly since earlier 1 x versions Tapping the Open Close Sidebar button exposes the sidebar tra indicators g j Open Sidebar DONNT CTION MANAO te t53 wv J SSH 10 640 222 tn Peel Serial 2000 ta Pew PERT MANAT MeN Wwonn t s Terminal Window iam eee be Ili MAMA H HAS I LOOARU Keyboard Extension Bar LOG MANAGER aah renown Clicking on the Settings button in the sidebar where most of the apps features are configured 1 5 Easy Share Mode Overview If the Get Console app is started in Easy Share mode then Get Console presents us
7. SSH CONNECT Port Default 22 Enter port number of the device to connect to via SSH Hostname Username Enter username to login to the device Port SSH Key Choose an SSH key to login to the device if Username using certificate based authentication The default is Protocol Default None SSh Key None Terminal Settings This section allows for the over ride of the Main Settings default Terminal Settings to TERMINAL SETTIN apply to this connection Change any of the allowed Columas Default settings Rows Detaut Click CONNECT when complete User Manual Get Console 2 2 1 2 Telnet RAW For creating new Telnet connections complete the following items Connection Name Define a name for this connection Hostname Enter hostname or IP address of the device to connect to via Telnet Port Default 23 Enter port number of the device to connect to via Telnet Note that if a non standard port is chosen the Telnet preamble will still be sent If a connection over a non standard port is required without the Telnet preamble ie for when Telnetting on port 80 to a webserver to check that it responds If you ant to create a RAW connection simply follow the same steps as the Telnet Connection but click the button next to As RAW en suring that it is green Port Default 23 Enter port number of the device to connect to via Telnet Note even if port 23 is selected the Telnet preamble will Connection Name oon
8. configure xterm or other terminal types to improve compatibility with other emulation methods that reject vt100 terminal settings 4 1 9 8 Scroll Mode Defines where the terminal view is positioned In versions prior to v1 82 there was no change to the terminal view position on input from keyboard or output from remote device This has changed so the default setting is now Keyboard Input None use touch screen to move around the terminal and scrollback window Keyboard Input Default pressing any key on keyboard will return the window view to the active cursor position within the terminal window Terminal Activity any terminal generated activity will center the terminal view to where the terminal activity is being generat ed 4 1 9 9 Character Encoding Get Console supports 17 different encoding formats The default is UTF 8 which supports single and double byte character sets and is the most common character encoding set in modern use Prior to Get Console v1 7 the default encoding set was ASCII which is still available under this setting 4 1 9 10 Paste Rate Limit When pasting large text files into the terminal window especially when using the older C2 RJ45 Seri al Console cable the remote serial device buffer or buffer memory inside the cable can overflow producing garbled text Get Console has a speed control to allow for text from clipboard or scratchpads to be fed into the terminal at a slower sp
9. fn pp Hiwale a T da levr hamal C lt trite o To link Get Console to a users account use the Sync Settings button By default all folders on the Get Console app are synced with Dropbox however this can changed by using the edit button after logging into your dropbox account and entering synch setting in the main settings side bar Those folders that appear with the dropbox symbol on them are the ones that are being synched While those that have a blue tick are ones that you are choosing not to sync lt Settings Documents Done Unink Account BB connections O ME tes BE keys EE op O Ma BB scripts User Manual Get Console To unlink a linked account use the Unlink button No files are deleted from Dropbox or Get Consoles local file system when accounts are linked or unlinked lt 2 From within your Dropbox account online under apps there will be a Get Console folder that will house all of your folders So you are able to access all your folders whether they are currently being synced or not will determine how up to date they are User Manual Get Console 4 6 SSH Settings Get Console supports both SSHv1 and SSHv2 The protocol selector which versions of SSH will be ne gotiated with the server The SSH Settings section is also used to determine the default authentication method when pass word authentication is used and also allows for the import of OpenSSH format certificates for use in SSH connectio
10. how the session sharing feature works C2 RJ45V OR u PTT SN FTEU LEY UF chent LUSI Remote PC or iPad may directly control field device In order to enable session sharing the Sharing Sessions details must be populated in the App set tings SHARING SETTINGS Remote Server Privat Private Server usdemo gel console com Secure Connection Username demo Password eee 4 7 1 Remote Server Select the closest Public server to the iPad iPhone user for session sharing with a remote user or if Private Server has been installed then select Private Server User Manual Get Console 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 remote web access the terminal sessi on 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 web users from the selected public server Private Server The Private Server is hosted on a customer s own network or at Ama zon EC2 and secured by their own network security policy Disabled The option to share remote session will be disabled 4 7 2 Private Server Private Server is an optional server side component to Get Console that allows for end users to host their own Get Console server on their own network and infrastructure If Private Ser
11. replaces normal log files of readable ASCII text from the remote serial device Connected 0 44 Baud Rate N A device is opersaing at us baud rate RX Bytes 1093 Counters for Received frames for this session TX Bytes 2 Counters for Transmitted frames for this session Remote PIN N A Of by default enable only when instructed Serial Debug Log by Get Console Support Baud rate negotiated with C2 RJ45 cable does NOT mean end State of Serial Flow Control Modem pins Only useful where fow Modem Status CTS DSR CO Ri control is enabled By default Get Console wil set RTS and DTR high Flow Status when hardware fow control is enabled Flow status options OK Get Console wil transmi frames to serial port of waiting om remote side to rase DSR CTS of both TX will not User Manual Get Console 6 3 Session Sharing Issues Session Sharing to Get Console Public Servers fails If user receives Failed to connect read from remote control server Check your internet connection can you browse in mobile safari to www get con sole com Check Session Sharing settings configurations defined in Main Settings gt Session Sharing are correct see section 3 6 If everything is correctly configured try again depending on latency the first at tempt to connect can fail due to underlying encryption key exchan2ge taking too long The next attempt works as the encryption keys are cached by the Get Con sole app
12. screen the most common reasons are Baud Rate mismatch note that Get Console does not support 115200 baud on cur rent Redpark C2 RJ45 cables Flow control is required but not set Note disconnect cable from both iPad iPhone and serial device after changing Flow Control to reset cable Pinouts of device are reversed from what is expected by C2 RJ45 cable This is very common The pinouts of the C2 RJ45 cable are as per Cisco console port Using a RJ45 to DB9 adaptor either makes the DB9 interface DTE or DCE depending on whether it reverses TX RX and flow control singalling pins Use adaptors available from the get console com shop which have been specifically wired to convert the C2 RJ45 to DBY std and DBY null modem including all the control signaling Cable needs to be reset the cable has active electronics in it Occasionally it needs to be reset by removing BOTH ends of the cable from iPad and Serial device and then reconnecting it first to the Serial device end 6 2 Detailed Serial Troubleshooting Get Console has a hidden diagnostics page that can be accessed via holding down the Side bar icon at the top right of the screen This page is used primarily by Get Console developers to detect the active state of the serial cable pins and to enable detailed serial cable debugging Enabling detailed serial cable debugging will write hex values for every frame sent to and received from the C2 RJ45 cable so if this mode is enabled it
13. text files that will be visi ble to the iPad iPhone Get Console application under the 5 2 1 2 Downloading Files from Get Console Website Once files are uploaded to the users Get Console com portal page they are visible via the File Mana ger by tapping the Download File List button The users get console com credentials email pass word must be entered into the Main Settings gt Session Sharing field as described in section 3 6 above in order for the remote files to be visible The list of files is presented to the user Tapping on one of the remote files provides option to down load to the local store Once in the local store tapping the file name again allows for the file to be copied to the clipboard viewer for editing pasting renaming or deleting If the file tapped in the local store is a script or connection file the Get Console pop up will allow these files to be imported into the Script or Connection manager respectively However we do recommend a Dropbox account as apposed to remote files it allows 2 way synching between the local files and those on the dropbox Manager one M Dna Local Piles Local Files No fies presem No Mes present Remote Fikes emete Sas Simpie Cmd Ple update 10 1 tz1 Bigger Clipboard Test from Wi mi gt Link Dropbox account NOCSWA04D POC txt Sanctus WCC CE tat 5 2 2 Importing files from Dropbox account To import text files from a dedicated Get Console folder within the users Dr
14. the script will continue being processed if none of the specified strings are seen within an allocated time frame While the rule number that the script jumps to is a time out occurs can also be specified User Manual Get Console 4 2 12 Wait for Regex Like the Branch action this action creates rule jumps when a certain Regex Regular Expressions ap pear as well as a matching timeout feature It also has a extra feature a Variable which provides a storage location for the first capture group full match is also stored in the system variable SLAST MATCH lt Script Details Action Details ACTION TYPE Wait for Regex v ACTION PARAMETERS if this is seen Jump to rule number if this is seen Jump to rule number if this is seen Jump to rule number if this is seen Jump to rule number Variable Timeout Rule on timeout ACTION HELP Wait for Regex Executes a jump in the script based on which regular expression is matched first If this is seen The regular expression to wait for may optionally contain a capture group Rule Number The rule in the script to jump to if the regex matches Variable Store the first capture group in this variable full match is additionally stored in the system variable SLASTMATCH Timeout H none of the regular expressions match within this number of seconds then continuing processing at the next rule Use blank for an indefinite wait Rule on timeout If the timeout occurs execution wil
15. upload to the users Dropbox folder dedicated to Get Console default is Apps Get Console Via email of individual log files from the iPad iPhone mail client Navigate to the Log Files page then tap a log file name Select the Delete one of the 3 upload options Note to upload to Dropbox the users Dropbox account must be linked to the Get Console app as descri Delete All bed in section 6 2 2 1 above Copy to Clipboard Upload to Get Console website user portal is invoked via the Upload to Website button As per the File Manager the user must Upload to Website have a free Get Console com account and the credentials entered Upload to Dropbox as described in section 3 6 above Send via Email Access to uploaded logs on the Get Console com website is via the Stored Logs button User Manual Get Console lt Settings Documents lt Settings Auto Upload Logs Unlink Account Disabled FOLDERS WITH DROPBOX ICONS WILL BE ap Remote Server BH connections Dropbox E RI files BES keys BS scripts 5 3 3 Auto Uploading Log files As discussed at section 3 1 8 Get Console can be configured to automatically synch log files on sessi on completion to either Dropbox or to the users portal page on the Get Console website To enable Auto Upload select the appropriate option from the Synch Settings In this image the keys scripts and logs are all synching to drop box while the others are not This can be changed by taping the
16. variable name with a character Variable The name of the variable to set App will automatically prepend the symbol to this name String The message displayed to the user during the prompt Maximum 20 characters Secure determines if the text entry is obscured User Manual Get Console 4 2 15 Compare Variable This action compares the variable to an allocated value or another variable If matching a jump will occur with the Action Number specifying the rule number to jump to The String is what will be com pared to the Variable to see if they match lt Script Details ACTON TY Compare Vanable v ACTON PARAME IERS Variable String Action Number Compare Vanab o Compares To vanabie agarct 2 cpecifed vave ce another vanabio E The two maith en ju to the Schon rumber oven VaxatLt la Thee nave ol the varakioe k chech e GVAMAL PNAM String The string to check against use a character to use a varat e ACO Number ie rule number 10 jump t the Two waves are CQual 4 2 16 Confirm This action displays a yes or no confirmation dialog to the user The String specifies the message that will be used to prompt the user Action Number indicates the rule that will be jumped to if Yes is entered If No is tapped then it will continue to the next rule ACTION TYPE Conwm v ACTION PARAMETERS Action Number ACTION HELP Confer Depheys n corferestaon ialog to the use proenplirg fo
17. whether the connection is live connected blue or closed disconnected red New Serial Conne test Not Shared Not Shared The following table describes the actions available Session Options Allows for editing of changeable settings while the session is live for example changing the terminal width scrollback colour scheme etc Share Session Will share the terminal screen with the configured remote server Public or Private and generate a one time token code See the session sharing Settings section 3 6 above and how to operation below Disconnect Session Disconnect from the remote server Telnet SSH Raw or disconnect the serial cable Serial The session will stay visible in session manager list of sessions with the 2 below options available Restart Disconnected Session Attempts to reconnect the session to the remote server Telnet SSH Raw or cable Serial Remove Disconnected Session from Session Manager User Manual Get Console 2 4 Session Sharing Tapping the share button will attempt to share the selected terminal session with the Get Console website or confi gured Private Server so that a remote web user can see and interact with the terminal session at the same time In order to use this feature the settings for session sharing must be configured in the main settings page see section 3 6 above Each shared terminal session is dynamically given a one time token code at the time session shar
18. A ACTON TTT Wart for Siring Want tor SMN Send String Send Hex Bytes Terminate Sore Pause Sonpt Maisecond Pause Despary Meatage Jump to Action Stan Logging Stop LOQO Upsaad Log Run Song Branch wan for Regex Set vanana Promet f r vaname Compare Vansme Contem Sand Config File Acton Detats Script Details Add New Action Reorder Actions Save By default the first action is Wait for String however it can be any of the following action items Change by tapping item 1 which then allows one of all of the possi ble action types to be selected At the bottom of the screen is whe re the parameters for the action item is configured along with some guidance text on which and the type values that can be entered 4 2 2 Wait for String Action Item Note that the Wait for String action is quite powerful in that it can be used to create loops via the Rule on timeout parameter By default the script executes each item in the script sequentially however using the Rule on timeout the script could alternatively jump to earlier or later action items For example if the script must keep pressing enter until it sees End of File then the User Manual Get Console ACTION TYPE Wait for String ACTION PANAMETENS String Timeout Rule on timeout ACTION HELP Wat for Siring Wels for the specified siring lo agape on ihe corsele before conlinuln g lo ihe nert script sale String The stringy k
19. He OSR Pin 6 Pin 7 VEL GND Pin Pin 8 BRN DCO RTS Pin 20
20. TAB CTRL cMnA r Saved passwords are recalled in terminal sessions by tapping the a button While the passwords middle characters are obfuscated when recalled via the terminal or the password menu to ensure PASSWORDS A ERRI J security of sensitive information 3 1 5 Clipboard Viewer The iPad version of Get Console has a full screen clip board window accessed via the Pasteboard button on CONNECTION MANAGER the side menu This allows the user to see and edit the contents of the iPad s clipboard and then paste SCRIPT MANAGER v The iPhone version of Get Console has a whole page PASSWORDS v clipboard viewer with the same buttons for pasting to the terminal window COMMANDS v FILE MANAGER PASTEBOARD LOG MANAGER SETTINGS User Manual Get Console 3 1 5 1 Paste Clipboard to Console Pastes the content of the clipboard to the console If the user has made changes to the clipboard viewer text but has not selected and copied the clipboard viewer to the internal clipboard then this button will paste the clipboard viewer contents prior to any edits 3 1 5 2 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 Effectively what this button does is copy the edited view to the clipboard prior to then pasting to the terminal window Once the editor is closed the
21. TO SESSION IN FULL TERMINAL CLOSE SESSION If the serial connectivity to the end serial device is interrupted then the user will be prompted to cor rect it by tuning the settings available by pushing the cog icon The iPhone iPad user can always get to the full Get Console terminal at any time User Manual Get Console 2 Launching Connections Full Terminal Pressing the button will open the Sidebar from which the Session Manager uses the first block to display any active or recent but now disconnected sessions If there are no active or recent con nections then nothing will be shown except for the Connection Manager button The session mana ger can be hidden by the symbol next to the Connection Manager button Get Console provides 2 ways to launch connections first via the Quick Connect button for a Quick Connection or via the Connection Manager to create and then launch a saved or recent unsaved quick connection The below drawing shows the Session Manager with 2 connections and a button to launch the Connection Manager As can be seen the Session Manager shows 1 active and also 1 recently closed session that can be restarted Within A each session the options ie like scrollback length window size etc can be varied from the Settings defaults via the settings New Serial Conne cog button on each connection bar Any Not Shared live session can be shared a remote user via the share butt
22. User Manual Get Console RapidSSH Date 20 August 2014 User Manual Get Console 1 Introduction to Get Console 6 1 1 What are the Get Console and RapidSSH Apps 6 1 2 App Requirements 7 1 3 Start Screen 7 1 4 Full Terminal Mode Overview 8 1 5 Easy Share Mode Overview 8 2 Launching Connections Full Terminal 11 2 1 Quick Connect 12 2 2 Connection Manager 12 2 2 1 Creating New Connections via Connection Manager 13 2 2 2 Managing Connections in Folders 16 2 3 In Session Options 18 2 4 Session Sharing 19 2 4 1 Start Session Sharing 19 2 4 2 Remote User Access 20 2 4 3 Stop Sharing Session 21 3 Terminal Features 22 3 1 Terminal Features 22 3 1 1 Keyboard Control 22 3 1 2 Keyboard Popup Bar Selector 22 3 1 3 Command Manager 23 3 1 4 Password Manager 24 3 1 5 Clipboard Viewer 24 4 Main Application Settings 26 4 1 Terminal Settings 26 4 1 1 Columns Default 80 26 4 1 2 Rows Default 24 26 4 1 3 Scrollback Default 100 26 4 1 4 Clear On Connect 26 4 1 5 LineWrap 27 4 1 6 Text Size 27 4 1 7 Console Logging Default Off 27 4 1 8 Auto Upload Logs Default Off 27 4 1 9 Advanced Terminal Settings 27 4 2 Script Manager 30 4 2 1 Create New Script 31 4 2 2 Wait for String Action Item31 4 2 3 Send String Action Item 32 4 2 4 Terminate Script Action Item 33 4 2 5 Send Hex Bytes Action Item 33 4 2 6 Pause Script Action Item 33 4 2 7 Display Message Action Item 34 4 2 8 Start and S
23. ated or edited externally can be uploaded via the Add button When Get Console starts it checks the root folder for script and connection files and moves these into the correct internal folder From version 1 82 and later connection and script files are detected via the local file system and when tapped in the file system viewer are optionally installed into Script Manager or Connection Manager automatically It may be necessary to stop and restart the Get Console application on the iPad iPhone to trigger the auto installation of connections zip files User Manual Get Console 6 General Troubleshooting This section covers common problems reported by users and typical fixes work arounds 6 1 Serial Connectivity Issues Serial connectivity issues can be divided into 2 types Where Get Console cannot recognize communicate with Redpark C2 RJ45 cable Where Get Console can recognize Redpark C2 RJ45 cable but no console output is seen on the screen The following flowchart helps answer the most common reasons why no output can be seen on screen when serial cable is connected to a device Note that why Get Console is generally compatible with many serial devices Cloudstore will only support troubleshoot connections to devices that we Serial Comectivity Troubleshooting Flow Chart Geeen Outine on Comnection icon but no upu On screen Connecton icon compietaty Grey andor Cosnecton Error Fail
24. content of the clipboard will revert to the original clipboard again un less the edited Editor is copied which then replaces the clipboard content 3 1 5 3 Launch Scratchpads Get Console v1 82 and above has 3 additional scratchpads that can be used by user for loading in text files for editing and pasting to the active terminal session Clipboard Editor PuTTY User Key File 2 ssh rsa Scraich pads Encryption none Comment sd Public Lines 4 AAAAB3NzaC1yc2EAAAABJQAAAJIFArR3ZwHTGdjBZI TCVKd9WOeCuWTV baq9 2 U QITDDCEbnOGB6P45RKTSQVVImtbSCCXkIHOQbodVQGFKGIvlORwsjiiSb5rtc2316jP2 yv39ROGXHa6FhoXRtlio pXcAVYmeQP nMOwY9R9WILoFZYKTUEkB iCrLSX2DvK afiturmxas Selecting an unused Scratchpad can be used to either create new text or load a file into for editing Selecting cancel returns to the active terminal window User Manual Get Console 4 Main Application Settings l l l SETTINGS a The Main Settings page is accessible via the button then This sets the application Default settings for all sessions as well as many other features Some of these defaults can be varied on individual saved connections See Section 4 Connection Manager The App settings cover 5 main areas Terminal Settings features specific to the terminal window things like linewrap local echo scrollback size but also access to the terminal scripting features Keyboard Settings features for how the keyboard behaves with or without
25. continue from this rule number Use Blank to continue at next rule 4 2 13 Wait for Regex Sets a variable to a specified value This can then be used in almost all the same places that strings are required by prefixing the variable name with a character The String action parameter is the value that the variable will be set to Also the App will automatically prefix the entered Variable name witha S User Manual Get Console lt Script Details Action Details ACTION TYPE Set Variable ACTION PARAMETERS Variable String ACTION HELP Set Variable Sets a variable to the specified value The variable can be used in most places where a string is required by prefixing the variable name with a character Variable The name of the variable to set App will automatically prepend the symbol to this name String The value to set the variable to 4 2 14 Prompt for Variable This action prompts the user for a variable With it mostly able to be used where a string is as long as S is prefixed to the name The String is the message max 20 characters shown to the user during the action While the Secure button determines if the txt is obscured or not lt Script Details Action Details ACTION TYPE Prompt for Variable ACTION PARAMETERS Variable String Secure i ACTION HELP Prompt for Variable Proenpts the user for a variable The variable can be used in most places where a string is required by prefixing the
26. d from the remote device exceeds the column width and no carriage return has been recei ved The default is ON 4 1 6 Text Size Sets font size in the terminal window Smaller Larger 4 1 7 Console Logging Default Off Logs all printable output to file stored on iOS device The log files can be uploaded to www get con sole com website Dropbox com folder Uploaded to a Private Server attached to email or extracted via iTunes Log upload is performed via the Files section described below 4 1 8 Auto Upload Logs Default Off Automatically upload log files to remote storage repository when the session finishes The default is off Note that this feature will fail if Wifi 3G connectivity is not available at the time the session finis hes Get Console Re mote Server Dropbox Note that to upload logs automatically to a users Get Console Public Server Private Server or Drop box com folder requires that the Remote Server username password be configured in main settings for Get Console Public or Private Servers or Dropbox account be linked to Get Console Application also in Main Settings 4 1 9 Advanced Terminal Settings 4 1 9 1 Bell Behaviour Play Alert bell vibrate phone Do Nothing silent Allows the iOS device to create an alert when there is an Terminal event or stay silent User Manual Get Console 4 1 9 2 Cursor Allow the choice of cursors that appear in the terminal Vertical Line
27. e Connection Manager is used to create testing1 modify and launch saved connections Tapping Connection Manager in the Session Manager Serial popup will launch Connection Manager where all saved connections can be administered test Creating new connections can be done one of 3 ways Telnet 10 64 8 1 23 1 Via the Connection Manager New O Connection dialog box discussed Airconsole BLE in this section 2 By converting a Recent Quick Con Remote 0081358 nection to a saved connection via the blue arrow Give the recent Remote 0081358 connection a Description and then tap Save Serial i 3 By importing connection files into Get Console via iTunes Get Airconsole BLE i HAD DANN Av Console provides a free tool to convert existing PuTTY and Secure CRT ini files into Get Console connection files This tool can Clear Recent Connections User Manual Get Console be downloaded from www get console com tools The method to import the connection files into Get Console via iTunes is documented at www get con sole com tools importutility 2 2 1 Creating New Connections via Connection Manager 2 2 1 1 SSH For creating new SSH connections complete the following items lt Back Connection Details Save Connection Name Define a name for this connection Connection Name new oon Hostname Enter hostname or IP address of the de vice to connect to via
28. ected No Qutput on Screen 60 6 2 Detailed Serial Troubleshooting 60 6 3 Session Sharing Issues 61 7 Appendix A Specific Device Serial Port Pinouts Ji ADTRAN 550 62 2 CBX PhoneMail DB9 and DB25 Adaptors 62 62 User Manual Get Console User Manual Get Console 1 Introduction to Get Console 1 1 What are the Get Console and RapidSSH Apps Get Console is an Apple App Store distributed terminal application for iPads and iPhones that allows IT engineers to connect and control RS232 serial ports such as to the console port of Cisco devices or run Telnet RAW or SSH v1 or 2 terminal sessions over WIFI and 3G With the Get Console app IT engineers can perform IT equipment maintenance troubleshooting and disaster recovery operations directly on the serial device console ports or over Wifi 3G using the instant on portable iPad iPhone or iPod Touch all WITHOUT jailbreaking The Get Console app now has many features including Physical serial to network and other equipment via the Redpark L2 RJ45V cable supports 300 115200 baud optional parity optional flowcontrol variable stop bits and either 7 or 8 databits Serial connectivity via Serial over WIFI Bluetooth Low Energy adaptors such as the Airconsole adaptor SSHv1 SSHv2 Telnet and RAW connectivity over WIFI 3G VT100 xterm and many other common Terminal emulations Encoding support for ASCII UTF 8 and 17 other major encoding formats includ
29. ed to Connect is the Cable Connected Oukut can appear not where nate panne rekar ne Get Console only works wth Riedpark C2 40 45 Cable Other cables wil not work to check serial output is not obewthere n Pe terminal window Baud Rate mismatch is common cause of no output seen Get Remove enema cases Cable seating Conacte supports 5300 57600 baud is a common cause of not Getectng cable H Gawd rate is correct most thely cause of no output is FlowCorirgl expected by serial Gewice but none is enabied in Get Console Try ATS CTS first followed by XONOFF Ext Get Console app o 1 Phone iPad Settings gt General lt About Soroll to botom of frst block below modem firmware or ICOCID should be Console Cadie tapping thes will show f rnarce and hardware rew na of Cable and piove that iOS can see Pe C2 AM5 Cabbie l cable not detected then possite faulty cable Aotum to Reselier tor replacement Cable has active fwrrware to reset cable disconnect from BOTH iPad ard serial device Then reconnect serial Gewice end frat Get Consolo wil only awto in late commection to Nestar Get HOS can see cable bul connection icon does not go Comecte App green when conmection icon is pressed restart or completely reinstall Get Console App works with identical settings To actwate detated serial cable logging tap just 1o the left of Pe setings cog con Captare This will reveal a hidden monu wth a swch to tur
30. edit button where you can select which icons you do not wish to synch Note that when Auto Upload logs is enabled the iPad iPhone must have Internet connectivity via 3G or Wifi at the completion of the terminal session If there is no Internet connectivity then the auto upload will fail and Get Console will NOT re attempt to auto upload that log file The log file will still be saved locally and available for manual upload User Manual Get Console 5 4 Script and Connection Get Console Files Get Console stores connection and script files for saved connections and saved terminal scripts re spectively These are created and managed in the Connection Manager see section 4 2 or Script Manager see section 3 2 These are simple XML files and can be manipulated externally from the Get Console application and then re uploaded Existing connection and script files can be extracted via Dropbox syncing to a folder or alternatively via iTunes Dropbox connectivity is covered in the File Manager section above To extract via iTunes connect iPhone iPad to PC Mac run iTunes navigate to the iPad iPhone device and then select Apps File Sharing Apps Get Console Documents hel vernote __ connections _ scripts Get Console Let Satlom ae Google Earth The connection and script files can be extracted via the save to button at the bottom of the page Individual connection and script files that have been cre
31. eed to ensure that the receiving device and C2 RJ45 cable do not overflow their receive buffers Internal testing has found that for Cisco console ports configured at 9600baud the best setting is High Speed and hence this is the default The High Speed Setting allows for a 800 line configuration file to be pasted into a Cisco device without error in around 10 seconds User Manual Get Console 4 1 9 11 Transfer Protocol When uploading binary files via Serial cable Get Console can use a variety of legacy protocols The default is prompt user to select the protocol when the upload is invoked however can be set here so user is not asked The options are Options XMODEM Original X Modem Protocol XMODEM CRC Xmodem with CRC checks every 1024 bytes XMODEM 1K Xmodem with ACKs every 1024 bytes goes faster than Xmodem as less acknowledgements YMODEM YModem goes faster than XModem RAW Sends raw file data without any protocol framing 4 2 Script Manager The script manager allows for the creation of terminal scripts Once created these scripts can be run immediately on connection by assigning them to saved connection in the Connection Manager or alternatively by running once a terminal session is started via the Script button which can be added to the keyboard extension bar Scripts are built by adding one or more action items to the script in order that the terminal should e
32. er the remote user will not be able to interact with the session until Get Console is brought to the iPad iPhone foreground again 2 4 3 Stop Sharing Session To stop sharing an iPad iPhone terminal session with a remote user tap the connection manager button to activate the Session Manager popover then tap the Li button for the terminal tab that sharing should be disconnected The world icon will turn grey and the subtitle will change from the token code to say Not Shared User Manual Get Console 3 Terminal Features This section discusses the following Get Console terminal features Keyboard popup bars Command Shortcuts Password Shortcuts Clipboard Viewer 3 1 Terminal Features 3 1 1 Keyboard Control Use the El button to hide the onscreen iPad keyboard and double tap the terminal to revel it again Used to increase screen real estate especially useful for debugging in the iPhone iPod with its smaller screen Note that when a Bluetooth keyboard is connected then there is no software key board on the screen 3 1 2 Keyboard Popup Bar Selector New Bar Restore Bar Duplicate Bar For the Default option the user can create their own combination of buttons on the top bar by pressing and holding each indivi dual button A button selection popup will allow these keys to be changed to one of many options In version 1 81 or later any key from the Apple keyboard can be instal led on the Custom keyboard bar i
33. er with a 3 stage Wizard interface The interface is designed to guide a non technical user to connect their iPhone or iPad to a Serial port via a Cable or Airconsole adaptor and then progresses to share the access to that serial port with our cloud service so that a remote user can access it This mode is designed primarily for field service companies that need an easy way for remote sup port personnel to access and control the serial console port of various industrial networking or utili ties type of equipment Easy share lets any non technical user with an iPhone provide the bridge between the remote support and the serial device User Manual Get Console The following screens summarise the Easy share process Carrier 3 54 PM Carrier Searching for Airconso ela al 2 edTela Carrier gt Carries gt Use Demo Server Private Server User Manual Get Console Once a serial device is successfully connected to a remote Get Console server either our demo ser ver or a configured Private server then a session code is shown on the screen The iPad iPhone user can now use the Share button to send this as a URL link to the remote user via either SMS text or email Carrier aba Qanszaiam mna a Remote Session Now Active Serial access now available to cloud via this session code 0810315 be Txt or email the code to remote user Go to Full Get Console terminal to interact GO
34. external Bluetooth keyboard running Serial Settings features specific to Serial Connections ie baud rate SSH Settings features specific to SSH Connections ie Certificates Keys Authenti cation methods Sharing Settings settings requiring configuration in order to share the terminal window with a remote user via the get console com website or privately hosted Get Console server Cloud Storage Settings settings requiring configuration in order to link the Get Console app file system with Dropbox and in later versions iCloud The following section details each of these setting areas 4 1 Terminal Settings 4 1 1 Columns Default 80 Supports any column width up to 132 characters wide Columns 80 4 1 2 Rows Default 24 Supports any number of rows on the screen Rows Scrollback 100 4 1 3 Scrollback Default 100 Number of lines retained by the console for review Setting Clear on Connect this above 250 will impact performance on iPhone4 and be Line Wrap low iPad2 iPad3 and iPhone 4S supports 500 scroll back wi thout impact due to improved hardware specifications a A Ea 4 1 4 Clear On Connect onsole Lo gorna Defines whether the terminal should clear the screen when Auto Uoload Logs starting a new connection Advanced Settings The default is ON User Manual Get Console 4 1 5 LineWrap Defines whether the terminal should automatically wrap the line to the next line when the output receive
35. guration of a Private Server in the Private Server Settings Sessionld This is a token code that is required Tap here to learn more about Private Server to gain access to a remote session Generally this is a random code for remote Get Console lap here to configure the Private Server settings sessions however for Airconsole units it can be persistent and therefore it is useful to save it in a saved connection for future use Connection Name Example Telnet Remote CONNECT REMOTE SETTINGS Private Server es Sessionid 1234 2 2 2 Managing Connections in Folders Connection Manager allows for the creation of connections grouping of connections into subfolders and also for cloning connections and moving them between subfolders These folders are stored in the Get Console Application s file system area within the iPhone iPad They can be exported via iTu User Manual Get Console nes however the easiest method to extract or import new connections is to use Dropbox connectivi ty The internal connections folder is automatically synced with Dropbox so can be modified on re mote Mac or PC with the changes pushed to the Get Console app immediately 2 2 2 1 Creating and Managing folders and sub folders for Connections Tap New Folder to create a new folder and en ter name in dialog box The folder appears at the top of the Saved Connections List Folders can be nested so to create a subfolder navigate to the new fo
36. he keyboard when in transparent mode 4 4 Serial Settings Get Console s Serial Settings allow for the SERIAL SETTINGS full range of physical serial settings avail able on the Redpark L2 or C2 RJ45V adap Auto Connect tor to be set Get Console also supports Serial connec Baud Rate tions over Bluetooth Low Energy or WIFI using our Airconsole adaptors When the Stop Bits RJ45 based serial cable is further adapted to either DB9 or DB25 presentation only the pins available on RJ45 connector can Flow Control be carried through ie Pin 9 on DB9 con nector Ring Indicator cannot be carried Parity Below describes the parameters available for each Serial option Data Bits 4 4 1 Auto Connect Get console app automatically connects to the physical cable connection RJ 45 or serial when it s plugged into the iPhone iPad iPod port This applies whether or not there is an existing Telnet or SSH connection a new Serial connection will be added to your connection list The default is ON 4 4 2 Baud Rate Allows the choice of different baud rates to suit communication with the network device Failure to select the correct Baud rate for your serial device will result in either no output or garbled screen output Note while Get Console will build a higher speed 57600 or 115200 baud connection over Bluetooth Low Energy BLE the underlying BLE transmission rate is not this fast so buffering and in some cases packet loss ca
37. ing is initiated This code is You are Sharing your Terminal Sharing wih Private Server The sesemmn code s US US The femote ester Cae omor Pas Code at uademo get comsole corn to Acat your current casion Copy used to secure access to the users iPad iPho ne The remote web user must know this 7 digit token code in order to see the iPad iPhones termi nal window Only sessions that are shared are visible to remote users however multiple concurrent sessions can be shared each with their own unique one time token code 2 4 1 Start Session Sharing Once the notification You are Sharing your Terminal appears the remote user can access the iPad via the token code displayed in the notification To make it easy for the remote user to learn the code it can be emailed or copied to clipboard via this notification window Options Function OK Return to the active terminal window Copy Copy the remote access token code to the clipboard so that it can be used in txt message or other iOS device message Email Email the remote access token code to a recipient with instructions how to connect to the shared session User Manual Get Console Once shared the token code will also appear in the Session Manager and the share icon will show blue test Li 0843339 2 4 2 Remote User Access Remote access to shared terminal sessions is dependent on whether they have been shared with the Get Console co
38. ings configured here will af Enter Key fect the Bluetooth keyboard Note also that full Bluetooth Keyboard support is Use Option as Ctrl not yet implemented as at version 2 01 ESC and Arrow keys will not work on a Bluetooth keyboards 4 3 1 Backspace Key Certain terminals expect Backspace to be sent as CTRL Delete ASCII Ox7F rather than the Back space CTRL H ASCII 0x08 The default setting is CTRL H Control H Control 127 4 3 2 Enter Key Get Console has 3 options for what is sent when the enter key is pressed By default it sends just Car riage Return OxOD which is the OSX standard This can be changed to Line Feed Ox0A or both Car riage Return followed by Line Feed OxODOA each time the enter key is pressed Options Carriage Return Line Feed CR LF 4 3 3 Use Option as Ctrl Get Console implements a workaround for the control key not working on Bluetooth keyboards If using a Bluetooth keyboard with Get Console you can select the Use Option and Ctrl to use the Alt Option key on the keyboard to send CTRL key sequences The default setting is OFF User Manual Get Console 4 3 4 Keyboard Transparency On the newer version of the Get Console application the keyboard can be toggled between transpa rent and solid on the keyboard itself with the toggle keyboard icon The slider on keyboard settings allows you to control the transparency of t
39. lder by tapping it then tap the New Folder button again Saved connections can be moved from one folder to another or to the root To move a connection tap the blue arrow next to a saved connection scroll to the bottom where there are options to Move to a Folder as well as Clone the Connection or Delete A sub folder can also be created under another folder with connections in it Note that if you de lete a folder which contains a connection the connection will be moved to the root folder ins tead of being deleted together with the folder Move Folder Clone Connection User Manual Get Console 2 2 2 2 Recent Connections Get Console Connection Manager presents the 10 most recent connections below the Saved Connec tions The connections listed in Recent connections include Quick Connections and Saved Connec tions This list can be cleared by tapping the Clear Recent Connections button at the very bottom of the list Alternatively a recent connection that was made via Quick Connect method can be saved to the Connection Manager via tapping the blue arrow providing a name description for the con nection and then tapping save The connection will then appear in the root Saved Connections folder of the Connection Manager 2 3 In Session Options Once a connection has been established or attempted to be established it will appear in the Session Manager From this popup the actions that can be performed depends on
40. m public servers or via the users own privately hosted server Private Server For the purpose of this manual it is assumed shared with the Get Console com public servers To learn more about Get Console Private Server visit www get console com private server When the remote user has obtained the one time token code they enter it on the home page at www get console com or if the token code was shared with the remote user via email there is a sin gle link to click in the email to directly connect ma a iPad Serial Connectivity F Connect to live session es Lee EJ After entering the token code the code is checked against currently active and available codes and if correct the Get Console web terminal will launch The remote user is presented with a plugin free web terminal that mirrors what is on the screen of the Get Console app running on the iPad iPhone User Manual Get Console nare C2500 SAL 35 3 M Both iPad iPhone user and remote user can interact with the terminal session at the same time however only one remote user can access any given session If a later remote user enters the same token code their later session will take over from any existing remote user Note that the remote user can only interact with the terminal while the Get Console app is fore ground on the iPad iPhone If Get Console is in the background then it will still maintain its Serial Telnet SSH session for upto 10 minutes howev
41. me for this connection Serial Settings The Baud rate Stopbits Flow Control Parity and Databits can be set on a per connec tion basis All other settings are globally configured in the Main Settings page Terminal Settings As per all other connections the terminal settings defines a non default Terminal characteristics for just this connection Keyboard Settings As per all other connections the Keyboard settings can override the default Key board settings on a per connection basis User Manual Get Console 2 2 1 5 Remote For this feature to be used the purchase of the Get Console Private Server is required It allows you to lt Back Connection Details remotely connect to shared existing terminal sessi ons created by other users or directly to remote Air console devices j n ion Name new Remote Connecti Connection Name Define a name for this con Connection Name Learn about Private Server This link will send you too the private server page on get conso le com where you can learn about the features of a Get Console Private Server and purchase one if you are interested CONNECT REMOTE SETTINGS E a 2 This feature lets you connect to extsiting terminal Private Server Settings This Link will just send ssesions chased fora oihar Gat Conaola unsere or you to the the Sharing Settings within the main remote Airconsole devices To use this feature Settings menu where you can connect to your requires confi
42. n addition to the ones available in the popup picker Using the CTRL key on the picker prior to selecting a Apple keyboard key will put CTRL selected key instead of the normal key User Manual Get Console 3 1 3 Command Manager Command shortcuts are added in the Command Manager Once entered they are available with one tap via the Cmds popup from the top keyboard bar Each command is sent with a carriage return after it ESC r CRC OS Tapping CMDS will show the list of current command shortcuts A few shortcuts have already been defined by default and user Command Manager Launches Command Manager page for entering more quick commands lt break gt sends terminal break sequence lt esc gt sends ESC sequence for selected encoding method lt pipe gt sends the symbol WITHOUT a Carriage Return can add their own custom command shortcuts for use in the terminal by simply typing in the new command then taping the button Adds command shortcuts just bellow your current short cuts Swipe to left on Command Side menu Changes the right side of the row to edit and delete buttons which then can delete the saved command shortcut COMMANDS A User Manual Get Console 3 1 4 Password Manager Like the Command Manager Allows user to save passwords to be used as shortcut instead of typing the entire password all over again Add passwords here for quick use in terminal via keyboard icon eS
43. n occur 1200 Baud 2400 Baud 4800 Baud 9600 Baud 19200 Baud User Manual Get Console 38400 Baud 57600 Baud not recommend ed for BLE 115200 Baud not recom mended for BLE 4 4 3 Stop Bits Default 1 Stop Bit 1Stop Bit 2 Stop Bits 4 4 4 Flow Control Default None Use flow control where your serial device requires it Examples of devices that require Hardware Flow control to be enabled include older Cisco 3500XL 2900XL series If the Flow control setting is changed the Redpark C2 RJ45 cable must be removed and reinserted to reset its configuration Flow control changes on Airconsole occur immediately Hardware RTS CTS Hardware DSR DTR Software XON XOFF 4 4 5 Parity Default Off 4 4 6 Databits Default 8 Bit Set Databits required by your serial device User Manual Get Console 4 5 Cloud Storage Settings In version 1 120 and later of Get Console including 2 0 Dropbox has become tightly integrated with the Get Console file system Linking Get Console to Dropbox allows for the synchronisation of the local Get Console App file system with a dedicated Dropbox Apps Get Console folder and sub fol ders stored on the users Dropbox account lt Settings Documents Unlink Account FOLDERS WITH DRIOPBOX ICONS WILL GE SYNCED connectors files gt ka n e rea kogs The app Get Console would like to nt connect with your Dropbox scripts
44. n on detalled senal port debugging detadoed vere Tem this switc on ard Also ensure that Logging is enabloed in the main setings kq ard emad Tey the commection again and then emad log file to support get conscle com for amay sis User Manual Get Console have officially tested with The most recent list of Cloudtore supported serial devices for use with Get Console is contained in the support forum at http www get console com forum 6 1 1 C2 RJ45 Cable Pinouts The following drawing show the standard C2 RJ45 cable pins and what serial signal they send and also the corresponding pins when the RJ45 to DB9 adaptor is used as purchased from the www get console com shop 6 1 2 Console Cable Not Detected 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 gt about gt 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 con nected but it is not detected by the apple iOS operating system then check it is sea User Manual Get Console ted correctly reinstall Get Console and if still having issues contact the cable vendor for a replacement 6 1 3 Console Cable Detected No Output on Screen If the cable is detected Green outline on Connection icon for Serial session but no output appears on the
45. ns that use certificate based authentication 4 6 1 Keyboard Auth SSH Allows for interactive keyboard password authentica tion in addition to the usual SSL security Use Key board Interactive method to SSH into servers that re Protocol he Freres quire this method for example to SSH to Mac OSX Lion Server requires Keyboard Interactive method Try alternating the method if you can launch and to SSH Agent connect to an SSH server but no login or password prompt appears The default method is ON SSH SETTINGS Keyboard Auth SSH Compression Private Keys 4 6 2 SSH Agent SSH Agent allows Get Console to store and reuse RSA keys as required by end user to avoid having to re enter key pass phrases during subsequent authentica tion challenges by SSH Server If SSH Agent Forwar Agent Enabled ding is also enabled then the SSH server can also use the same keys on ssh sessions originated by the user from one SSH server to another Agent Forwarding 4 6 3 Private Keys Allows for private keys to be imported and used in lt Settings SSH Keys console sessions SSH KEYS NO EXISTING KEYS Import Key Generate New Key 4 6 3 1 Import Key Key Name Define a key name for identification purpose when assigning to SSH sessions Paste Private Key Data Below User Manual Get Console Paste the OpenSSH formatted key data into this window then press Import button If successful a dial
46. og box will appear confirming import and the key will be available to use assign to saved SSH connections lt Back Import Private Key Import Key Name Paste Private Key Data Below 4 6 3 2 Generate Key Get Console can generate new RSA SSH2 DSA or RSA SSH1 keys for use in SSH sessions These keys are stored in the keys directory and will be synced also with Dropbox Options for generating keys Key Name Define a key name for identification purpose when assigning to SSH sessions lt SSH Keys SSH Key Generator Key Name Untitled Bit Length 1024 Passphrase lt SSH Keys Key Details KEY DETAILS Key Name Comment rsakey 2014 07 14 Key Format PuTTY SSH 2 Key Type Encrypted Ne Fingerprint ssh rsa 1024 37 11 76 a Use with Agent No KEY ACTIONS Copy To Clipboard Copy Public Key to Clipboard Rename Key Encrypt Key Convert to OpenSSH format Use with Agent User Manual Get Console 4 7 Sharing Settings Get Console allows you to share your terminal window s with remote web users or other Get Conso le users Each concurrent terminal session on the iOS device can be shared independently with the get conso le com website or a customers own hosted Private Server Once sessions are shared via individual one time token codes they can be accessed by other Get Console users or via a web browser assu ming those remote users know the one time code The below drawing provides a overview of
47. on and the session can be stopped via the eject button test Not Shared If a session is stopped or times out then it still remains visible in the Session Manager until it is deleted via the X button or is re started via the restart button There are hardware limits to the number of concurrent sessions that can be run in Get Console de pending on the Apple iOS device in use The below table provides these limits Apple Hardware Number of Concurrent Live Sessions Allowed iPhone 4S iPad 2 iPod Touch 4 iPhone 5 iPad 4 and lat er Bo User Manual Get Console Pressing the Quick Connect button on the top of the main menu bar the Quick Connect opti on is launched This dialog allows for the in QUICK CONNECTION stant launching of a new Telnet SSH Raw or Serial connection in addition to launching an automatically saved recent connection Either Hostname localhost Quick connected or launched from the Connec tion Manager Port 22 Depending on the type of connection various session parameters such as hostname IP ad Username dress will need to be completed and then tap the Connect button SSH Key None Get Console can maintain multiple live Serial SSH and Telnet connections in the Session Ma CONNECT nager The user can navigate between the cur rently active terminal session by tapping it in RECENT CONNECTIONS the Session manager as shown above test new 2 2 Connection Manager gt Th
48. opbox com account the user must first link their Dropbox account with the Get Console app After successfully linking the File Manager will be able to see User Created text files stored in the users Dropbox Apps GetConsole folder and download them to the iPad iPhones local storage User Manual Get Console Once in local storage the same operations are permitted as described for Get Console portal files are possible Copy to Clipboard Rename or Delete User Manual Get Console 5 2 2 1 Linking Dropbox Account to Get Console From version 1 82 linking to Dropbox is performed from the Main application settings In the main settings tap the Link to Sync Settings button under Cloud Storage Settings This will start the mobile safari browser where the user will enter their dropbox com credentials to login or alternatively if they already have the Dropbox iOS application installed on their iPad iPhone it will present a simple allow disallow dialog box Tap Allow after which control will return to Get Console From Get Conso le File Manager it will now be possible to download and Dropbox folder contents to the local stora ge area and visa versa Note that once linked the user can unlink Get Console from their Dropbox account either within the Main settings or via the Dropbox website Only a single folder is linked to the users Dropbox reposi tory not including any subfolders therefore any files the user wants visible to the File Manager mu
49. or style the default is None 4 1 9 3 Blink Cursor Cursor blinks the default is Off 4 1 9 4 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 4 1 9 5 ANSI Colour Allows up to 256 colours on terminal window following the ANSI spec for signalling colour The de fault is ON 4 1 9 6 Local Echo Controls whether the terminal will echo characters entered to the screen locally or rely on remote serial device to echo them The default is Auto where the terminal attempts to recognise if remote serial device is echoing characters and if so disables local echo If both local and remote echo are enabled then double characters for every single character typed will appear on terminal window in which case use Force Off setting User Manual Get Console Force Off 4 1 9 7 TERM ENVIRONMENT Free Text field where Telnet SSH Sessions can send the TERM xxx to the remote server to indicate capabilities Get Console is a VT100 terminal however you can
50. r a yaro anmaraycer neg Me messace to promot the user ai Acton Nur et the rule to erm A Veo s crossed E No is oresecd emocution comtrwes at the Acrt rule 4 2 17 Send Config File Sends a configuration file line by line to the terminal with blank lines skipped The File name is the file that will be sent It is important to include a pathname for the files folder Pause allow you to control the number of milliseconds to wait between sending each line to the terminal Blank indica tes no pause User Manual Get Console lt Script Details Action Details Send Config File v Pause ACTION HELP Send Config File Sends a configuration file line by line to the terminal Blank lines are skipped Fil nam e the file to send This should refer to a pathname within the files folder Pause the number of milliseconds to wait between sending each line Use blank for no pause 4 2 18 Comment Simply allows you to place a comment in the script Action has no effect lt Script Details Action Details ACTION TYPE Comment v ACTION PARAMETERS String ACTION HELP Comment Places a comment in the script This action has no effect User Manual Get Console 4 3 Keyboard Settings There are 4 configuration items under the Keyboard Settings section of the main App Settings KEYBOARD SETTINGS Backspace Key Note that it is possible to use the Get Console app with a Bluetooth keyboard and the sett
51. rd Viewer Log files which are Get Console generated logs for each terminal session that has logging enabled RSA Keys for use in certificate based authentication in SSH These files are import ed via the Main Settings gt Private Key dialog box connection files which are saved connections visible in the Connection Manager These files are created either in the Get Console Connection Manager imported by Get Console File Manager or imported via iTunes script files which are saved scripts that can be executed on login or during a terminal session via the Script Manager These files are created either in the Get Console Script Manager imported by Get Console File Manager or imported via iTunes 5 2 User Created Text Files While there are 5 types of files the File Manager is concerned only with a the text files type User Created text based files User Manual Get Console b connection files saved connections that can be imported into Connection Manager c script files saved terminal scripts that can be imported into the Script Manager Other types of files are created viewed deleted uploaded via their respective managers as dis cussed below User Created text files are typically used in terminal sessions they could be snippets of configurati ons or other text based templates that are edited in the clipboard viewer or scratch pads before being pasted into the Terminal window To be
52. riend 4 8 1 Version Version number of the Get Console App Certain features are only available in later versions Up dates to Get Console occur automatically via the App Update process in the iTunes App Store 4 8 2 Copyright Year and holder of the copyright Get Console is a registered trademark owned by Cloudstore Limi ted 4 8 3 About Get Console About Get Console app Displays version copyright information developers LibSSH2 license and any other licenses for third party software that is incorporated into Get Console User Manual Get Console 4 8 4 Send Feedback This will automatically bring up an email addressed to support get console com with which you can provide your feedback with Your feedback is valuable to us so if you discover any issues with our product please do not hesitate in letting us know so we can fix them as quickly as possible 4 8 5 Send App Link to a Friend This will create an email with the iTunes link to the Get Console application that you can send to people who may find it useful 5 Get Console File System The File Manager can be accessed directly from the side menu 5 1 Get Console File Types Get Console stores files within a portion of the iPad iPhones file system that is dedicated to the Get Console App There are 5 types of files that are stored User created text based files that are typically used in a terminal session via cut ting pasting into the terminal window via the Clipboa
53. sers portal space on the User Manual Get Console www get console com website Get Console option or if the user has linked Get Console to their lt Script Detaits Action Details ACTION TYPE Upload Log v ACTION PARAMETERS Upload to ACTION HELP Upload Log Uploads the console log to the configured remote server Displays an error if no remote server is configured Dropbox com account then uploaded to the My Apps Get Console folder within their Dropbox 4 2 10 Run Script This action triggers another script to be launched With is also having the Return control option which determines whether or not the script control will be passed on to the next rule in the script or not lt Script Details ACTION TYPE Run Script v ACTION PARAMETERS Script Name Return Control ACTION HELP Run Script Launches another script Optionally returns execution to this script after completing Script Name The name of the script to run Return Controt On after completing the specified script contro will return to the nex rule in the script OF contro wil not return to this script after the specified script has completed 4 2 11 Branch This action can be configured to create jumps in the scripts according what string is seen first You are able to configure the string that initiates the jumps as well as the rule in the script that the jump should be made to A timeout option is also available so the next rule in
54. st be in this folder to be accessible lt Settings Documents Fes Unliak Accoumi FOLDERS WITH DFIOPEOX ICONS WEL BE SYNCED lt Settings Documents Edit Rom Ce Crea BB connections esmo The app Get Console would like to E fies Link Account connect with your Dropbox rere pa La Iior pame id E keya i i A E nt RE scripts User Manual Get Console 5 3 Log Files Get Console offers comprehensive logging of individual terminal sessions Once logging is enabled in the main settings all printable screen output is captured to a logfile One log file is created for each session Unless a script is being used to append a log file a new log file is created each time a session is stopped and restarted 5 3 1 Log File Naming For connections that are started with the Quick Connect method the log file name will be Log _YYYY MM DD_HHMMSS txt For connections that are started from a saved connection in the Connection Manager the file name will instead be appended with the connection name followed by date ie Serverl YYYY MM DD_HHMMSS txt Invoking log operations from a script can change the name of the log files See the Script Manager section above for details on log operations that are possible via scripting 5 3 2 Uploading Log Files Log files can be extracted from the iOS device via 2 possible methods Via upload to the users portal page on the get console com website Via
55. top Logging Action Item 34 4 2 9 Upload Log Action Item 34 4 2 10 Run Script 35 User Manual Get Console 4 2 11 Branch 35 4 2 12 Wait for Regex 36 4 3 Keyboard Settings 40 4 3 1 Backspace Key 40 4 3 2 Enter Key 40 4 3 3 Use Option as Ctrl 40 4 3 4 Keyboard Transparency 41 4 4 Serial Settings 41 4 4 1 Auto Connect 41 4 4 2 Bqud Rate 41 4 4 3 Stop Bits Default 1 Stop Bit 42 4 4 4 Flow Control Default None 42 4 4 5 Parity Default Off 42 4 4 6 Databits Default 8 Bit 42 4 5 Cloud Storage Settings 43 4 6 SSH Settings 45 4 6 1 Keyboard Auth SSH 45 4 6 2 SSH Agent45 4 6 3 Private Keys 45 4 7 Sharing Settings 47 4 7 1 Remote Server 47 4 7 2 Private Server 48 4 7 3 Secure Connection Default Off 48 4 7 4 Username 49 4 7 5 Password 49 4 8 About Get Console 49 4 8 1 Version 49 4 8 2 Copyright 49 4 8 3 About Get Console49 4 8 4 Send Feedback 50 4 8 5 Send App Link toa Friend 50 5 Get Console File System 50 5 1 Get Console File Types 50 5 2 User Created Text Files 50 5 2 1 Importing files from Get Console com 51 5 2 2 Importing files from Dropbox account 52 5 3 Log Files 55 5 3 1 Log FileNaming 55 5 3 2 Uploading Log Files 55 5 3 3 Auto Uploading Log files 56 5 4 Script and Connection Get Console Files 57 6 General Troubleshooting 58 6 1 Serial Connectivity Issues 58 6 1 1 C2 RJ45 Cable Pinouts 59 6 1 2 Console Cable Not Detected 59 User Manual Get Console 6 1 3 Console Cable Det
56. tring above and one leg of a script branch requires the script itself to terminate 4 2 5 Send Hex Bytes Action Item Scrpt Details Action Details ACTION TYPE Send Hex Bytes v AU TIUN PAHAME TH Hex Data ACTION HELP end Hex Bytes Send the sepecificd hes Dtos to the comecte Hex Data Dytes encoded in hex eg 0304 for Ctrl C Ct O Other common hex byte codes are o o E tt T7 U2 Je Find more hex byte codes at www asciitable com 4 2 6 Pause Script Action Item Use the Pause action to halt the script for a number of seconds this is useful when the device con nected to will not be ready to accept a Send String or Send Hex Bytes action immediately after a Wait for String has been matched The pause action is also useful to give the remote device time to process the previous Send String before sending the next one lt Script Details ACTION TYPE Pause Script v ACTION PARAMFTT L1 Timeout ACTION HELP Pase Ser il wie soripi procsasing for the apec led number of seconds Tensad The number xecorkida lo wai User Manual Get Console 4 2 7 Display Message Action Item Display Message is useful to provide feedback to the iPad iPhone user that the script has completed or is at a certain point The pop up message does not have to be acknowledged for the script to con tinue or complete Display Message v ACTION PANAMEFTFNRA String A iV Me 4l b
57. used by Get Console the files must be local to the iPad iPhone device Get Console offers 2 ways to get User Created text files into the local file system via import from the users portal on the www get console com website via import from the users My Apps Get Console folder in their Dropbox com cloud storage 5 2 1 lmporting files from Get Console com To import text files from the Get Console com portal the user must first have signed up to a free ac count at www get console com signup After sign up the user logs in via the Login panel at the top of any webpage 5 2 1 1 Creating Uploading files on Get Console Website User Login X Username simon ipguys com Password sssseeses Login New User Sign up Forgot your password Once signed in the website Login button changes to an Account button Clicking on this reveals the users portal options User Login X Account Stored Logs Cmd Scripts Connect to Live Session Logout User Created Text files including script and connection files are accessed via the Cmd Scripts button This button will be renamed User Created Files in a later release of the website User Manual Get Console tL File Manager eS g i y C t os do 4 Q wS yar W l noo o lt Pe Coury 24 kern J oo Q nx ty WADO a oot Q lt Owe NA Choose Fte CI From the CMD Scripts user portal page the user can upload edit or create
58. ver is selected for Remote Server set its hostname or IP address in this field Below is the diagram representation of the working of the Private Server For more information please view the Get Console Private Server manual available from www get console com private server Your Field Force at Chent St Your Company M 4 7 3 Secure Connection Default Off Use SSL for session sharing for more secure connection SSL option should only be selected with Pri vate Server if the Private Server has a valid and publicly trusted ie trusted natively by iPhone iPad SSL certificate for the entered hostname If secure connection is enabled and the target Private Ser User Manual Get Console ver does not have an SSL certificate properly installed then a generic Failed to Connect to Private Server error will display Enabling Secure Connection also has a small impact on the remote performance For maximum res ponsiveness when encryption is not required leave Secure Connection OFF 4 7 4 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 4 7 5 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 4 8 About Get Console Version Copyright About Get Console Send Feedback Send App Link to A F
59. xecute them When running the script will start with the first action item and progress through the action items in order Usually the script will begin by telling the terminal to wait to see something on the screen ie the Wait for String action item and then the next action item will be to do something send com mand start logging etc These type of scripts are known as Expect Scripts in that while the script is running it will Expect to see X on the screen and when it does it will respond with Y After creating the script and running it the items are usually completed sequentially from first item to last however complex scripts can manipulate the execution order via branching and jump action items The below section describes the various action item options are and their configurable parameters Note that poorly constructed scripts will possibly cause the terminal window to lock or perform un predictably A common cause for script problems not configuring a timeout for a Wait for String ac tion item if this is not configured the script will never progress to the next action item as it has not seen the string it is looking for User Manual Get Console 4 2 1 Create New Script To create a new script navigate to the Script Manager and tap the Create New Script button Give the script a name and then tap on Action 1 Cancel Script Name New Script 1 ACTIONS 1 Wait for String ET

Download Pdf Manuals

Related Search

Related Contents

  BETRIEBSANLEITUNG RESERVETEILKATALOG  Elite 5m et Elite 4m  RR4200077 MANUAL CV FAGOR BARRUKALDEA.indd    the Getting Started Guide  96C  HP VP6121 Multimedia Projector  

Copyright © All rights reserved. Failed to retrieve file