CLI Access: Difference between revisions

From Open-E Wiki
Jump to navigation Jump to search
← Older edit
VisualWikitext
migrate>Ad-B
No edit summary
No edit summary
 
(4 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 administer the system remotely with the SSH (Secure SHell) protocol. Default user is 'api' and cannot be changed - however, you can change the password.</span><br/><br/>
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
;Allow IP
Line 11: Line 13:


Passwords cannot contain:
Passwords cannot contain:
<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>special characters:&nbsp;' " ` ^ & $ # [ ] \/ | *,</li>
<li>spaces.</li>
</ul>


Example syntax of an SSH command:<br/>'''ssh -2 -p 22223 -l api ip_address command'''
*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:&nbsp;'''-2'''&nbsp;sets the version of the ssh protocol used for the connection,</li>
 
<li>option:&nbsp;'''-p'''&nbsp;sets the connection port,</li>
 
<li>option:&nbsp;'''-l'''&nbsp;sets the user (the user must be&nbsp;'''api'''),</li>
Example syntax of an SSH command:<br/>'''ssh -2 -p 22223 -l cli ip_address command'''
<li>option:&nbsp;'''ip_address'''&nbsp;sets the address of the server you want to connect to,</li>
 
<li>option:&nbsp;'''command'''; use&nbsp;'''help'''&nbsp;to display all available commands.</li>
*option:&nbsp;'''-2'''&nbsp;sets the version of the ssh protocol used for the connection,
</ul>
*option:&nbsp;'''-p'''&nbsp;sets the connection port,
*option:&nbsp;'''-l'''&nbsp;sets the user (the user must be '''cli'''),
*option:&nbsp;'''ip_address'''&nbsp;sets the address of the server you want to connect to,
*option:&nbsp;'''command'''; use&nbsp;'''help'''&nbsp;to display all available commands.
 


You will be asked for the password you entered in the CLI/API configuration menu.
You will be asked for the password you entered in the CLI/API configuration menu.
Line 29: Line 31:
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).
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 api ip_address command'''
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'''
<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>option:&nbsp;'''-i'''&nbsp;sets the path to the downloaded key file,</li>
*option:&nbsp;'''-i'''&nbsp;sets the path to the downloaded key file,
<li>option:&nbsp;'''-2'''&nbsp;sets the version of the SSH protocol used for the connection,</li>
*option:&nbsp;'''-2'''&nbsp;sets the version of the SSH protocol used for the connection,
<li>option:&nbsp;'''-p'''&nbsp;sets the connection port (default: 22223),</li>
*option:&nbsp;'''-p'''&nbsp;sets the connection port (default: 22223),
<li>option:&nbsp;'''-l'''&nbsp;sets the user (the user must be&nbsp;'''api'''),</li>
*option:&nbsp;'''-l'''&nbsp;sets the user (the user must be '''cli'''),
<li>option:&nbsp;'''ip_address'''&nbsp;sets the IP address of the storage server you want to connect to,</li>
*option:&nbsp;'''ip_address'''&nbsp;sets the IP address of the storage server you want to connect to,
<li>option:&nbsp;'''command'''; use 'help' to show all available commands.</li>
*option:&nbsp;'''command'''; use 'help' to show all available commands.
</ul>
 


<br/>
'''Note'''
<div class="noteheader" style="border-bottom-style: none; font-weight: bold; font-style: italic; color: rgb(0, 0, 0); font-family: arial, helvetica, sans-serif; font-size: 14px;">Note</div><div class="note" style="margin-left: 20px; color: rgb(0, 0, 0); font-family: arial, helvetica, sans-serif; font-size: 14px;">Every time the&nbsp;'''generate and download'''&nbsp;button is pressed, it generates a new key and the old key expires.</div><div class="locationheader" style="border-bottom-style: none; color: rgb(196, 22, 31); font-family: arial, helvetica, sans-serif; font-size: 14px;"></div>
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.
Retrieved from "https://wiki.open-e.com/default/wiki/index.php?title=CLI_Access&oldid=11678"