CSS Corp Open Source Services

[Eucalyptus Beginner’s Guide – UEC edition] Chapter 10 – Euca Commands

leave a comment »

Chapter 9  Troubleshooting Chapter 11 Hacks

Commands from euca2ools

Image Management

euca-bundle-image

Bundles an image for use with Eucalyptus or Amazon EC2.

 euca-bundle-image -i, --image image_path -u, --user user [-c, --cert cert_path]
[-k, --privatekey private_key_path] [-p, --prefix prefix] [--kernel kernel_id]
[--ramdisk ramdisk_id] [-B, --block-device-mapping mapping]
[-d, --destination destination_path] [--ec2cert ec2cert_path]
[-r, --arch target_architecture] [--batch] [-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

-i, --image Path to the image file to bundle.

-u, --user User ID (12-digit) of the user who is bundling the image.

OPTIONAL PARAMETERS

-c, --cert Path to the user's PEM encoded certificate.

-k, --privatekey Path to the user's PEM encoded private key.

-p, --prefix The prefix for the bundle image files. (default: image name).

--kernel The kernel to be associated with the bundled image.

--ramdisk The ramdisk to be associated with the bundled image.

-B, --block-device-mapping Default block device mapping for the image (comma-separated list of key=value pairs).

-d, --destination Directory to store the bundled image in (default: "/tmp"). Recommended.

--ec2cert The path to the Cloud's X509 public key certificate.

-r, --arch Target architecture for the image ('x86_64' or 'i386' default: 'x86_64').

--batch Run in batch mode (compatibility only. has no effect).

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging. 

euca-bundle-vol

Bundle the local filesystem of a running instance as a bundled image.

euca-bundle-vol -u, --user user -s, --size size_in_MB

[-c, --cert cert_path] [-k, --privatekey private_key_path]

[-a, --all] [-e, --exclude dir1, dir2,...dirN] [-p, --prefix prefix] [--[no-]inherit] [-v, --volume volume_path] [--fstab fstab_path] [--generate-fstab] [--kernel kernel_id] [--ramdisk ramdisk_id] [-B, --block-device-mapping mapping]

[-d, --destination destination_path] [--ec2cert ec2cert_path] [-r, --arch target_architecture] [--batch] [--version]

REQUIRED PARAMETERS

-u, --user User ID (12-digit) of the user who is bundling the image.

-s, --size Size for the image in MB (default: 10GB or 10240MB).

OPTIONAL PARAMETERS

-c, --cert Path to the user's PEM encoded certificate.

-k, --privatekey Path to the user's PEM encoded private key.

-a, --all Bundle all directories (including mounted filesystems).

-p, --prefix The prefix for the bundle image files. (default: image name).

--[no-]inherit Add (or do not add) instance metadata to the bundled image. Inherit is set by default.

-e, --exclude comma-separated list of directories to exclude.

--kernel The kernel to be associated with the bundled image.

--ramdisk The ramdisk to be associated with the bundled image.

-B, --block-device-mapping Default block device mapping for the image (comma-separated list of key=value pairs).

-d, --destination Directory to store the bundled image in (default: "/tmp"). Recommended.

--ec2cert The path to the Cloud's X509 public key certificate.

-r, --arch Target architecture for the image ('x86_64' or 'i386' default: 'x86_64').

-v, --volume Path to mounted volume to create the bundle from (default: "/").

--fstab Path to the fstab to be bundled into the image.

--generate-fstab Generate fstab to bundle into the image.

--batch Run in batch mode (compatibility only. has no effect). 

euca-delete-bundle

Delete a previously uploaded bundle.

 euca-delete-bundle -b, --bucket bucket [-m, --manifest manifest_path]
[-p, --prefix prefix] [--clear] [-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

bucket The name of the bucket to delete from.

OPTIONAL PARAMETERS

-m, --manifest The path to the manifest file.

-b, --bucket The bucket to delete the bundle from (if no
manifest is specified, all images from this
bucket will be deleted).

-p, --prefix The filename prefix for bundled files. Defaults
to image name.

--clear Delete the bucket containing the image.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging. 

euca-download-bundle

Downloads a bundled image from a bucket.

 euca-download-bundle -b, --bucket bucket [-m, --manifest manifest_path] [-d, --directory directory]
[-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

-b, --bucket The name of the bucket to download from.

OPTIONAL PARAMETERS

-m, --manifest The path to the manifest file.

-d, --directory The name of the directory to download the bundled parts to.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-unbundle

Unbundles a previously bundled image.

 euca-unbundle-image -m, --manifest manifest_path [-k, --privatekey private_key_path]
[-s, --source source_directory] [-d, --destination destination_directory]
[-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

-m, --manifest Path to the manifest file for the bundled image.

OPTIONAL PARAMETERS

-d, --destination Directory to store the image to (defaults to the current directory).

-s, --source Source directory for the bundled image parts (defaults to manifest directory).

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging. 

euca-upload-bundle

Upload a previously bundled image to the cloud.

 euca-upload-bundle -b, --bucket bucket -m, --manifest manifest_path [-a, --access-key access_key_id]
[-s, --secret-key secret_key] [--acl canned_acl] [--ec2cert ec2cert_path] [-d, --directory bundle_path]
[--part part] [--url url] [--skipmanifest] [--debug] [-h, --help] [--version]

REQUIRED PARAMETERS

-b, --bucket The name of the bucket to upload to. Bucket will be created if it does not exist.

-m, --manifest The path to the manifest file for the bundled image.

OPTIONAL PARAMETERS

--acl Canned access control policy (defaults to "aws-exec-read").

--ec2cert The path to the Cloud's X509 public key certificate.

-d, --directory The directory containing the bundled image to upload (defaults to the manifest directory).

--part Uploads specified part and all subsequent parts.

--skipmanifest Do not upload the manifest file.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-images

Shows information about machine images.

euca-describe-images [-a] [-o owner] [-x user] [-h, --help] [--version] [--debug] [image1 image2 ... imageN]

OPTIONAL PARAMETERS

image1 image2 ... imageN Images to describe.

-a Show all images that the user has access to.

-o Show only images owned by the owner specified are displayed.

-x Show only images that the specified user is permitted to launch.

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-image-attribute

Show image attributes.

euca-describe-image-attribute [-l, --launch-permission] [-p, --product-code]
[-B, --block-device-mapping] [--kernel] [--ramdisk]
[-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETERS

image_id unique identifier for the image that you want to retrieve the attributes for.

OPTIONAL PARAMETERS

-B, --block-device-mapping show block device mapping.
-l, --launch-permission show launch permissions.
-p, --product-code show the product codes associated with the image
--kernel show the kernel id associated with the image.
--ramdisk show the ramdisk id associated with the image.

-a, --access-key user's Access Key ID.

-s, --secret-key user's Secret Key.

-U, --url URL of the Cloud to connect to.

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-register

Registers a manifest for use with the cloud.

euca-register [-h, --help] [--version] [--debug] image_location

REQUIRED PARAMETERS

image_location - path to the uploaded image (bucket/manifest).

OPTIONAL PARAMETERS

-a, --access-key user's Access Key ID.

-s, --secret-key user's Secret Key.

-U, --url URL of the Cloud to connect to.

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-deregister

Deregisters an image from the cloud.

euca-deregister [-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETER

image_id unique identifier for the image to be deregistered.

OPTIONAL PARAMETER

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Instance Management

euca-describe-instances

Shows information about instances.

euca-describe-instances [-h, --help] [--version] [--debug]
[instance1... instanceN]

OPTIONAL PARAMETERS

instance1... instanceN instances to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-reboot-instances

Reboots specified instances.

euca-reboot-instances [-h, --help] [--version] [--debug]
[instance1... instanceN]

OPTIONAL PARAMETERS

instance1... instanceN instances to reboot.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-run-instances

Starts instances.

euca-run-instances [-n, --instance-count count] [-g, --group group_name] [-k, --key keyname]
[--addressing addressing] [-t, --instance-type instance_type] [-z, --availability-zone zone]
[--kernel kernel_id] [--ramdisk ramdisk_id] [-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETERS

image_id identifier for the image to run.

OPTIONAL PARAMETERS

-n, --instance-count Number of instances to run.

-g, --group Security group to run the instance under.

-k, --key Name of a (previously created) keypair to associate with this reservation.

-d, --user-data User data for instances read from the command line.

-f, --user-data-file User data for instances as a filename.

--addressing Addressing mode (e.g., private).

-t, --instance-type VM Image type to run the instance(s) as (default: m1.small).

-z, --availability-zone Availability zone to run the instance(s) in.

--kernel Id of the kernel to be used to launch instance(s).

--ramdisk Id of the ramdisk to be used to launch instance(s).

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-terminate-instances

Stops specified instances.

euca-terminate-instances [-h, --help] [--version] [--debug]
[instance1... instanceN]

REQUIRED PARAMETERS

instance1... instanceN instances to terminate.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-confirm-product-instance

Confirm if instance is running with product code attached.

euca-confirm-product-instance i, --instance instance_id [-h, --help] [-version] [--debug] product_code

REQUIRED PARAMETERS

-i, --instance Unique identifier for a running instance.

product_code The product code to verify.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Storage Management

euca-attach-volume

Attaches a volume to an instance.

euca-attach-volume -i, --instance instance_id -d, --device device
[-h, --help] [--version] [--debug] volume_id

REQUIRED PARAMETERS

-i, --instance unique id of a running instance to attach the volume to.

-d, --device local device name (inside the guest VM) to use.

volume_id unique id for a volume to attach.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-create-volume

Creates a volume in a specified availability zone.

euca-create-volume -S, --size size | --snapshot snapshot_id -z zone
[-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

-s, --size size of the volume (in GiB).

--snapshot snapshot id to create the volume from. Either size or snapshot can be specified (not both).

-z, --zone availability zone to create the volume in

OPTIONAL PARAMETERS

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-delete-volume

Deletes a volume.

euca-delete-volume [-h, --help] [--version] [--debug] volume_id

REQUIRED PARAMETERS

volume_id unique identifier for the volume to be deleted.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-volumes

Shows information about volumes.

euca-describe-volumes [-h, --help] [--version] [--debug]
[volume1 volume2...volumeN]

OPTIONAL PARAMETERS

volume1 volume2...volumeN volumes to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-detach-volume

Detaches a volume from an instance.

euca-detach-volume [-h, --help] [--version] [--debug] volume_id

REQUIRED PARAMETERS

volume_id unique id for a volume to detach.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-create-snapshot

Creates a snapshot from an existing volume.

euca-create-snapshot [-h, --help] [--version] [--debug] volume_id

REQUIRED PARAMETERS

volume_id unique id for a volume to snapshot.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-delete-snapshot

Deletes a snapshot.

euca-delete-snapshot [-h, --help] [--version] [--debug] snapshot_id

REQUIRED PARAMETERS

snapshot_id unique identifier for the snapshot to be deleted.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-snapshots

Shows information about snapshots.

euca-describe-snapshots [-h, --help] [--version] [--debug]
[snapshot1 snapshot2...snapshotN]

OPTIONAL PARAMETERS

snapshot1 snapshot2...snapshotN - snapshots to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Network Management

euca-allocate-address

Allocate a public IP address.

euca-allocate-address [-h, --help] [--version] [--debug]

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-associate-address

Associate an instance with a public IP address.

euca-associate-address -i, --instance instance_id
[-h, --help] [--version] [--debug] ip

REQUIRED PARAMETERS

-i, --instance unique identifier for a running instance to associate the address with.

ip IP address to associate.

OPTIONAL PARAMETERS

-a, --access-key user's Access Key ID.

-s, --secret-key user's Secret Key.

-U, --url URL of the Cloud to connect to.

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-addresses

Shows information about addresses.

euca-describe-addresses [-h, --help] [--version] [--debug] [ip1 ip2...ipN]

OPTIONAL PARAMETERS

ip1 ip2...ipN IP addresses to display information about.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-disassociate-address

Disassociate a public IP address from an instance.

euca-disassociate-address [-h, --help] [--version] [--debug] ip

REQUIRED PARAMETERS

ip IP address to disassociate.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-release-address

Releases a public IP address.

euca-release-address [-h, --help] [--version] [--debug] ip

REQUIRED PARAMETERS

ip The public IP address to release.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Security

euca-add-group

Creates a new security group.

euca-add-group -d, --description group_description
[-h, --help] [--version] [--debug] group_name

REQUIRED PARAMETERS

-d, --description Description for the group to be created.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-delete-group

Deletes a security group.

euca-delete-group [-h, --help] [--version] [--debug] group_name

REQUIRED PARAMETER

group_name unique name for a group to delete.

OPTIONAL PARAMETER

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-groups

Shows information about groups.

euca-describe-groups [-h, --help] [--version] [--debug] [group1 group2...groupN]

OPTIONAL PARAMETERS

group1 group2...groupN groups to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-add-keypair

Creates a new key pair for use with instances.

euca-add-keypair [-h, --help] [--version] [--debug] keypair_name

REQUIRED PARAMETERS

keypair_name - unique name for a keypair to create.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-delete-keypair

Delete a key pair.

euca-delete-keypair [-h, --help] [--version] [--debug] keypair_name

REQUIRED PARAMETERS

keypair_name unique name for the keypair to delete.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-keypairs

Shows information about keypairs.

euca-describe-keypairs [-h, --help] [--version] [--debug]
[keypair1 keypair2...keypairN]

OPTIONAL PARAMETERS

keypair1 keypair2...keypairN keypairs to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-availability-zones

Shows information about availability zones.

euca-describe-availability-zones [--region region] [-h, --help] [--version] [--debug] [zone1 zone2...zoneN] [verbose]

OPTIONAL PARAMETERS

--region region to describe availability zones for

zone1 zone2...zoneN zones to describe.

verbose show verbose resource information (Eucalyptus administrator-only functionality).

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-regions

Shows information about regions.

euca-describe-regions [-h, --help] [--version] [--debug]
[region1 region2...regionN]

OPTIONAL PARAMETERS

region1 region2...regionN regions to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-get-console-output

Prints console output from a running instance.

euca-get-console-output [-h, --help] [--version] [--debug] instance_id

REQUIRED PARAMETERS

instance_id unique identifier for the instance show the console output for.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-modify-image-attribute

Modify attributes for an image.

euca-modify-image-attribute [-l, --launch-permission] [-p, --product-code]
[-a, --add entity ] [-r, --remove entity]
[-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETERS

image_id Unique identifier for the image that you want to modify the attributes for.

OPTIONAL PARAMETERS

-l, --launch-permission Show launch permissions.

-p, --product-code Show the product codes associated with the image

-a, -add Entity (typically, user id) to add.

-r, --remove Entity (typically, user id) to remove.

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-reset-image-attribute

Reset attributes for an image.

euca-reset-image-attribute -l, --launch-permission
[-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETERS

-l, --launch-permission show launch permissions.

image_id - unique identifier for the image that you want to reset the attributes for.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-revoke

Revoke a rule for a security group.

euca-revoke [-P | --protocol protocol] [-p | --port-range port_range]
[-t | --icmp-type-code type:code] [-o | --source-group source_group]
[-u | --source-group-user source_group_user] [-s | --source-subnet source_subnet]
[-h, --help] [--version] [--debug] group_name

REQUIRED PARAMETERS

group_name Name of the group to add the rule to.

OPTIONAL PARAMETERS

-P, --protocol Protocol ("tcp" "udp" or "icmp").

-p, --port-range Range of ports for the rule (specified as "from-to").

-t, --icmp-type-code ICMP type and code specified as "type:code"

-o, --source-group Group from which traffic is authorized by the rule.

-u, --source-group-user User ID for the source group.

-s, --source-subnet The source subnet for the rule.

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-version

Shows the Euca2ools version

euca-version [-h, --help] [--debug]

euca-authorize

Add a new rule to a security group.

euca-authorize [-P, --protocol protocol] [-p, --port-range port_range]
[-t, --icmp-type-code type:code] [-o, --source-group source_group]
[-u, --source-group-user source_group_user] [-s, --source-subnet source_subnet]
[-h, --help] [--version] [--debug] group_name

REQUIRED PARAMETERS

group_name Name of the group to add the rule to.

OPTIONAL PARAMETERS

-P, --protocol Protocol ("tcp" "udp" or "icmp").

-p, --port-range Range of ports for the rule (specified as "from-to").

-t, --icmp-type-code ICMP type and code specified as "type:code"

-o, --source-group Group from which traffic is authorized by the rule.

-u, --source-group-user User ID for the source group.

-s, --source-subnet The source subnet for the rule.

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Commands Available in UEC and not available in Eucalyptus installations

Uec-publish-tarball

Usage: uec-publish-tarball [ options ] tarfile bucket [arch]

register a UEC tarball (ie, per http://uec-images.ubuntu.com)

if arch is not provided, a name-based attempt is made to guess
options:

 -k | --kernel  k        use previously registered kernel with id 'k'

 specify 'none' for no kernel

 -K | --kernel-file f    bundle, upload, use file 'f' as kernel

 -r | --ramdisk r        use previously registered ramdisk with id 'r'

 specify 'none' for no ramdisk

 -R | --ramdisk-file f   bundle, upload, use file 'f' as ramdisk
--resize  s        resize the image to 's' bundling uploading

 's' must be valid input to uec-resize-image

 -q | --quiet            be quiet, only output published ids
Example: uec-publish-tarball lucid-uec-i386.tar.gz my-lucid-bucket i386

uec-registration

uec-registration [--manual|--auto|--help]

Options:

 --manual      Disable automatic component registration

 --auto        Enable automatic component registration

 -h, --help    This message

uec-run-instances

Same as euca-run-instances

uec-publish-image

Usage: uec-publish-image [ options ] arch image bucket

arch           : one of i386 or x86_64

image          : the image to upload and register

bucket         : bucket to publish image to
options:

 l|-add-launch <user_id>   : user_id can be "all", or "none"

 --dry-run                : only report what would be done

 --allow-existing         : if a image is already registered

 simply report as if work was done

 o|-output <file>          : write registered id and manifest to file
 |--rename <publish_path>  : publish to bucket/<publish_path>

 default: bucket/<basename(image)>

 t|-type   <type>          : type is one of kernel/ramdisk/image

 v|-verbose                : increase verbosity
if type is 'image', then:

 -k | --kernel  k        : use previously registered kernel with id 'k'

 specify 'none' for no kernel

 -K | --kernel-file f    : bundle, upload, use file 'f' as kernel

 -r | --ramdisk r        : use previously registered ramdisk with id 'r'

 specify 'none' for no ramdisk

 -R | --ramdisk-file f   : bundle, upload, use file 'f' as ramdisk

 -B | --block-device-mapping m : specify block device mapping in bundle

uec-query-builds

Usage: uec-query-builds [options]

Options:
-h, --help show this help message and exit
--suite=SUITE suite to query ('hardy', 'karmic', 'lucid')
--build-name=BUILD_NAME
build name ('server', 'desktop' ..)
--stream=STREAM stream query ('released', 'daily')
--base-url=BASE_URL the base url to query
--output=FILE write output to file, default is stdout
--serial=SERIAL build serial serial to use (YYYYMMDD)
--system-suite use output of 'lsb_release --codename --short' for
suite
--config=CONFIG yaml config file to read
--region=REGION the ec2 region to query
--img-type=TYPE the ec2 image type (one of: ebs, instance)
--arch=ARCH the architecture. (one of: i386, amd64)

uec-resize-image

Usage: uec-query-builds [options]

Options:
-h, --help show this help message and exit
--suite=SUITE suite to query ('hardy', 'karmic', 'lucid')
--build-name=BUILD_NAME
build name ('server', 'desktop' ..)
--stream=STREAM stream query ('released', 'daily')
--base-url=BASE_URL the base url to query
--output=FILE write output to file, default is stdout
--serial=SERIAL build serial serial to use (YYYYMMDD)
--system-suite use output of 'lsb_release --codename --short' for
suite
--config=CONFIG yaml config file to read
--region=REGION the ec2 region to query
--img-type=TYPE the ec2 image type (one of: ebs, instance)
--arch=ARCH the architecture. (one of: i386, amd64)
uecadmin@ubuntuclustercontroller:~$ uec-resize-image --help
Usage: uec-resize-image [ options ] image size [output]
Resize a UEC image to a new size.
if output is given, do not modify 'image', but create new file 'output'

New size is specified per resize2fs(8), e.g. "1G" for 1 gigabyte
options:

 -v | --verbose    show command output

euca-bundle-image

Bundles an image for use with Eucalyptus or Amazon EC2.

 euca-bundle-image -i, --image image_path -u, --user user [-c, --cert cert_path]
[-k, --privatekey private_key_path] [-p, --prefix prefix] [--kernel kernel_id]
[--ramdisk ramdisk_id] [-B, --block-device-mapping mapping]
[-d, --destination destination_path] [--ec2cert ec2cert_path]
[-r, --arch target_architecture] [--batch] [-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

-i, --image Path to the image file to bundle.

-u, --user User ID (12-digit) of the user who is bundling the image.

OPTIONAL PARAMETERS

-c, --cert Path to the user's PEM encoded certificate.

-k, --privatekey Path to the user's PEM encoded private key.

-p, --prefix The prefix for the bundle image files. (default: image name).

--kernel The kernel to be associated with the bundled image.

--ramdisk The ramdisk to be associated with the bundled image.

-B, --block-device-mapping Default block device mapping for the image (comma-separated list of key=value pairs).

-d, --destination Directory to store the bundled image in (default: "/tmp"). Recommended.

--ec2cert The path to the Cloud's X509 public key certificate.

-r, --arch Target architecture for the image ('x86_64' or 'i386' default: 'x86_64').

--batch Run in batch mode (compatibility only. has no effect).

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging. 

euca-bundle-vol
Bundle the local filesystem of a running instance as a bundled image.

euca-bundle-vol -u, --user user -s, --size size_in_MB
[-c, --cert cert_path] [-k, --privatekey private_key_path]
[-a, --all] [-e, --exclude dir1, dir2,...dirN] [-p, --prefix prefix] [--[no-]inherit] [-v, --volume volume_path] [--fstab fstab_path] [--generate-fstab] [--kernel kernel_id] [--ramdisk ramdisk_id] [-B, --block-device-mapping mapping]
[-d, --destination destination_path] [--ec2cert ec2cert_path] [-r, --arch target_architecture] [--batch] [--version]

REQUIRED PARAMETERS

-u, --user User ID (12-digit) of the user who is bundling the image.

-s, --size Size for the image in MB (default: 10GB or 10240MB).

OPTIONAL PARAMETERS

-c, --cert Path to the user's PEM encoded certificate.

-k, --privatekey Path to the user's PEM encoded private key.

-a, --all Bundle all directories (including mounted filesystems).

-p, --prefix The prefix for the bundle image files. (default: image name).

--[no-]inherit Add (or do not add) instance metadata to the bundled image. Inherit is set by default.

-e, --exclude comma-separated list of directories to exclude.

--kernel The kernel to be associated with the bundled image.

--ramdisk The ramdisk to be associated with the bundled image.

-B, --block-device-mapping Default block device mapping for the image (comma-separated list of key=value pairs).

-d, --destination Directory to store the bundled image in (default: "/tmp"). Recommended.

--ec2cert The path to the Cloud's X509 public key certificate.

-r, --arch Target architecture for the image ('x86_64' or 'i386' default: 'x86_64').

-v, --volume Path to mounted volume to create the bundle from (default: "/").

--fstab Path to the fstab to be bundled into the image.

--generate-fstab Generate fstab to bundle into the image.

--batch Run in batch mode (compatibility only. has no effect). 

euca-delete-bundle
Delete a previously uploaded bundle.

 euca-delete-bundle -b, --bucket bucket [-m, --manifest manifest_path]
[-p, --prefix prefix] [--clear] [-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

bucket The name of the bucket to delete from.

OPTIONAL PARAMETERS

-m, --manifest The path to the manifest file.

-b, --bucket The bucket to delete the bundle from (if no
manifest is specified, all images from this
bucket will be deleted).

-p, --prefix The filename prefix for bundled files. Defaults
to image name.

--clear Delete the bucket containing the image.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging. 

euca-download-bundle
Downloads a bundled image from a bucket.

 euca-download-bundle -b, --bucket bucket [-m, --manifest manifest_path] [-d, --directory directory]
[-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

-b, --bucket The name of the bucket to download from.

OPTIONAL PARAMETERS

-m, --manifest The path to the manifest file.

-d, --directory The name of the directory to download the bundled parts to.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-unbundle

Unbundles a previously bundled image.

 euca-unbundle-image -m, --manifest manifest_path [-k, --privatekey private_key_path]
[-s, --source source_directory] [-d, --destination destination_directory]
[-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

-m, --manifest Path to the manifest file for the bundled image.

OPTIONAL PARAMETERS

-d, --destination Directory to store the image to (defaults to the current directory).

-s, --source Source directory for the bundled image parts (defaults to manifest directory).

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging. 

euca-upload-bundle

Upload a previously bundled image to the cloud.

 euca-upload-bundle -b, --bucket bucket -m, --manifest manifest_path [-a, --access-key access_key_id]
[-s, --secret-key secret_key] [--acl canned_acl] [--ec2cert ec2cert_path] [-d, --directory bundle_path]
[--part part] [--url url] [--skipmanifest] [--debug] [-h, --help] [--version]

REQUIRED PARAMETERS

-b, --bucket The name of the bucket to upload to. Bucket will be created if it does not exist.

-m, --manifest The path to the manifest file for the bundled image.

OPTIONAL PARAMETERS

--acl Canned access control policy (defaults to "aws-exec-read").

--ec2cert The path to the Cloud's X509 public key certificate.

-d, --directory The directory containing the bundled image to upload (defaults to the manifest directory).

--part Uploads specified part and all subsequent parts.

--skipmanifest Do not upload the manifest file.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-images
Shows information about machine images.

euca-describe-images [-a] [-o owner] [-x user] [-h, --help] [--version] [--debug] [image1 image2 ... imageN]

OPTIONAL PARAMETERS

image1 image2 ... imageN Images to describe.

-a Show all images that the user has access to.

-o Show only images owned by the owner specified are displayed.

-x Show only images that the specified user is permitted to launch.

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-image-attribute
Show image attributes.

euca-describe-image-attribute [-l, --launch-permission] [-p, --product-code]
[-B, --block-device-mapping] [--kernel] [--ramdisk]
[-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETERS

image_id unique identifier for the image that you want to retrieve the attributes for.

OPTIONAL PARAMETERS

-B, --block-device-mapping show block device mapping.
-l, --launch-permission show launch permissions.
-p, --product-code show the product codes associated with the image
--kernel show the kernel id associated with the image.
--ramdisk show the ramdisk id associated with the image.

-a, --access-key user's Access Key ID.

-s, --secret-key user's Secret Key.

-U, --url URL of the Cloud to connect to.

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-register

Registers a manifest for use with the cloud.

[/sourcecode]euca-register [-h, --help] [--version] [--debug] image_location

REQUIRED PARAMETERS

image_location – path to the uploaded image (bucket/manifest).

OPTIONAL PARAMETERS

-a, –access-key user’s Access Key ID.

-s, –secret-key user’s Secret Key.

-U, –url URL of the Cloud to connect to.

-h, –help Display this help message.

–version Display the version of this tool.

–debug Turn on debugging.[/sourcecode]

euca-deregister

Deregisters an image from the cloud.

euca-deregister [-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETER

image_id unique identifier for the image to be deregistered.

OPTIONAL PARAMETER

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Instance Management

euca-describe-instances
Shows information about instances.

euca-describe-instances [-h, --help] [--version] [--debug]
[instance1... instanceN]

OPTIONAL PARAMETERS

instance1... instanceN instances to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-reboot-instances
Reboots specified instances.

euca-reboot-instances [-h, --help] [--version] [--debug]
[instance1... instanceN]

OPTIONAL PARAMETERS

instance1... instanceN instances to reboot.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-run-instances
Starts instances.

euca-run-instances [-n, --instance-count count] [-g, --group group_name] [-k, --key keyname]
[--addressing addressing] [-t, --instance-type instance_type] [-z, --availability-zone zone]
[--kernel kernel_id] [--ramdisk ramdisk_id] [-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETERS

image_id identifier for the image to run.

OPTIONAL PARAMETERS

-n, --instance-count Number of instances to run.

-g, --group Security group to run the instance under.

-k, --key Name of a (previously created) keypair to associate with this reservation.

-d, --user-data User data for instances read from the command line.

-f, --user-data-file User data for instances as a filename.

--addressing Addressing mode (e.g., private).

-t, --instance-type VM Image type to run the instance(s) as (default: m1.small).

-z, --availability-zone Availability zone to run the instance(s) in.

--kernel Id of the kernel to be used to launch instance(s).

--ramdisk Id of the ramdisk to be used to launch instance(s).

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-terminate-instances¶

Stops specified instances.

euca-terminate-instances [-h, --help] [--version] [--debug]
[instance1... instanceN]

REQUIRED PARAMETERS

instance1... instanceN instances to terminate.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-confirm-product-instance
Confirm if instance is running with product code attached.

euca-confirm-product-instance i, --instance instance_id [-h, --help] [-version] [--debug] product_code

REQUIRED PARAMETERS

-i, --instance Unique identifier for a running instance.

product_code The product code to verify.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Storage Management

euca-attach-volume
Attaches a volume to an instance.

euca-attach-volume -i, --instance instance_id -d, --device device
[-h, --help] [--version] [--debug] volume_id

REQUIRED PARAMETERS

-i, --instance unique id of a running instance to attach the volume to.

-d, --device local device name (inside the guest VM) to use.

volume_id unique id for a volume to attach.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-create-volume
Creates a volume in a specified availability zone.

euca-create-volume -S, --size size | --snapshot snapshot_id -z zone
[-h, --help] [--version] [--debug]

REQUIRED PARAMETERS

-s, --size size of the volume (in GiB).

--snapshot snapshot id to create the volume from. Either size or snapshot can be specified (not both).

-z, --zone availability zone to create the volume in

OPTIONAL PARAMETERS

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-delete-volume

Deletes a volume.

euca-delete-volume [-h, --help] [--version] [--debug] volume_id

REQUIRED PARAMETERS

volume_id unique identifier for the volume to be deleted.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-volumes

Shows information about volumes.

euca-describe-volumes [-h, --help] [--version] [--debug]
[volume1 volume2...volumeN]

OPTIONAL PARAMETERS

volume1 volume2...volumeN volumes to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-detach-volume
Detaches a volume from an instance.

euca-detach-volume [-h, --help] [--version] [--debug] volume_id

REQUIRED PARAMETERS

volume_id unique id for a volume to detach.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-create-snapshot

Creates a snapshot from an existing volume.

euca-create-snapshot [-h, --help] [--version] [--debug] volume_id

REQUIRED PARAMETERS

volume_id unique id for a volume to snapshot.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-delete-snapshot

Deletes a snapshot.

euca-delete-snapshot [-h, --help] [--version] [--debug] snapshot_id

REQUIRED PARAMETERS

snapshot_id unique identifier for the snapshot to be deleted.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-snapshots

Shows information about snapshots.

euca-describe-snapshots [-h, --help] [--version] [--debug]
[snapshot1 snapshot2...snapshotN]

OPTIONAL PARAMETERS

snapshot1 snapshot2...snapshotN - snapshots to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Network Management

euca-allocate-address
Allocate a public IP address.

euca-allocate-address [-h, --help] [--version] [--debug]

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-associate-address

Associate an instance with a public IP address.

euca-associate-address -i, --instance instance_id
[-h, --help] [--version] [--debug] ip

REQUIRED PARAMETERS

-i, --instance unique identifier for a running instance to associate the address with.

ip IP address to associate.

OPTIONAL PARAMETERS

-a, --access-key user's Access Key ID.

-s, --secret-key user's Secret Key.

-U, --url URL of the Cloud to connect to.

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-addresses

Shows information about addresses.

euca-describe-addresses [-h, --help] [--version] [--debug] [ip1 ip2...ipN]

OPTIONAL PARAMETERS

ip1 ip2...ipN IP addresses to display information about.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-disassociate-address

Disassociate a public IP address from an instance.

euca-disassociate-address [-h, --help] [--version] [--debug] ip

REQUIRED PARAMETERS

ip IP address to disassociate.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-release-address

Releases a public IP address.

euca-release-address [-h, --help] [--version] [--debug] ip

REQUIRED PARAMETERS

ip The public IP address to release.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Security

euca-add-group
Creates a new security group.

euca-add-group -d, --description group_description
[-h, --help] [--version] [--debug] group_name

REQUIRED PARAMETERS

-d, --description Description for the group to be created.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-delete-group

Deletes a security group.

euca-delete-group [-h, --help] [--version] [--debug] group_name

REQUIRED PARAMETER

group_name unique name for a group to delete.

OPTIONAL PARAMETER

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-groups

Shows information about groups.

euca-describe-groups [-h, --help] [--version] [--debug] [group1 group2...groupN]

OPTIONAL PARAMETERS

group1 group2...groupN groups to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-add-keypair

Creates a new key pair for use with instances.

euca-add-keypair [-h, --help] [--version] [--debug] keypair_name

REQUIRED PARAMETERS

keypair_name - unique name for a keypair to create.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-delete-keypair

Delete a key pair.

euca-delete-keypair [-h, --help] [--version] [--debug] keypair_name

REQUIRED PARAMETERS

keypair_name unique name for the keypair to delete.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-keypairs

Shows information about keypairs.

euca-describe-keypairs [-h, --help] [--version] [--debug]
[keypair1 keypair2...keypairN]

OPTIONAL PARAMETERS

keypair1 keypair2...keypairN keypairs to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-availability-zones

Shows information about availability zones.

euca-describe-availability-zones [--region region] [-h, --help] [--version] [--debug] [zone1 zone2...zoneN] [verbose]

OPTIONAL PARAMETERS

--region region to describe availability zones for

zone1 zone2...zoneN zones to describe.

verbose show verbose resource information (Eucalyptus administrator-only functionality).

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-describe-regions

Shows information about regions.

euca-describe-regions [-h, --help] [--version] [--debug]
[region1 region2...regionN]

OPTIONAL PARAMETERS

region1 region2...regionN regions to describe.

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-get-console-output

Prints console output from a running instance.

euca-get-console-output [-h, --help] [--version] [--debug] instance_id

REQUIRED PARAMETERS

instance_id unique identifier for the instance show the console output for.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-modify-image-attribute

Modify attributes for an image.

euca-modify-image-attribute [-l, --launch-permission] [-p, --product-code]
[-a, --add entity ] [-r, --remove entity]
[-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETERS

image_id Unique identifier for the image that you want to modify the attributes for.

OPTIONAL PARAMETERS

-l, --launch-permission Show launch permissions.

-p, --product-code Show the product codes associated with the image

-a, -add Entity (typically, user id) to add.

-r, --remove Entity (typically, user id) to remove.

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-reset-image-attribute

Reset attributes for an image.

euca-reset-image-attribute -l, --launch-permission
[-h, --help] [--version] [--debug] image_id

REQUIRED PARAMETERS

-l, --launch-permission show launch permissions.

image_id - unique identifier for the image that you want to reset the attributes for.

OPTIONAL PARAMETERS

-a, --access-key User's Access Key ID.

-s, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-revoke
Revoke a rule for a security group.

euca-revoke [-P | --protocol protocol] [-p | --port-range port_range]
[-t | --icmp-type-code type:code] [-o | --source-group source_group]
[-u | --source-group-user source_group_user] [-s | --source-subnet source_subnet]
[-h, --help] [--version] [--debug] group_name

REQUIRED PARAMETERS

group_name Name of the group to add the rule to.

OPTIONAL PARAMETERS

-P, --protocol Protocol ("tcp" "udp" or "icmp").

-p, --port-range Range of ports for the rule (specified as "from-to").

-t, --icmp-type-code ICMP type and code specified as "type:code"

-o, --source-group Group from which traffic is authorized by the rule.

-u, --source-group-user User ID for the source group.

-s, --source-subnet The source subnet for the rule.

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

euca-version

Shows the Euca2ools version

euca-version [-h, --help] [--debug]

euca-authorize

Add a new rule to a security group.

euca-authorize [-P, --protocol protocol] [-p, --port-range port_range]
[-t, --icmp-type-code type:code] [-o, --source-group source_group]
[-u, --source-group-user source_group_user] [-s, --source-subnet source_subnet]
[-h, --help] [--version] [--debug] group_name

REQUIRED PARAMETERS

group_name Name of the group to add the rule to.

OPTIONAL PARAMETERS

-P, --protocol Protocol ("tcp" "udp" or "icmp").

-p, --port-range Range of ports for the rule (specified as "from-to").

-t, --icmp-type-code ICMP type and code specified as "type:code"

-o, --source-group Group from which traffic is authorized by the rule.

-u, --source-group-user User ID for the source group.

-s, --source-subnet The source subnet for the rule.

-A, --access-key User's Access Key ID.

-S, --secret-key User's Secret Key.

-U, --url URL of the Cloud to connect to.

--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).

-h, --help Display this help message.

--version Display the version of this tool.

--debug Turn on debugging.

Commands Available in UEC and not available in Eucalyptus installations

Uec-publish-tarball¶

Usage: uec-publish-tarball [ options ] tarfile bucket [arch]

register a UEC tarball (ie, per http://uec-images.ubuntu.com)

if arch is not provided, a name-based attempt is made to guess
options:

-k | --kernel  k        use previously registered kernel with id 'k'

specify 'none' for no kernel

-K | --kernel-file f    bundle, upload, use file 'f' as kernel

-r | --ramdisk r        use previously registered ramdisk with id 'r'

specify 'none' for no ramdisk

-R | --ramdisk-file f   bundle, upload, use file 'f' as ramdisk
--resize  s        resize the image to 's' bundling uploading

's' must be valid input to uec-resize-image

-q | --quiet            be quiet, only output published ids
Example: uec-publish-tarball lucid-uec-i386.tar.gz my-lucid-bucket i386

uec-registration

uec-registration [--manual|--auto|--help]

Options:

--manual      Disable automatic component registration

--auto        Enable automatic component registration

-h, --help    This message

uec-run-instances

Same as euca-run-instances

uec-publish-image

Usage: uec-publish-image [ options ] arch image bucket

arch           : one of i386 or x86_64

image          : the image to upload and register

bucket         : bucket to publish image to
options:

l|-add-launch <user_id>   : user_id can be "all", or "none"

--dry-run                : only report what would be done

--allow-existing         : if a image is already registered

simply report as if work was done

o|-output <file>          : write registered id and manifest to file
|--rename <publish_path>  : publish to bucket/<publish_path>

default: bucket/<basename(image)>

t|-type   <type>          : type is one of kernel/ramdisk/image

v|-verbose                : increase verbosity
if type is 'image', then:

-k | --kernel  k        : use previously registered kernel with id 'k'

specify 'none' for no kernel

-K | --kernel-file f    : bundle, upload, use file 'f' as kernel

-r | --ramdisk r        : use previously registered ramdisk with id 'r'

specify 'none' for no ramdisk

-R | --ramdisk-file f   : bundle, upload, use file 'f' as ramdisk

-B | --block-device-mapping m : specify block device mapping in bundle

uec-query-builds

Usage: uec-query-builds [options]

Options:
-h, --help show this help message and exit
--suite=SUITE suite to query ('hardy', 'karmic', 'lucid')
--build-name=BUILD_NAME
build name ('server', 'desktop' ..)
--stream=STREAM stream query ('released', 'daily')
--base-url=BASE_URL the base url to query
--output=FILE write output to file, default is stdout
--serial=SERIAL build serial serial to use (YYYYMMDD)
--system-suite use output of 'lsb_release --codename --short' for
suite
--config=CONFIG yaml config file to read
--region=REGION the ec2 region to query
--img-type=TYPE the ec2 image type (one of: ebs, instance)
--arch=ARCH the architecture. (one of: i386, amd64)

uec-resize-image¶

Usage: uec-query-builds [options]

Options:
-h, --help show this help message and exit
--suite=SUITE suite to query ('hardy', 'karmic', 'lucid')
--build-name=BUILD_NAME
build name ('server', 'desktop' ..)
--stream=STREAM stream query ('released', 'daily')
--base-url=BASE_URL the base url to query
--output=FILE write output to file, default is stdout
--serial=SERIAL build serial serial to use (YYYYMMDD)
--system-suite use output of 'lsb_release --codename --short' for
suite
--config=CONFIG yaml config file to read
--region=REGION the ec2 region to query
--img-type=TYPE the ec2 image type (one of: ebs, instance)
--arch=ARCH the architecture. (one of: i386, amd64)
uecadmin@ubuntuclustercontroller:~$ uec-resize-image --help
Usage: uec-resize-image [ options ] image size [output]
Resize a UEC image to a new size.
if output is given, do not modify 'image', but create new file 'output'

New size is specified per resize2fs(8), e.g. "1G" for 1 gigabyte
options:

-v | --verbose    show command output
Chapter 9 Troubleshooting Chapter 11 Hacks
About these ads

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Follow

Get every new post delivered to your Inbox.

Join 171 other followers

%d bloggers like this: