Skip to main content

Manage resources in the vmpooler service from the command-line.

Project description

The “” script provides the ability to manage vmpooler
resources in the vcloud. Currently the script supports grabbing
a new VM for testing and handing a VM back to the pooler to be

To get help on the command-line for the script use the command: -h


# Create a token (only on first run)
$ ./ token create
Please provide LDAP credentials for the VM pooler

Username: bob.smith

Token: <token>

# List available templates
$ ./ vm list redhat

# Grab a VM
$ ./ vm get redhat-6-x86_64
Hostname: h2qbe7c29ix2w1r

# Login and do work
$ ssh root@h2qbe7c29ix2w1r

# Logout

# Give vm back to the pool
$ ./ vm destroy h2qbe7c29ix2w1r

Examples is separated into a few subcommands:
    * vm
        * list
        * get
        * destroy
        * destroy_all
        * info
        * running
    * lifetime
        * get
        * extend
        * set
    * token
        * create
        * validate
        * revoke
    * config
        * get
        * set
        * list
        * unset

Help is available for each subcommand by appending -h to the command: lifetime set -h

List vmpooler templates

This will list all the available templates.

Usage vm list

Filter the list vmpooler templates

Filter available templates via a fuzzy matching pattern.

Usage vm list PATTERN

Example vm list win

Get a VM from the vmpooler

It is required that you know what the template names are for the

Usage vm get TEMPLATE_NAME

Example vm get ubuntu-1404-x86_64

List all of your running VMs

This gives you a concise list of what VMs you have running

Usage vm running

Example Output

l2l7jdlpt6xlptq | Running: 4.27 hours | centos-6-i386
etcgjzxks2vtw9t | Running: 0.15 hours | centos-5-i386

Hand a VM back to the vmpooler for destruction

It is required that you know what the hostname is for the VM you want to

Usage vm destroy VM_NAME

Example vm destroy skj3k4hahdk

Hand all active VMs back to the vmpooler for destruction

Be careful, this will destroy every active VM associate with your token

Usage vm destroy_all

Example Output

Destroying etcgjzxks2vtw9t
Destroying l2l7jdlpt6xlptq

Get the time to live for a VM in the vmpooler

Usage lifetime get VM_NAME

Example lifetime get skj3k4hahdk

Extend the time to live for a VM in the vmpooler

This command will add a certain number of hours to the lifetime of a VM Usage lifetime extend VM_NAME LIFETIME

Example lifetime extend skj3k4hahdk 2
> Lifetime extended to 10 hours

Set the total time to live for a VM in the vmpooler to a certain number of hours

This command will overwrite the time to live for a VM

Usage lifetime set VM_NAME LIFETIME

Example lifetime set skj3k4hahdk 24

Get information on a VM in the vmpooler

This will work on running and destroyed VMs in the vmpooler.

Usage vm info VM_NAME

Example vm info skj3k4hahdk

Create an authorization token for use with the vmpooler

WARNING! Know what you’re doing before using this function!

Usage token create

Revoke an authorization token

WARNING! Know what you’re doing before using this function!

Usage token revoke TOKEN

Example token revoke sfn3h65earxah6ar9aal3oac2pfx9817

Verify that an authorization token is valid

WARNING! Know what you’re doing before using this function!

Usage token validate TOKEN

Example token validate sfn3h65earxah6ar9aal3oac2pfx9817

Read a config setting

Usage config get SETTING_NAME

Example config get username

Modify/create a config setting

Modify an existing setting or create add a new setting if it doesn’t exist yet.

Usage config set SETTING_NAME VALUE

Examples config set username bob.smith config set a_new_setting some_value

Remove a config setting

Usage config unset SETTING_NAME

Example config unset auth_token

List all config settings

Print all the settings in the config file
Usage config list

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

vmpooler_client-3.1.0-py2-none-any.whl (21.2 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page