Access CMShell with an SSH client

CMShell requires a client that supports SSH protocol 2 (DSA/RSA).

Use any client that provides secure, persistent sessions to securely connect to a storage group. CMShell supports both interactive login and single command execution. This includes applications such as “PuTTY” and “WinSCP.”

CMShell configuration requirements

To configure an SSH client, you will need various items and information:

  • The “Private” Instance of the Applicable SSH key: To resolve with the “public” instance that you have applied to the upload account that has access to the target storage group. This file must be locally accessible.
  • The Storage Group “Name”: This is the storage group you will be accessing. If necessary, this can be gathered via the NetStorage Groups tool in Control Center. See the Storage Groups entity that is revealed when you initially access this tool.
  • The Secure Login Username: This is always “sshacs” for secure NetStorage access.
  • The Client Must Support the Use of “Remote Commands”: It must offer a way to configure an additional remote command—cms—that will be appended to the connection call.
  • The “Key Passphrase” Assigned to the SSH key: If, during generation of the applicable SSH key, you assigned a key passphrase, you will need to know it.

Here is an example SSH session using “PuTTY”

Since it meets all of the CMShell configuration requirements, and is easily accessible, “PuTTY” is used as the SSH client for this example. All PuTTY components can be found on the PuTTY website.

How to

  1. Launch PuTTY
  2. Ensure the Category is set to Session, and input the following in the Host Name (or IP address) field: <Domain Name Prefix>.ssh.upload.akamai.com
  3. Set the Connection Type to SSH.
  4. Select the Connection > Data sub-category, and set the Auto-login username to “sshacs” (minus the quotes). This value must be used.
  5. Select the Connection > SSH sub-category and set the following:
    1. Remote command - Input “cms” (minus the quotes).
    2. Preferred SSH protocol version - Ensure that “2” is selected.
  6. Open the Connection > SSH sub-category and select its Auth sub-category to set following:
    1. Private key file for authentication - Click the Browse button to navigate to the associated Private key.
  7. Recommended: Return to the Session category, input a desired name in Saved Sessions (“CMShell Access,” for example) and click the Save button. This allows you to quickly load the session for connection in the future.
  8. Click Open to launch the session in a separate session window.
  9. If you have established a Key Passphrase for the SSH Key pair, input it in the session window.

With the connection open and resolved, you can now issue CMShell commands.

Here is an example of an interactive login

In this example, we show you how to access the CMShell by including specific login information. After the login is resolved, you will be able to issue multiple commands.

ssh -t <Username>@<Domain Name Prefix>.ssh.upload.akamai.com cms

The following variable values apply:

  • <Username>: When providing the username, the value sshacs must be used. (This is the case for all secure access methods in NetStorage.)
  • <Domain Name>: This value followed by .ssh.upload.akamai.com represents your full Upload Domain Name. You set up your domain name during creation of the target storage group.

    Once this login is accepted, you will be free to launch multiple CMShell commands, as desired.

Here is an example of single command execution

In this example, we show you how to access the CMShell by including specific login information within an individual command. (This allows you to login and issue a single command.)

ssh <Username>@<Domain Name Prefix>.ssh.upload.akamai.com <command line>

The following variable values apply:

  • <Username>: When providing the Username, the value sshacs must be used. (This is the case for all Secure Access Methods in NetStorage.)
  • <Domain Name Prefix>: This value followed by .ssh.upload.akamai.com represents your full Upload Domain Name. You set up your Domain Name during creation of the target storage group.
  • <command line>: The single command you wish to execute.