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


Go to the GUI -> System Settings -> CLI access


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.

The CLI options are:

Available commands:

        attach_volume_to_iscsi_target

        check_mk_agent

        create_clone_for_given_snapshot

        create_iscsi_target

        create_pool

        create_snapshot

        create_volume

        delete_clone

        delete_iscsi_target

        delete_pool

        delete_snapshot

        delete_volume

        detach_volume_from_iscsi_target

        get_clones_for_given_snapshot

        get_iscsi_targets_for_given_pool

        get_pools

        get_snapshots_for_given_volume

        get_volumes_assigned_to_iscsi_target

        get_volumes_for_given_pool

        help

        node_bind

        node_unbind

        odps

        reboot

        rollback_snapshot

        shutdown


Note

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