CLI Access: Difference between revisions

From Open-E Wiki
Jump to navigation Jump to search
migrate>Ad-B
Created page with "<span style="color: rgb(0, 0, 0); font-family: arial, helvetica, sans-serif; font-size: 14px;">Using this function, you can manage console tools remotely via the SSH protocol ..."
 
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<span style="color: rgb(0, 0, 0); font-family: arial, helvetica, sans-serif; font-size: 14px;">Using this function, you can manage console tools remotely via the SSH protocol (secure shell). The default user is&nbsp;</span>'''cli'''<span style="color: rgb(0, 0, 0); font-family: arial, helvetica, sans-serif; font-size: 14px;">&nbsp;and cannot be altered. The password, however, can be changed.</span>
Using this function, you can administer the system remotely with the SSH (Secure SHell) protocol.


'''Allow IP'''<br/>&nbsp;&nbsp;&nbsp;&nbsp; Here you can assign IP addresses (separated by a semicolon) which are granted remote access to the server.&nbsp; When left blank, the field indicates no restrictions.<br/>'''Set port'''<br/>The default port is 22222 for security reasons,&nbsp;because&nbsp;high-number ports are invisible to port scanners.&nbsp; You can only change the setting to a port within the 1024-65535 range.&nbsp; You cannot indicate ports already in use.<br/>'''Password'''<br/>Password length is 5 characters minimum.&nbsp; Be sure to use strong passwords.<br/>'''Confirm password'''<br/>Please retype your new password.
Default user is ''''cli'''' and cannot be changed - however, you can change the password.


Password cannot contain:
;Allow IP
<ul style="margin: 0.3em 0px 0px 1.5em; padding: 0px; color: rgb(0, 0, 0); font-family: arial, helvetica, sans-serif; font-size: 14px;">
:You can assign IP addresses (separated by a semicolon) which are granted&nbsp; access to server configuration. Empty field means no restriction.
<li>special characters such as&nbsp;' " ` ^ & $ # [ ] \/ | *</li>
;Set port
<li>spaces</li>
:Default port is 22223 for security reasons, because high ports are invisible to port scanners. You can change it to any port within the 1024-65535 range, except for the ports which are already used.
</ul>
;Password
:Minimum password length is 5 characters. Be sure to use strong passwords.
;Confirm password
:Please retype your new password.


To connect to the server from Linux/MacOSX systems use:<br/>''ssh -2 -p 22222 -l cli ip_address''
Passwords cannot contain:


<span style="color: rgb(0, 0, 0); font-family: arial, helvetica, sans-serif; font-size: 14px;">where:</span>
*special characters:&nbsp;' " ` ^ & $ # [ ] \/ | *,
<ul style="margin: 0.3em 0px 0px 1.5em; padding: 0px; color: rgb(0, 0, 0); font-family: arial, helvetica, sans-serif; font-size: 14px;">
*spaces.
<li>option: -2 indicates the SSH protocol version used for connection</li>
<li>option: -p indicates the remote access port</li>
<li>option: -l indicates the user (the user needs to be&nbsp;'''cli''')</li>
<li>option: address_ip indicates the address of the server to which you want to connect</li>
</ul>


You will be asked for the remote access password you have entered on the server.


To connect to the server from Microsoft Windows, download the free SSH client ([http://www.putty.nl/ Putty]):
Example syntax of an SSH command:<br/>'''ssh -2 -p 22223 -l cli ip_address command'''
<ul style="margin: 0.3em 0px 0px 1.5em; padding: 0px; color: rgb(0, 0, 0); font-family: arial, helvetica, sans-serif; font-size: 14px;">
 
<li>in the&nbsp;'''Host Name'''&nbsp;(or&nbsp;'''IP address''') field, enter the IP address of the server</li>
*option:&nbsp;'''-2'''&nbsp;sets the version of the ssh protocol used for the connection,
<li>in the&nbsp;'''Port'''&nbsp;field, enter the same port as in the server GUI (default 22222)</li>
*option:&nbsp;'''-p'''&nbsp;sets the connection port,
<li>in the&nbsp;'''Protocol'''&nbsp;field,&nbsp;select&nbsp;'''SSH'''</li>
*option:&nbsp;'''-l'''&nbsp;sets the user (the user must be '''cli'''),
<li>in the category:&nbsp;'''Connection'''&nbsp;->&nbsp;'''Data'''&nbsp;->&nbsp;'''Auto-login-username,'''&nbsp;enter:&nbsp;'''cli'''</li>
*option:&nbsp;'''ip_address'''&nbsp;sets the address of the server you want to connect to,
<li>in&nbsp;'''Terminal'''&nbsp;->&nbsp;'''Keyboard'''&nbsp;->&nbsp;'''The Function Keys and keypad,'''&nbsp;select&nbsp;'''VT100+'''</li>
*option:&nbsp;'''command'''; use&nbsp;'''help'''&nbsp;to display all available commands.
<li>go back to the&nbsp;'''Session'''&nbsp;category, enter the session name in the&nbsp;'''Saved Sessions'''&nbsp;field, and click the&nbsp;'''Save'''&nbsp;button</li>
 
<li>click on the newly saved session, click&nbsp;'''Open,'''&nbsp;and enter the password.&nbsp; (If you have not entered the Auto-login-username, Putty will prompt you for a username.&nbsp; At the prompt, enter&nbsp;'''cli''').</li>
 
</ul>
You will be asked for the password you entered in the CLI/API configuration menu.
<div class="locationheader" style="border-bottom-style: none; color: rgb(196, 22, 31); font-family: arial, helvetica, sans-serif; font-size: 14px;"></div>
 
It is also possible to authenticate without a password by using the key generated after clicking&nbsp;'''generate and download''', or downloading a previously generated key by clicking&nbsp;'''download'''.On GNU/Linux systems make sure that the key file has read only rights for the owner (400).
 
Example syntax of an SSH command using a key:<br/>'''ssh -i path_to_the_downloaded_key -2 -p 22223 -l cli ip_address command'''
 
*option:&nbsp;'''-i'''&nbsp;sets the path to the downloaded key file,
*option:&nbsp;'''-2'''&nbsp;sets the version of the SSH protocol used for the connection,
*option:&nbsp;'''-p'''&nbsp;sets the connection port (default: 22223),
*option:&nbsp;'''-l'''&nbsp;sets the user (the user must be '''cli'''),
*option:&nbsp;'''ip_address'''&nbsp;sets the IP address of the storage server you want to connect to,
*option:&nbsp;'''command'''; use 'help' to show all available commands.
 
 
'''Note'''
Every time the&nbsp;'''generate and download'''&nbsp;button is pressed, it generates a new key and the old key expires.
[[Category:Help topics]]

Latest revision as of 14:28, 15 March 2019

Using this function, you can administer the system remotely with the SSH (Secure SHell) protocol.

Default user is 'cli' and cannot be changed - however, you can change the password.

Allow IP
You can assign IP addresses (separated by a semicolon) which are granted  access to server configuration. Empty field means no restriction.
Set port
Default port is 22223 for security reasons, because high ports are invisible to port scanners. You can change it to any port within the 1024-65535 range, except for the ports which are already used.
Password
Minimum password length is 5 characters. Be sure to use strong passwords.
Confirm password
Please retype your new password.

Passwords cannot contain:

  • special characters: ' " ` ^ & $ # [ ] \/ | *,
  • spaces.


Example syntax of an SSH command:
ssh -2 -p 22223 -l cli ip_address command

  • option: -2 sets the version of the ssh protocol used for the connection,
  • option: -p sets the connection port,
  • option: -l sets the user (the user must be cli),
  • option: ip_address sets the address of the server you want to connect to,
  • option: command; use help to display all available commands.


You will be asked for the password you entered in the CLI/API configuration menu.

It is also possible to authenticate without a password by using the key generated after clicking generate and download, or downloading a previously generated key by clicking download.On GNU/Linux systems make sure that the key file has read only rights for the owner (400).

Example syntax of an SSH command using a key:
ssh -i path_to_the_downloaded_key -2 -p 22223 -l cli ip_address command

  • option: -i sets the path to the downloaded key file,
  • option: -2 sets the version of the SSH protocol used for the connection,
  • option: -p sets the connection port (default: 22223),
  • option: -l sets the user (the user must be cli),
  • option: ip_address sets the IP address of the storage server you want to connect to,
  • option: command; use 'help' to show all available commands.


Note

Every time the generate and download button is pressed, it generates a new key and the old key expires.