RightScale API 1.0 Examples

1. Overview
2. Using rs_api_examples
1. 2.1. Installation
  1. 2.1.1. RightScript install
  2. 2.1.2. RightScale/EC2 API Toolbox
  3. 2.1.3. Manual install
2. 2.2. Configuration
  1. 2.2.1. Add rs_api_examples to search path
  2. 2.2.2. Configure credentials and API version
    1. 2.2.2.1. Interactive setup
    2. 2.2.2.2. Non-interactive
  3. 2.2.3. Test Authentication
  4. 2.2.4. Switching Accounts
3. List of Examples
4. See also

1. Overview
2. Using rs_api_examples
1. 2.1. Installation
  1. 2.1.1. RightScript install
  2. 2.1.2. RightScale/EC2 API Toolbox
  3. 2.1.3. Manual install
2. 2.2. Configuration
  1. 2.2.1. Add rs_api_examples to search path
  2. 2.2.2. Configure credentials and API version
    1. 2.2.2.1. Interactive setup
    2. 2.2.2.2. Non-interactive
  3. 2.2.3. Test Authentication
  4. 2.2.4. Switching Accounts
3. List of Examples
4. See also

Overview

Sometimes the best way to learn is by studying some real world examples to see how things work and hopefully understand how you can apply it for your own purposes. The examples below cover some common use cases of the RightScale API and if you're savvy, you'll also be able to deconstruct them to extract specific code snippets for accomplishing more specific tasks.

The examples are written in Bourne shell or Bash. RestConnection examples are also available.

Using rs_api_examples

All the Bash/cURL examples in this section resided in rs_api_examples. Each example sources configuration from ~/.rightscale, logs into the API then performs the required API calls.

Installation

RightScript install

For RightScale Servers and Server Array instances, import the Install & configure rs_api_examples RightScript from the MultiCloud Marketplace.
Add this to your ServerTemplates or use as an Any Script. Inputs are provided for your RightScale credentials (skip the configuration section below).

RightScale/EC2 API Toolbox

You can get started within minutes by importing the RightScale/EC2 API Toolbox from the MultiCloud Marketplace, adding it to a deployment, filling in the missing inputs for your credentials, then launching the server. Once operational, you'll find that each command in the package, e.g. rs-login.sh is available in the shell's path.

Manual install

This is ideal for any unix-like desktop or virtual machine that is not attached to RightScale.

#!/bin/sh -e

install_dir="$HOME/bin"     # non-root
#install_dir=/usr/bin       # root

mkdir -p "$install_dir"
cd /tmp
git clone git://github.com/flaccid/rs_api_examples.git
cp -vR /tmp/rs_api_examples/bin/* "$install_dir"/
chmod +x "$install_dir"/rs-*.sh
rm -Rf /tmp/rs_api_examples

Configuration

Add rs_api_examples to search path

Add to user's shell profile

for f in "$HOME"/{.bash_profile,.bash_login,.profile}; do
    if [[ -f $f ]]; then
        echo "PATH+=':$install_dir'" >> "$f"; break;
    fi
done

Or, add to current shell path

PATH+=":$install_dir"

Configure credentials and API version

Interactive setup

rs-config-api.sh
# <follow the prompts>

Note, your RightScale account ID can be found after 'acct/' in URLs when browsing my.rightscale.com, e.g. https://my.rightscale.com/acct/1234/dashboard;overview.

Non-interactive

#!/bin/sh -e

rs_api_version=1.0
rs_api_account_id=1234
rs_api_user=john@smith.com
rs_api_password=foobar

mkdir -p "$HOME/.rightscale"

cat <<EOF> "$HOME/.rightscale/rs_api_config.sh"
rs_api_version=$rs_api_version
rs_api_cookie="$HOME/.rightscale/rs_api_cookie.txt"
EOF
cat <<EOF> "$HOME/.rightscale/rs_api_creds.sh"
rs_api_account_id=$rs_api_account_id
rs_api_user="$rs_api_user"
rs_api_password="$rs_api_password"
EOF

Test Authentication

rs-login.sh

Switching Accounts

rs-switch-accounts.sh 1234    # where 1234 is the account ID

Support