UEC: Peritah-perintah Euca: Difference between revisions

From OnnoCenterWiki
Jump to navigationJump to search
Onnowpurbo (talk | contribs)
Onnowpurbo (talk | contribs)
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 5: Line 5:
Bundles an image for use with Eucalyptus or Amazon EC2.
Bundles an image for use with Eucalyptus or Amazon EC2.


euca-bundle-image -i, --image image_path -u, --user user [-c, --cert cert_path]
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]
[-k, --privatekey private_key_path] [-p, --prefix prefix] [--kernel kernel_id]
[--ramdisk ramdisk_id] [-B, --block-device-mapping mapping]
[--ramdisk ramdisk_id] [-B, --block-device-mapping mapping]
[-d, --destination destination_path] [--ec2cert ec2cert_path]
[-d, --destination destination_path] [--ec2cert ec2cert_path]
[-r, --arch target_architecture] [--batch] [-h, --help] [--version] [--debug]
[-r, --arch target_architecture] [--batch] [-h, --help] [--version] [--debug]
   
   
REQUIRED PARAMETERS
REQUIRED PARAMETERS
   
   
-i, --image Path to the image file to bundle.
-i, --image Path to the image file to bundle.
   
   
-u, --user User ID (12-digit) of the user who is bundling the image.
-u, --user User ID (12-digit) of the user who is bundling the image.
   
   
OPTIONAL PARAMETERS
OPTIONAL PARAMETERS
   
   
-c, --cert Path to the user's PEM encoded certificate.
-c, --cert Path to the user's PEM encoded certificate.
   
   
-k, --privatekey Path to the user's PEM encoded private key.
-k, --privatekey Path to the user's PEM encoded private key.
   
   
-p, --prefix The prefix for the bundle image files. (default: image name).
-p, --prefix The prefix for the bundle image files. (default: image name).
   
   
--kernel The kernel to be associated with the bundled image.
--kernel The kernel to be associated with the bundled image.
   
   
--ramdisk The ramdisk 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).
-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.
-d, --destination Directory to store the bundled image in (default: "/tmp"). Recommended.
   
   
--ec2cert The path to the Cloud's X509 public key certificate.
--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').
-r, --arch Target architecture for the image ('x86_64' or 'i386' default: 'x86_64').
   
   
--batch Run in batch mode (compatibility only. has no effect).
--batch Run in batch mode (compatibility only. has no effect).
   
   
-a, --access-key User's Access Key ID.
-a, --access-key User's Access Key ID.
   
   
-s, --secret-key User's Secret Key.
-s, --secret-key User's Secret Key.
   
   
-U, --url URL of the Cloud to connect to.
-U, --url URL of the Cloud to connect to.
   
   
--config Read credentials and cloud settings from the
--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
   
   
-h, --help Display this help message.
-h, --help Display this help message.
   
   
--version Display the version of this tool.
--version Display the version of this tool.
   
   
--debug Turn on debugging.
--debug Turn on debugging.




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


euca-bundle-vol -u, --user user -s, --size size_in_MB
euca-bundle-vol -u, --user user -s, --size size_in_MB
   
   
[-c, --cert cert_path] [-k, --privatekey private_key_path]
[-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]
[-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]
[-d, --destination destination_path] [--ec2cert ec2cert_path] [-r, --arch target_architecture] [--batch] [--version]
   
   
REQUIRED PARAMETERS
REQUIRED PARAMETERS
   
   
-u, --user User ID (12-digit) of the user who is bundling the image.
-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).
-s, --size Size for the image in MB (default: 10GB or 10240MB).
   
   
OPTIONAL PARAMETERS
OPTIONAL PARAMETERS
   
   
-c, --cert Path to the user's PEM encoded certificate.
-c, --cert Path to the user's PEM encoded certificate.
   
   
-k, --privatekey Path to the user's PEM encoded private key.
-k, --privatekey Path to the user's PEM encoded private key.
   
   
-a, --all Bundle all directories (including mounted filesystems).
-a, --all Bundle all directories (including mounted filesystems).
   
   
-p, --prefix The prefix for the bundle image files. (default: image name).
-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.
--[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.
-e, --exclude comma-separated list of directories to exclude.
   
   
--kernel The kernel to be associated with the bundled image.
--kernel The kernel to be associated with the bundled image.
   
   
--ramdisk The ramdisk 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).
-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.
-d, --destination Directory to store the bundled image in (default: "/tmp"). Recommended.
   
   
--ec2cert The path to the Cloud's X509 public key certificate.
--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').
-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: "/").
-v, --volume Path to mounted volume to create the bundle from (default: "/").
   
   
--fstab Path to the fstab to be bundled into the image.
--fstab Path to the fstab to be bundled into the image.
   
   
--generate-fstab Generate fstab to bundle into the image.
--generate-fstab Generate fstab to bundle into the image.
   
   
--batch Run in batch mode (compatibility only. has no effect).
--batch Run in batch mode (compatibility only. has no effect).




Line 112: Line 112:
Delete a previously uploaded bundle.
Delete a previously uploaded bundle.


euca-delete-bundle -b, --bucket bucket [-m, --manifest manifest_path]
euca-delete-bundle -b, --bucket bucket [-m, --manifest manifest_path]
[-p, --prefix prefix] [--clear] [-h, --help] [--version] [--debug]
[-p, --prefix prefix] [--clear] [-h, --help] [--version] [--debug]
   
   
REQUIRED PARAMETERS
REQUIRED PARAMETERS
   
   
bucket The name of the bucket to delete from.
bucket The name of the bucket to delete from.
   
   
OPTIONAL PARAMETERS
OPTIONAL PARAMETERS
   
   
-m, --manifest The path to the manifest file.
-m, --manifest The path to the manifest file.
   
   
-b, --bucket The bucket to delete the bundle from (if no
-b, --bucket The bucket to delete the bundle from (if no
manifest is specified, all images from this
manifest is specified, all images from this
bucket will be deleted).
bucket will be deleted).
   
   
-p, --prefix The filename prefix for bundled files. Defaults
-p, --prefix The filename prefix for bundled files. Defaults
to image name.
to image name.
   
   
--clear Delete the bucket containing the image.
--clear Delete the bucket containing the image.
   
   
-a, --access-key User's Access Key ID.
-a, --access-key User's Access Key ID.
   
   
-s, --secret-key User's Secret Key.
-s, --secret-key User's Secret Key.
   
   
-U, --url URL of the Cloud to connect to.
-U, --url URL of the Cloud to connect to.
   
   
--config Read credentials and cloud settings from the
--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
   
   
-h, --help Display this help message.
-h, --help Display this help message.
   
   
--version Display the version of this tool.
--version Display the version of this tool.
   
   
--debug Turn on debugging.
--debug Turn on debugging.




Line 152: Line 152:
Downloads a bundled image from a bucket.
Downloads a bundled image from a bucket.


euca-download-bundle -b, --bucket bucket [-m, --manifest manifest_path] [-d, --directory directory]
euca-download-bundle -b, --bucket bucket [-m, --manifest manifest_path] [-d, --directory directory]
[-h, --help] [--version] [--debug]
[-h, --help] [--version] [--debug]
   
   
REQUIRED PARAMETERS
REQUIRED PARAMETERS
   
   
-b, --bucket The name of the bucket to download from.
-b, --bucket The name of the bucket to download from.
   
   
OPTIONAL PARAMETERS
OPTIONAL PARAMETERS
   
   
-m, --manifest The path to the manifest file.
-m, --manifest The path to the manifest file.
   
   
-d, --directory The name of the directory to download the bundled parts to.
-d, --directory The name of the directory to download the bundled parts to.
   
   
-a, --access-key User's Access Key ID.
-a, --access-key User's Access Key ID.
   
   
-s, --secret-key User's Secret Key.
-s, --secret-key User's Secret Key.
   
   
-U, --url URL of the Cloud to connect to.
-U, --url URL of the Cloud to connect to.
   
   
--config Read credentials and cloud settings from the
--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
   
   
-h, --help Display this help message.
-h, --help Display this help message.
   
   
--version Display the version of this tool.
--version Display the version of this tool.
   
   
--debug Turn on debugging.
--debug Turn on debugging.
 


===euca-unbundle===
===euca-unbundle===
Line 185: Line 184:
Unbundles a previously bundled image.
Unbundles a previously bundled image.


euca-unbundle-image -m, --manifest manifest_path [-k, --privatekey private_key_path]
euca-unbundle-image -m, --manifest manifest_path [-k, --privatekey private_key_path]
[-s, --source source_directory] [-d, --destination destination_directory]
[-s, --source source_directory] [-d, --destination destination_directory]
[-h, --help] [--version] [--debug]
[-h, --help] [--version] [--debug]
   
   
REQUIRED PARAMETERS
REQUIRED PARAMETERS
   
   
-m, --manifest Path to the manifest file for the bundled image.
-m, --manifest Path to the manifest file for the bundled image.
   
   
OPTIONAL PARAMETERS
OPTIONAL PARAMETERS
   
   
-d, --destination Directory to store the image to (defaults to the current directory).
-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).
-s, --source Source directory for the bundled image parts (defaults to manifest directory).
   
   
-a, --access-key User's Access Key ID.
-a, --access-key User's Access Key ID.
   
   
-s, --secret-key User's Secret Key.
-s, --secret-key User's Secret Key.
   
   
-U, --url URL of the Cloud to connect to.
-U, --url URL of the Cloud to connect to.
   
   
--config Read credentials and cloud settings from the
--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
   
   
-h, --help Display this help message.
-h, --help Display this help message.
   
   
--version Display the version of this tool.
--version Display the version of this tool.
   
   
--debug Turn on debugging.
--debug Turn on debugging.




Line 219: Line 218:
Upload a previously bundled image to the cloud.
Upload a previously bundled image to the cloud.


euca-upload-bundle -b, --bucket bucket -m, --manifest manifest_path [-a, --access-key access_key_id]
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]
[-s, --secret-key secret_key] [--acl canned_acl] [--ec2cert ec2cert_path] [-d, --directory bundle_path]
[--part part] [--url url] [--skipmanifest] [--debug] [-h, --help] [--version]
[--part part] [--url url] [--skipmanifest] [--debug] [-h, --help] [--version]
   
   
REQUIRED PARAMETERS
REQUIRED PARAMETERS
   
   
-b, --bucket The name of the bucket to upload to. Bucket will be created if it does not exist.
-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.
-m, --manifest The path to the manifest file for the bundled image.
   
   
OPTIONAL PARAMETERS
OPTIONAL PARAMETERS
   
   
--acl Canned access control policy (defaults to "aws-exec-read").
--acl Canned access control policy (defaults to "aws-exec-read").
   
   
--ec2cert The path to the Cloud's X509 public key certificate.
--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).
-d, --directory The directory containing the bundled image to upload (defaults to the manifest directory).
   
   
--part Uploads specified part and all subsequent parts.
--part Uploads specified part and all subsequent parts.
   
   
--skipmanifest Do not upload the manifest file.
--skipmanifest Do not upload the manifest file.
   
   
-a, --access-key User's Access Key ID.
-a, --access-key User's Access Key ID.
   
   
-s, --secret-key User's Secret Key.
-s, --secret-key User's Secret Key.
   
   
-U, --url URL of the Cloud to connect to.
-U, --url URL of the Cloud to connect to.
   
   
--config Read credentials and cloud settings from the
--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
   
   
-h, --help Display this help message.
-h, --help Display this help message.
   
   
--version Display the version of this tool.
--version Display the version of this tool.
   
   
--debug Turn on debugging.
--debug Turn on debugging.
 


===euca-describe-images===
===euca-describe-images===
Line 261: Line 259:
Shows information about machine images.
Shows information about machine images.


euca-describe-images [-a] [-o owner] [-x user] [-h, --help] [--version] [--debug] [image1 image2 ... imageN]
euca-describe-images [-a] [-o owner] [-x user] [-h, --help] [--version] [--debug] [image1 image2 ... imageN]
   
   
OPTIONAL PARAMETERS
OPTIONAL PARAMETERS
   
   
image1 image2 ... imageN Images to describe.
image1 image2 ... imageN Images to describe.
   
   
-a Show all images that the user has access to.
-a Show all images that the user has access to.
   
   
-o Show only images owned by the owner specified are displayed.
-o Show only images owned by the owner specified are displayed.
   
   
-x Show only images that the specified user is permitted to launch.
-x Show only images that the specified user is permitted to launch.
   
   
-A, --access-key User's Access Key ID.
-A, --access-key User's Access Key ID.
   
   
-S, --secret-key User's Secret Key.
-S, --secret-key User's Secret Key.
   
   
-U, --url URL of the Cloud to connect to.
-U, --url URL of the Cloud to connect to.
   
   
--config Read credentials and cloud settings from the
--config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
   
   
-h, --help Display this help message.
-h, --help Display this help message.
   
   
--version Display the version of this tool.
--version Display the version of this tool.
   
   
--debug Turn on debugging.
--debug Turn on debugging.




Line 293: Line 291:
Show image attributes.
Show image attributes.


euca-describe-image-attribute [-l, --launch-permission] [-p, --product-code]
euca-describe-image-attribute [-l, --launch-permission] [-p, --product-code]
[-B, --block-device-mapping] [--kernel] [--ramdisk]
[-B, --block-device-mapping] [--kernel] [--ramdisk]
[-h, --help] [--version] [--debug] image_id
[-h, --help] [--version] [--debug] image_id
   
   
REQUIRED PARAMETERS
REQUIRED PARAMETERS
   
   
image_id unique identifier for the image that you want to retrieve the attributes for.
image_id unique identifier for the image that you want to retrieve the attributes for.
   
   
OPTIONAL PARAMETERS
OPTIONAL PARAMETERS
   
   
-B, --block-device-mapping show block device mapping.
-B, --block-device-mapping show block device mapping.
-l, --launch-permission show launch permissions.
-l, --launch-permission show launch permissions.
-p, --product-code show the product codes associated with the image
-p, --product-code show the product codes associated with the image
--kernel show the kernel id associated with the image.
--kernel show the kernel id associated with the image.
--ramdisk show the ramdisk id associated with the image.
--ramdisk show the ramdisk id associated with the image.
   
   
-a, --access-key user's Access Key ID.
-a, --access-key user's Access Key ID.
   
   
-s, --secret-key user's Secret Key.
-s, --secret-key user's Secret Key.
   
   
-U, --url URL of the Cloud to connect to.
-U, --url URL of the Cloud to connect to.
 
-h, --help Display this help message.
   
   
-h, --help Display this help message.
--version Display the version of this tool.
   
   
--version Display the version of this tool.
--debug Turn on debugging.
--debug Turn on debugging.


===euca-register===
===euca-register===
Line 325: Line 323:
Registers a manifest for use with the cloud.
Registers a manifest for use with the cloud.


euca-register [-h, --help] [--version] [--debug] image_location
euca-register [-h, --help] [--version] [--debug] image_location
   
   
REQUIRED PARAMETERS
REQUIRED PARAMETERS
   
   
image_location - path to the uploaded image (bucket/manifest).
image_location - path to the uploaded image (bucket/manifest).
   
   
OPTIONAL PARAMETERS
OPTIONAL PARAMETERS
   
   
-a, --access-key user's Access Key ID.
-a, --access-key user's Access Key ID.
   
   
-s, --secret-key user's Secret Key.
-s, --secret-key user's Secret Key.
   
   
-U, --url URL of the Cloud to connect to.
-U, --url URL of the Cloud to connect to.
   
   
-h, --help Display this help message.
-h, --help Display this help message.
   
   
--version Display the version of this tool.
--version Display the version of this tool.
   
   
--debug Turn on debugging.
--debug Turn on debugging.




Line 350: Line 348:
Deregisters an image from the cloud.
Deregisters an image from the cloud.


01 euca-deregister [-h, --help] [--version] [--debug] image_id
euca-deregister [-h, --help] [--version] [--debug] image_id
02  
03 REQUIRED PARAMETER
  REQUIRED PARAMETER
04  
05 image_id unique identifier for the image to be deregistered.
  image_id unique identifier for the image to be deregistered.
06  
07 OPTIONAL PARAMETER
  OPTIONAL PARAMETER
08  
09 -a, --access-key User's Access Key ID.
  -a, --access-key User's Access Key ID.
10  
11 -s, --secret-key User's Secret Key.
  -s, --secret-key User's Secret Key.
12  
13 -U, --url URL of the Cloud to connect to.
  -U, --url URL of the Cloud to connect to.
14  
15 --config Read credentials and cloud settings from the
  --config Read credentials and cloud settings from the
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17  
18 -h, --help Display this help message.
  -h, --help Display this help message.
19  
20 --version Display the version of this tool.
  --version Display the version of this tool.
21  
22 --debug Turn on debugging.
  --debug Turn on debugging.




Line 380: Line 378:
Shows information about instances.
Shows information about instances.


01 euca-describe-instances [-h, --help] [--version] [--debug]
euca-describe-instances [-h, --help] [--version] [--debug]
02 [instance1... instanceN]
[instance1... instanceN]
03  
04 OPTIONAL PARAMETERS
  OPTIONAL PARAMETERS
05  
06 instance1... instanceN instances to describe.
  instance1... instanceN instances to describe.
07  
08 -a, --access-key User's Access Key ID.
  -a, --access-key User's Access Key ID.
09  
10 -s, --secret-key User's Secret Key.
  -s, --secret-key User's Secret Key.
11  
12 -U, --url URL of the Cloud to connect to.
  -U, --url URL of the Cloud to connect to.
13  
14 --config Read credentials and cloud settings from the
  --config Read credentials and cloud settings from the
15 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16  
17 -h, --help Display this help message.
  -h, --help Display this help message.
18  
19 --version Display the version of this tool.
  --version Display the version of this tool.
20  
21 --debug Turn on debugging.
  --debug Turn on debugging.




Line 407: Line 405:
Reboots specified instances.
Reboots specified instances.


01 euca-reboot-instances [-h, --help] [--version] [--debug]
euca-reboot-instances [-h, --help] [--version] [--debug]
02 [instance1... instanceN]
[instance1... instanceN]
03  
04 OPTIONAL PARAMETERS
  OPTIONAL PARAMETERS
05  
06 instance1... instanceN instances to reboot.
  instance1... instanceN instances to reboot.
07  
08 -a, --access-key User's Access Key ID.
  -a, --access-key User's Access Key ID.
09  
10 -s, --secret-key User's Secret Key.
  -s, --secret-key User's Secret Key.
11  
12 -U, --url URL of the Cloud to connect to.
  -U, --url URL of the Cloud to connect to.
13  
14 --config Read credentials and cloud settings from the
  --config Read credentials and cloud settings from the
15 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16  
17 -h, --help Display this help message.
  -h, --help Display this help message.
18  
19 --version Display the version of this tool.
  --version Display the version of this tool.
20  
21 --debug Turn on debugging.
  --debug Turn on debugging.




Line 434: Line 432:
Starts instances.
Starts instances.


01 euca-run-instances [-n, --instance-count count] [-g, --group group_name] [-k, --key keyname]
euca-run-instances [-n, --instance-count count] [-g, --group group_name] [-k, --key keyname]
02 [--addressing addressing] [-t, --instance-type instance_type] [-z, --availability-zone zone]
[--addressing addressing] [-t, --instance-type instance_type] [-z, --availability-zone zone]
03 [--kernel kernel_id] [--ramdisk ramdisk_id] [-h, --help] [--version] [--debug] image_id
[--kernel kernel_id] [--ramdisk ramdisk_id] [-h, --help] [--version] [--debug] image_id
04  
05 REQUIRED PARAMETERS
  REQUIRED PARAMETERS
06  
07 image_id identifier for the image to run.
  image_id identifier for the image to run.
08  
09 OPTIONAL PARAMETERS
  OPTIONAL PARAMETERS
10  
11 -n, --instance-count Number of instances to run.
  -n, --instance-count Number of instances to run.
12  
13 -g, --group Security group to run the instance under.
  -g, --group Security group to run the instance under.
14  
15 -k, --key Name of a (previously created) keypair to associate with this reservation.
  -k, --key Name of a (previously created) keypair to associate with this reservation.
16  
17 -d, --user-data User data for instances read from the command line.
  -d, --user-data User data for instances read from the command line.
18  
19 -f, --user-data-file User data for instances as a filename.
  -f, --user-data-file User data for instances as a filename.
20  
21 --addressing Addressing mode (e.g., private).
  --addressing Addressing mode (e.g., private).
22  
23 -t, --instance-type VM Image type to run the instance(s) as (default: m1.small).
  -t, --instance-type VM Image type to run the instance(s) as (default: m1.small).
24  
25 -z, --availability-zone Availability zone to run the instance(s) in.
  -z, --availability-zone Availability zone to run the instance(s) in.
26  
27 --kernel Id of the kernel to be used to launch instance(s).
  --kernel Id of the kernel to be used to launch instance(s).
28  
29 --ramdisk Id of the ramdisk to be used to launch instance(s).
  --ramdisk Id of the ramdisk to be used to launch instance(s).
30  
31 -a, --access-key User's Access Key ID.
  -a, --access-key User's Access Key ID.
32  
33 -s, --secret-key User's Secret Key.
  -s, --secret-key User's Secret Key.
34  
35 -U, --url URL of the Cloud to connect to.
  -U, --url URL of the Cloud to connect to.
36  
37 --config Read credentials and cloud settings from the
  --config Read credentials and cloud settings from the
38 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
39  
40 -h, --help Display this help message.
  -h, --help Display this help message.
41  
42 --version Display the version of this tool.
  --version Display the version of this tool.
43  
44 --debug Turn on debugging.
  --debug Turn on debugging.




Line 484: Line 482:
Stops specified instances.
Stops specified instances.


01 euca-terminate-instances [-h, --help] [--version] [--debug]
euca-terminate-instances [-h, --help] [--version] [--debug]
02 [instance1... instanceN]
[instance1... instanceN]
03  
04 REQUIRED PARAMETERS
  REQUIRED PARAMETERS
05  
06 instance1... instanceN instances to terminate.
  instance1... instanceN instances to terminate.
07  
08 OPTIONAL PARAMETERS
  OPTIONAL PARAMETERS
09  
10 -a, --access-key User's Access Key ID.
  -a, --access-key User's Access Key ID.
11  
12 -s, --secret-key User's Secret Key.
  -s, --secret-key User's Secret Key.
13  
14 -U, --url URL of the Cloud to connect to.
  -U, --url URL of the Cloud to connect to.
15  
16 --config Read credentials and cloud settings from the
  --config Read credentials and cloud settings from the
17 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
18  
19 -h, --help Display this help message.
  -h, --help Display this help message.
20  
   
21 --version Display the version of this tool.
--version Display the version of this tool.
22  
23 --debug Turn on debugging.
  --debug Turn on debugging.




Line 513: Line 511:
Confirm if instance is running with product code attached.
Confirm if instance is running with product code attached.


01 euca-confirm-product-instance i, --instance instance_id [-h, --help] [-version] [--debug] product_code
euca-confirm-product-instance i, --instance instance_id [-h, --help] [-version] [--debug] product_code
02  
 
03 REQUIRED PARAMETERS
  REQUIRED PARAMETERS
04  
05 -i, --instance Unique identifier for a running instance.
  -i, --instance Unique identifier for a running instance.
06  
07 product_code The product code to verify.
  product_code The product code to verify.
08  
09 OPTIONAL PARAMETERS
  OPTIONAL PARAMETERS
10  
11 -a, --access-key User's Access Key ID.
  -a, --access-key User's Access Key ID.
12  
13 -s, --secret-key User's Secret Key.
  -s, --secret-key User's Secret Key.
14  
15 -U, --url URL of the Cloud to connect to.
  -U, --url URL of the Cloud to connect to.
16  
17 --config Read credentials and cloud settings from the
  --config Read credentials and cloud settings from the
18 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
19  
20 -h, --help Display this help message.
  -h, --help Display this help message.
21  
22 --version Display the version of this tool.
  --version Display the version of this tool.
23  
24 --debug Turn on debugging.
  --debug Turn on debugging.
Storage Management
 
euca-attach-volume
 
==Storage Management==
 
===euca-attach-volume===


Attaches a volume to an instance.
Attaches a volume to an instance.
view source
 
print?
euca-attach-volume -i, --instance instance_id -d, --device device
01 euca-attach-volume -i, --instance instance_id -d, --device device
[-h, --help] [--version] [--debug] volume_id
02 [-h, --help] [--version] [--debug] volume_id
03  
  REQUIRED PARAMETERS
04 REQUIRED PARAMETERS
05  
  -i, --instance unique id of a running instance to attach the volume to.
06 -i, --instance unique id of a running instance to attach the volume to.
07  
  -d, --device local device name (inside the guest VM) to use.
08 -d, --device local device name (inside the guest VM) to use.
 
09  
  volume_id unique id for a volume to attach.
10 volume_id unique id for a volume to attach.
11  
  OPTIONAL PARAMETERS
12 OPTIONAL PARAMETERS
13  
  -a, --access-key User's Access Key ID.
14 -a, --access-key User's Access Key ID.
15  
  -s, --secret-key User's Secret Key.
16 -s, --secret-key User's Secret Key.
17  
  -U, --url URL of the Cloud to connect to.
18 -U, --url URL of the Cloud to connect to.
19  
  --config Read credentials and cloud settings from the
20 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
21 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
22  
  -h, --help Display this help message.
23 -h, --help Display this help message.
24  
  --version Display the version of this tool.
25 --version Display the version of this tool.
26  
  --debug Turn on debugging.
27 --debug Turn on debugging.
 
euca-create-volume
 
===euca-create-volume===


Creates a volume in a specified availability zone.
Creates a volume in a specified availability zone.
view source
 
print?
euca-create-volume -S, --size size | --snapshot snapshot_id -z zone
01 euca-create-volume -S, --size size | --snapshot snapshot_id -z zone
[-h, --help] [--version] [--debug]
02 [-h, --help] [--version] [--debug]
03  
  REQUIRED PARAMETERS
04 REQUIRED PARAMETERS
05  
  -s, --size size of the volume (in GiB).
06 -s, --size size of the volume (in GiB).
07  
  --snapshot snapshot id to create the volume from. Either size or snapshot can be specified (not both).
08 --snapshot snapshot id to create the volume from. Either size or snapshot can be specified (not both).
09  
  -z, --zone availability zone to create the volume in
10 -z, --zone availability zone to create the volume in
11  
  OPTIONAL PARAMETERS
12 OPTIONAL PARAMETERS
13  
  -A, --access-key User's Access Key ID.
14 -A, --access-key User's Access Key ID.
15  
  -S, --secret-key User's Secret Key.
16 -S, --secret-key User's Secret Key.
17  
  -U, --url URL of the Cloud to connect to.
18 -U, --url URL of the Cloud to connect to.
19  
  --config Read credentials and cloud settings from the
20 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
21 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
22  
  -h, --help Display this help message.
23 -h, --help Display this help message.
24  
  --version Display the version of this tool.
25 --version Display the version of this tool.
26  
  --debug Turn on debugging.
27 --debug Turn on debugging.
 
euca-delete-volume
 
===euca-delete-volume===


Deletes a volume.
Deletes a volume.
view source
 
print?
euca-delete-volume [-h, --help] [--version] [--debug] volume_id
01 euca-delete-volume [-h, --help] [--version] [--debug] volume_id
02  
  REQUIRED PARAMETERS
03 REQUIRED PARAMETERS
04  
  volume_id unique identifier for the volume to be deleted.
05 volume_id unique identifier for the volume to be deleted.
06  
  OPTIONAL PARAMETERS
07 OPTIONAL PARAMETERS
08  
  -a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10  
  -s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12  
  -U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14  
  --config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17  
  -h, --help Display this help message.
18 -h, --help Display this help message.
19  
  --version Display the version of this tool.
20 --version Display the version of this tool.
21  
  --debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-describe-volumes
 
===euca-describe-volumes===


Shows information about volumes.
Shows information about volumes.
view source
 
print?
euca-describe-volumes [-h, --help] [--version] [--debug]
01 euca-describe-volumes [-h, --help] [--version] [--debug]
[volume1 volume2...volumeN]
02 [volume1 volume2...volumeN]
03  
  OPTIONAL PARAMETERS
04 OPTIONAL PARAMETERS
05  
  volume1 volume2...volumeN volumes to describe.
06 volume1 volume2...volumeN volumes to describe.
07  
  -a, --access-key User's Access Key ID.
08 -a, --access-key User's Access Key ID.
09  
  -s, --secret-key User's Secret Key.
10 -s, --secret-key User's Secret Key.
11  
  -U, --url URL of the Cloud to connect to.
12 -U, --url URL of the Cloud to connect to.
13  
  --config Read credentials and cloud settings from the
14 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
15 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16  
  -h, --help Display this help message.
17 -h, --help Display this help message.
18  
  --version Display the version of this tool.
19 --version Display the version of this tool.
20  
  --debug Turn on debugging.
21 --debug Turn on debugging.
 
euca-detach-volume
 
===euca-detach-volume===


Detaches a volume from an instance.
Detaches a volume from an instance.
view source
 
print?
euca-detach-volume [-h, --help] [--version] [--debug] volume_id
01 euca-detach-volume [-h, --help] [--version] [--debug] volume_id
02  
  REQUIRED PARAMETERS
03 REQUIRED PARAMETERS
04  
  volume_id unique id for a volume to detach.
05 volume_id unique id for a volume to detach.
06  
  OPTIONAL PARAMETERS
07 OPTIONAL PARAMETERS
08  
  -a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10  
  -s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12  
  -U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14  
  --config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17  
  -h, --help Display this help message.
18 -h, --help Display this help message.
19  
  --version Display the version of this tool.
20 --version Display the version of this tool.
21  
  --debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-create-snapshot
 
===euca-create-snapshot===


Creates a snapshot from an existing volume.
Creates a snapshot from an existing volume.
view source
 
print?
euca-create-snapshot [-h, --help] [--version] [--debug] volume_id
01 euca-create-snapshot [-h, --help] [--version] [--debug] volume_id
02  
  REQUIRED PARAMETERS
03 REQUIRED PARAMETERS
04  
  volume_id unique id for a volume to snapshot.
05 volume_id unique id for a volume to snapshot.
06  
  OPTIONAL PARAMETERS
07 OPTIONAL PARAMETERS
08  
  -a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10  
  -s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12  
  -U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14  
  --config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17  
  -h, --help Display this help message.
18 -h, --help Display this help message.
19  
  --version Display the version of this tool.
20 --version Display the version of this tool.
21  
  --debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-delete-snapshot
 
===euca-delete-snapshot===


Deletes a snapshot.
Deletes a snapshot.
view source
 
print?
euca-delete-snapshot [-h, --help] [--version] [--debug] snapshot_id
01 euca-delete-snapshot [-h, --help] [--version] [--debug] snapshot_id
02  
  REQUIRED PARAMETERS
03 REQUIRED PARAMETERS
04  
  snapshot_id unique identifier for the snapshot to be deleted.
05 snapshot_id unique identifier for the snapshot to be deleted.
06  
  OPTIONAL PARAMETERS
07 OPTIONAL PARAMETERS
08  
  -a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10  
  -s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12  
  -U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14  
  --config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17  
  -h, --help Display this help message.
18 -h, --help Display this help message.
19  
  --version Display the version of this tool.
20 --version Display the version of this tool.
21  
  --debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-describe-snapshots
 
===euca-describe-snapshots===


Shows information about snapshots.
Shows information about snapshots.
view source
 
print?
euca-describe-snapshots [-h, --help] [--version] [--debug]
01 euca-describe-snapshots [-h, --help] [--version] [--debug]
[snapshot1 snapshot2...snapshotN]
02 [snapshot1 snapshot2...snapshotN]
03
OPTIONAL PARAMETERS
04 OPTIONAL PARAMETERS
05
snapshot1 snapshot2...snapshotN - snapshots to describe.
06 snapshot1 snapshot2...snapshotN - snapshots to describe.
07
-a, --access-key User's Access Key ID.
08 -a, --access-key User's Access Key ID.
09
-s, --secret-key User's Secret Key.
10 -s, --secret-key User's Secret Key.
11
-U, --url URL of the Cloud to connect to.
12 -U, --url URL of the Cloud to connect to.
13
--config Read credentials and cloud settings from the
14 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
15 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16
-h, --help Display this help message.
17 -h, --help Display this help message.
18
--version Display the version of this tool.
19 --version Display the version of this tool.
20
--debug Turn on debugging.
21 --debug Turn on debugging.
 
Network Management
 
euca-allocate-address
==Network Management==
 
===euca-allocate-address===


Allocate a public IP address.
Allocate a public IP address.
view source
 
print?
euca-allocate-address [-h, --help] [--version] [--debug]
01 euca-allocate-address [-h, --help] [--version] [--debug]
02
OPTIONAL PARAMETERS
03 OPTIONAL PARAMETERS
04
-a, --access-key User's Access Key ID.
05 -a, --access-key User's Access Key ID.
06
-s, --secret-key User's Secret Key.
07 -s, --secret-key User's Secret Key.
08
-U, --url URL of the Cloud to connect to.
09 -U, --url URL of the Cloud to connect to.
10
--config Read credentials and cloud settings from the
11 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
12 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
13
-h, --help Display this help message.
14 -h, --help Display this help message.
15
--version Display the version of this tool.
16 --version Display the version of this tool.
17
--debug Turn on debugging.
18 --debug Turn on debugging.
 
euca-associate-address
 
===euca-associate-address===


Associate an instance with a public IP address.
Associate an instance with a public IP address.
view source
 
print?
euca-associate-address -i, --instance instance_id
01 euca-associate-address -i, --instance instance_id
[-h, --help] [--version] [--debug] ip
02 [-h, --help] [--version] [--debug] ip
03
REQUIRED PARAMETERS
04 REQUIRED PARAMETERS
05
-i, --instance unique identifier for a running instance to associate the address with.
06 -i, --instance unique identifier for a running instance to associate the address with.
07
ip IP address to associate.
08 ip IP address to associate.
09
OPTIONAL PARAMETERS
10 OPTIONAL PARAMETERS
11
-a, --access-key user's Access Key ID.
12 -a, --access-key user's Access Key ID.
13
-s, --secret-key user's Secret Key.
14 -s, --secret-key user's Secret Key.
15
-U, --url URL of the Cloud to connect to.
16 -U, --url URL of the Cloud to connect to.
17
-h, --help Display this help message.
18 -h, --help Display this help message.
19
--version Display the version of this tool.
20 --version Display the version of this tool.
21
--debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-describe-addresses
 
===euca-describe-addresses===


Shows information about addresses.
Shows information about addresses.
view source
 
print?
euca-describe-addresses [-h, --help] [--version] [--debug] [ip1 ip2...ipN]
01 euca-describe-addresses [-h, --help] [--version] [--debug] [ip1 ip2...ipN]
02
OPTIONAL PARAMETERS
03 OPTIONAL PARAMETERS
04
ip1 ip2...ipN IP addresses to display information about.
05 ip1 ip2...ipN IP addresses to display information about.
06
-a, --access-key User's Access Key ID.
07 -a, --access-key User's Access Key ID.
08
-s, --secret-key User's Secret Key.
09 -s, --secret-key User's Secret Key.
10
-U, --url URL of the Cloud to connect to.
11 -U, --url URL of the Cloud to connect to.
12
--config Read credentials and cloud settings from the
13 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
14 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
15
-h, --help Display this help message.
16 -h, --help Display this help message.
17
--version Display the version of this tool.
18 --version Display the version of this tool.
19
--debug Turn on debugging.
20 --debug Turn on debugging.
 
euca-disassociate-address
 
===euca-disassociate-address===


Disassociate a public IP address from an instance.
Disassociate a public IP address from an instance.
view source
 
print?
euca-disassociate-address [-h, --help] [--version] [--debug] ip
01 euca-disassociate-address [-h, --help] [--version] [--debug] ip
02
REQUIRED PARAMETERS
03 REQUIRED PARAMETERS
04
ip IP address to disassociate.
05 ip IP address to disassociate.
06
OPTIONAL PARAMETERS
07 OPTIONAL PARAMETERS
08
-a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10
-s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12
-U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14
--config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17
-h, --help Display this help message.
18 -h, --help Display this help message.
19
--version Display the version of this tool.
20 --version Display the version of this tool.
21
--debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-release-address
 
===euca-release-address===


Releases a public IP address.
Releases a public IP address.
view source
 
print?
euca-release-address [-h, --help] [--version] [--debug] ip
01 euca-release-address [-h, --help] [--version] [--debug] ip
02
REQUIRED PARAMETERS
03 REQUIRED PARAMETERS
04
ip The public IP address to release.
05 ip The public IP address to release.
06
OPTIONAL PARAMETERS
07 OPTIONAL PARAMETERS
08
-a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10
-s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12
-U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14
--config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17
-h, --help Display this help message.
18 -h, --help Display this help message.
19
--version Display the version of this tool.
20 --version Display the version of this tool.
21
--debug Turn on debugging.
22 --debug Turn on debugging.
 
Security
 
euca-add-group
==Security==
 
===euca-add-group===


Creates a new security group.
Creates a new security group.
view source
 
print?
euca-add-group -d, --description group_description
01 euca-add-group -d, --description group_description
[-h, --help] [--version] [--debug] group_name
02 [-h, --help] [--version] [--debug] group_name
03
REQUIRED PARAMETERS
04 REQUIRED PARAMETERS
05
-d, --description Description for the group to be created.
06 -d, --description Description for the group to be created.
07
OPTIONAL PARAMETERS
08 OPTIONAL PARAMETERS
09
-a, --access-key User's Access Key ID.
10 -a, --access-key User's Access Key ID.
11
-s, --secret-key User's Secret Key.
12 -s, --secret-key User's Secret Key.
13
-U, --url URL of the Cloud to connect to.
14 -U, --url URL of the Cloud to connect to.
15
--config Read credentials and cloud settings from the
16 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
18
-h, --help Display this help message.
19 -h, --help Display this help message.
20
--version Display the version of this tool.
21 --version Display the version of this tool.
22
--debug Turn on debugging.
23 --debug Turn on debugging.
 
euca-delete-group
 
===euca-delete-group===


Deletes a security group.
Deletes a security group.
view source
 
print?
euca-delete-group [-h, --help] [--version] [--debug] group_name
01 euca-delete-group [-h, --help] [--version] [--debug] group_name
02
REQUIRED PARAMETER
03 REQUIRED PARAMETER
04
group_name unique name for a group to delete.
05 group_name unique name for a group to delete.
06
OPTIONAL PARAMETER
07 OPTIONAL PARAMETER
08
-a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10
-s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12
-U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14
--config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17
-h, --help Display this help message.
18 -h, --help Display this help message.
19
--version Display the version of this tool.
20 --version Display the version of this tool.
21
--debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-describe-groups
 
===euca-describe-groups===


Shows information about groups.
Shows information about groups.
view source
 
print?
euca-describe-groups [-h, --help] [--version] [--debug] [group1 group2...groupN]
01 euca-describe-groups [-h, --help] [--version] [--debug] [group1 group2...groupN]
02
OPTIONAL PARAMETERS
03 OPTIONAL PARAMETERS
04
group1 group2...groupN groups to describe.
05 group1 group2...groupN groups to describe.
06
-a, --access-key User's Access Key ID.
07 -a, --access-key User's Access Key ID.
08
-s, --secret-key User's Secret Key.
09 -s, --secret-key User's Secret Key.
10
-U, --url URL of the Cloud to connect to.
11 -U, --url URL of the Cloud to connect to.
12
--config Read credentials and cloud settings from the
13 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
14 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
15
-h, --help Display this help message.
16 -h, --help Display this help message.
17
--version Display the version of this tool.
18 --version Display the version of this tool.
19
--debug Turn on debugging.
20 --debug Turn on debugging.
 
euca-add-keypair
 
===euca-add-keypair===


Creates a new key pair for use with instances.
Creates a new key pair for use with instances.
view source
 
print?
euca-add-keypair [-h, --help] [--version] [--debug] keypair_name
01 euca-add-keypair [-h, --help] [--version] [--debug] keypair_name
02
REQUIRED PARAMETERS
03 REQUIRED PARAMETERS
04
keypair_name - unique name for a keypair to create.
05 keypair_name - unique name for a keypair to create.
06
OPTIONAL PARAMETERS
07 OPTIONAL PARAMETERS
08
-a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10
-s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12
-U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14
--config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17
-h, --help Display this help message.
18 -h, --help Display this help message.
19
--version Display the version of this tool.
20 --version Display the version of this tool.
21
--debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-delete-keypair
 
===euca-delete-keypair===


Delete a key pair.
Delete a key pair.
view source
 
print?
euca-delete-keypair [-h, --help] [--version] [--debug] keypair_name
01 euca-delete-keypair [-h, --help] [--version] [--debug] keypair_name
02
REQUIRED PARAMETERS
03 REQUIRED PARAMETERS
04
keypair_name unique name for the keypair to delete.
05 keypair_name unique name for the keypair to delete.
06
OPTIONAL PARAMETERS
07 OPTIONAL PARAMETERS
08
-a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10
-s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12
-U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14
--config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17
-h, --help Display this help message.
18 -h, --help Display this help message.
19
--version Display the version of this tool.
20 --version Display the version of this tool.
21
--debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-describe-keypairs
 
===euca-describe-keypairs===


Shows information about keypairs.
Shows information about keypairs.
view source
 
print?
euca-describe-keypairs [-h, --help] [--version] [--debug]
01 euca-describe-keypairs [-h, --help] [--version] [--debug]
[keypair1 keypair2...keypairN]
02 [keypair1 keypair2...keypairN]
03
OPTIONAL PARAMETERS
04 OPTIONAL PARAMETERS
05
keypair1 keypair2...keypairN keypairs to describe.
06 keypair1 keypair2...keypairN keypairs to describe.
07
-a, --access-key User's Access Key ID.
08 -a, --access-key User's Access Key ID.
09
-s, --secret-key User's Secret Key.
10 -s, --secret-key User's Secret Key.
11
-U, --url URL of the Cloud to connect to.
12 -U, --url URL of the Cloud to connect to.
13
--config Read credentials and cloud settings from the
14 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
15 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16
-h, --help Display this help message.
17 -h, --help Display this help message.
18
--version Display the version of this tool.
19 --version Display the version of this tool.
20
--debug Turn on debugging.
21 --debug Turn on debugging.
 
euca-describe-availability-zones
 
===euca-describe-availability-zones===


Shows information about availability zones.
Shows information about availability zones.
view source
 
print?
euca-describe-availability-zones [--region region] [-h, --help] [--version] [--debug] [zone1 zone2...zoneN] [verbose]
01 euca-describe-availability-zones [--region region] [-h, --help] [--version] [--debug] [zone1 zone2...zoneN] [verbose]
02
OPTIONAL PARAMETERS
03 OPTIONAL PARAMETERS
04
--region region to describe availability zones for
05 --region region to describe availability zones for
06
zone1 zone2...zoneN zones to describe.
07 zone1 zone2...zoneN zones to describe.
08
verbose show verbose resource information (Eucalyptus administrator-only functionality).
09 verbose show verbose resource information (Eucalyptus administrator-only functionality).
10
-a, --access-key User's Access Key ID.
11 -a, --access-key User's Access Key ID.
12
-s, --secret-key User's Secret Key.
13 -s, --secret-key User's Secret Key.
14
-U, --url URL of the Cloud to connect to.
15 -U, --url URL of the Cloud to connect to.
16
--config Read credentials and cloud settings from the
17 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
18 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
19
-h, --help Display this help message.
20 -h, --help Display this help message.
21
--version Display the version of this tool.
22 --version Display the version of this tool.
23
--debug Turn on debugging.
24 --debug Turn on debugging.
 
euca-describe-regions
 
===euca-describe-regions===


Shows information about regions.
Shows information about regions.
view source
 
print?
euca-describe-regions [-h, --help] [--version] [--debug]
01 euca-describe-regions [-h, --help] [--version] [--debug]
[region1 region2...regionN]
02 [region1 region2...regionN]
03
OPTIONAL PARAMETERS
04 OPTIONAL PARAMETERS
05
region1 region2...regionN regions to describe.
06 region1 region2...regionN regions to describe.
07
-a, --access-key User's Access Key ID.
08 -a, --access-key User's Access Key ID.
09
-s, --secret-key User's Secret Key.
10 -s, --secret-key User's Secret Key.
11
-U, --url URL of the Cloud to connect to.
12 -U, --url URL of the Cloud to connect to.
13
--config Read credentials and cloud settings from the
14 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
15 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16
-h, --help Display this help message.
17 -h, --help Display this help message.
18
--version Display the version of this tool.
19 --version Display the version of this tool.
20
--debug Turn on debugging.
21 --debug Turn on debugging.
 
euca-get-console-output
 
===euca-get-console-output===


Prints console output from a running instance.
Prints console output from a running instance.
view source
 
print?
euca-get-console-output [-h, --help] [--version] [--debug] instance_id
01 euca-get-console-output [-h, --help] [--version] [--debug] instance_id
02
REQUIRED PARAMETERS
03 REQUIRED PARAMETERS
04
instance_id unique identifier for the instance show the console output for.
05 instance_id unique identifier for the instance show the console output for.
06
OPTIONAL PARAMETERS
07 OPTIONAL PARAMETERS
08
-a, --access-key User's Access Key ID.
09 -a, --access-key User's Access Key ID.
10
-s, --secret-key User's Secret Key.
11 -s, --secret-key User's Secret Key.
12
-U, --url URL of the Cloud to connect to.
13 -U, --url URL of the Cloud to connect to.
14
--config Read credentials and cloud settings from the
15 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
16 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
17
-h, --help Display this help message.
18 -h, --help Display this help message.
19
--version Display the version of this tool.
20 --version Display the version of this tool.
21
--debug Turn on debugging.
22 --debug Turn on debugging.
 
euca-modify-image-attribute
 
===euca-modify-image-attribute===


Modify attributes for an image.
Modify attributes for an image.
view source
 
print?
euca-modify-image-attribute [-l, --launch-permission] [-p, --product-code]
01 euca-modify-image-attribute [-l, --launch-permission] [-p, --product-code]
[-a, --add entity ] [-r, --remove entity]
02 [-a, --add entity ] [-r, --remove entity]
[-h, --help] [--version] [--debug] image_id
03 [-h, --help] [--version] [--debug] image_id
04
REQUIRED PARAMETERS
05 REQUIRED PARAMETERS
06
image_id Unique identifier for the image that you want to modify the attributes for.
07 image_id Unique identifier for the image that you want to modify the attributes for.
08
OPTIONAL PARAMETERS
09 OPTIONAL PARAMETERS
10
-l, --launch-permission Show launch permissions.
11 -l, --launch-permission Show launch permissions.
12
-p, --product-code Show the product codes associated with the image
13 -p, --product-code Show the product codes associated with the image
14
-a, -add Entity (typically, user id) to add.
15 -a, -add Entity (typically, user id) to add.
16
-r, --remove Entity (typically, user id) to remove.
17 -r, --remove Entity (typically, user id) to remove.
18
-A, --access-key User's Access Key ID.
19 -A, --access-key User's Access Key ID.
20
-S, --secret-key User's Secret Key.
21 -S, --secret-key User's Secret Key.
22
-U, --url URL of the Cloud to connect to.
23 -U, --url URL of the Cloud to connect to.
24
--config Read credentials and cloud settings from the
25 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
26 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
27
-h, --help Display this help message.
28 -h, --help Display this help message.
29
--version Display the version of this tool.
30 --version Display the version of this tool.
31
--debug Turn on debugging.
32 --debug Turn on debugging.
 
euca-reset-image-attribute
 
===euca-reset-image-attribute===


Reset attributes for an image.
Reset attributes for an image.
view source
 
print?
euca-reset-image-attribute -l, --launch-permission
01 euca-reset-image-attribute -l, --launch-permission
[-h, --help] [--version] [--debug] image_id
02 [-h, --help] [--version] [--debug] image_id
03
REQUIRED PARAMETERS
04 REQUIRED PARAMETERS
05
-l, --launch-permission show launch permissions.
06 -l, --launch-permission show launch permissions.
07
image_id - unique identifier for the image that you want to reset the attributes for.
08 image_id - unique identifier for the image that you want to reset the attributes for.
09
OPTIONAL PARAMETERS
10 OPTIONAL PARAMETERS
11
-a, --access-key User's Access Key ID.
12 -a, --access-key User's Access Key ID.
13
-s, --secret-key User's Secret Key.
14 -s, --secret-key User's Secret Key.
15
-U, --url URL of the Cloud to connect to.
16 -U, --url URL of the Cloud to connect to.
17
--config Read credentials and cloud settings from the
18 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
19 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
20
-h, --help Display this help message.
21 -h, --help Display this help message.
22
--version Display the version of this tool.
23 --version Display the version of this tool.
24
--debug Turn on debugging.
25 --debug Turn on debugging.
 
euca-revoke
 
===euca-revoke===


Revoke a rule for a security group.
Revoke a rule for a security group.
view source
 
print?
euca-revoke [-P | --protocol protocol] [-p | --port-range port_range]
01 euca-revoke [-P | --protocol protocol] [-p | --port-range port_range]
[-t | --icmp-type-code type:code] [-o | --source-group source_group]
02 [-t | --icmp-type-code type:code] [-o | --source-group source_group]
[-u | --source-group-user source_group_user] [-s | --source-subnet source_subnet]
03 [-u | --source-group-user source_group_user] [-s | --source-subnet source_subnet]
[-h, --help] [--version] [--debug] group_name
04 [-h, --help] [--version] [--debug] group_name
05
REQUIRED PARAMETERS
06 REQUIRED PARAMETERS
07
group_name Name of the group to add the rule to.
08 group_name Name of the group to add the rule to.
09
OPTIONAL PARAMETERS
10 OPTIONAL PARAMETERS
11
-P, --protocol Protocol ("tcp" "udp" or "icmp").
12 -P, --protocol Protocol ("tcp" "udp" or "icmp").
13
-p, --port-range Range of ports for the rule (specified as "from-to").
14 -p, --port-range Range of ports for the rule (specified as "from-to").
15
-t, --icmp-type-code ICMP type and code specified as "type:code"
16 -t, --icmp-type-code ICMP type and code specified as "type:code"
17
-o, --source-group Group from which traffic is authorized by the rule.
18 -o, --source-group Group from which traffic is authorized by the rule.
19
-u, --source-group-user User ID for the source group.
20 -u, --source-group-user User ID for the source group.
21
-s, --source-subnet The source subnet for the rule.
22 -s, --source-subnet The source subnet for the rule.
23
-A, --access-key User's Access Key ID.
24 -A, --access-key User's Access Key ID.
25
-S, --secret-key User's Secret Key.
26 -S, --secret-key User's Secret Key.
27
-U, --url URL of the Cloud to connect to.
28 -U, --url URL of the Cloud to connect to.
29
--config Read credentials and cloud settings from the
30 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
31 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
32
-h, --help Display this help message.
33 -h, --help Display this help message.
34
--version Display the version of this tool.
35 --version Display the version of this tool.
36
--debug Turn on debugging.
37 --debug Turn on debugging.
 
euca-version
 
===euca-version===


Shows the Euca2ools version
Shows the Euca2ools version
view source
 
print?
euca-version [-h, --help] [--debug]
1 euca-version [-h, --help] [--debug]
 
euca-authorize
 
===euca-authorize===


Add a new rule to a security group.
Add a new rule to a security group.
view source
 
print?
euca-authorize [-P, --protocol protocol] [-p, --port-range port_range]
01 euca-authorize [-P, --protocol protocol] [-p, --port-range port_range]
[-t, --icmp-type-code type:code] [-o, --source-group source_group]
02 [-t, --icmp-type-code type:code] [-o, --source-group source_group]
[-u, --source-group-user source_group_user] [-s, --source-subnet source_subnet]
03 [-u, --source-group-user source_group_user] [-s, --source-subnet source_subnet]
[-h, --help] [--version] [--debug] group_name
04 [-h, --help] [--version] [--debug] group_name
05
REQUIRED PARAMETERS
06 REQUIRED PARAMETERS
07
group_name Name of the group to add the rule to.
08 group_name Name of the group to add the rule to.
09
OPTIONAL PARAMETERS
10 OPTIONAL PARAMETERS
11
-P, --protocol Protocol ("tcp" "udp" or "icmp").
12 -P, --protocol Protocol ("tcp" "udp" or "icmp").
13
-p, --port-range Range of ports for the rule (specified as "from-to").
14 -p, --port-range Range of ports for the rule (specified as "from-to").
15
-t, --icmp-type-code ICMP type and code specified as "type:code"
16 -t, --icmp-type-code ICMP type and code specified as "type:code"
17
-o, --source-group Group from which traffic is authorized by the rule.
18 -o, --source-group Group from which traffic is authorized by the rule.
19
-u, --source-group-user User ID for the source group.
20 -u, --source-group-user User ID for the source group.
21
-s, --source-subnet The source subnet for the rule.
22 -s, --source-subnet The source subnet for the rule.
23
-A, --access-key User's Access Key ID.
24 -A, --access-key User's Access Key ID.
25
-S, --secret-key User's Secret Key.
26 -S, --secret-key User's Secret Key.
27
-U, --url URL of the Cloud to connect to.
28 -U, --url URL of the Cloud to connect to.
29
--config Read credentials and cloud settings from the
30 --config Read credentials and cloud settings from the
specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
31 specified config file (defaults to $HOME/.eucarc or /etc/euca2ools/eucarc).
32
-h, --help Display this help message.
33 -h, --help Display this help message.
34
--version Display the version of this tool.
35 --version Display the version of this tool.
36
--debug Turn on debugging.
37 --debug Turn on debugging.
38
Commands Available in UEC and not available in Eucalyptus installations
39 Commands Available in UEC and not available in Eucalyptus installations
 
Uec-publish-tarball
 
view source
===Uec-publish-tarball===
print?
 
01 Usage: uec-publish-tarball [ options ] tarfile bucket [arch]
Usage: uec-publish-tarball [ options ] tarfile bucket [arch]
02
03 register a UEC tarball (ie, per http://uec-images.ubuntu.com)
register a UEC tarball (ie, per http://uec-images.ubuntu.com)
04
05 if arch is not provided, a name-based attempt is made to guess
if arch is not provided, a name-based attempt is made to guess
06 options:
options:
07
08 -k | --kernel  k        use previously registered kernel with id 'k'
-k | --kernel  k        use previously registered kernel with id 'k'
09
10 specify 'none' for no kernel
specify 'none' for no kernel
11
12 -K | --kernel-file f    bundle, upload, use file 'f' as kernel
-K | --kernel-file f    bundle, upload, use file 'f' as kernel
13
14 -r | --ramdisk r        use previously registered ramdisk with id 'r'
-r | --ramdisk r        use previously registered ramdisk with id 'r'
15
16 specify 'none' for no ramdisk
specify 'none' for no ramdisk
17
18 -R | --ramdisk-file f  bundle, upload, use file 'f' as ramdisk
-R | --ramdisk-file f  bundle, upload, use file 'f' as ramdisk
19 --resize  s        resize the image to 's' bundling uploading
--resize  s        resize the image to 's' bundling uploading
20
21 's' must be valid input to uec-resize-image
's' must be valid input to uec-resize-image
22
23 -q | --quiet            be quiet, only output published ids
-q | --quiet            be quiet, only output published ids
24 Example: uec-publish-tarball lucid-uec-i386.tar.gz my-lucid-bucket i386
Example: uec-publish-tarball lucid-uec-i386.tar.gz my-lucid-bucket i386
uec-registration
 
view source
 
print?
===uec-registration===
1 uec-registration [--manual|--auto|--help]
 
2  
uec-registration [--manual|--auto|--help]
3 Options:
 
4
  Options:
5 --manual      Disable automatic component registration
6
  --manual      Disable automatic component registration
7 --auto        Enable automatic component registration
8
  --auto        Enable automatic component registration
9 -h, --help    This message
uec-run-instances
  -h, --help    This message
view source
 
print?
 
1 Same as euca-run-instances
===uec-run-instances===
uec-publish-image
 
view source
Same as euca-run-instances
print?
 
01 Usage: uec-publish-image [ options ] arch image bucket
 
02  
===uec-publish-image===
03 arch          : one of i386 or x86_64
 
04  
Usage: uec-publish-image [ options ] arch image bucket
05 image          : the image to upload and register
06  
  arch          : one of i386 or x86_64
07 bucket        : bucket to publish image to
   
08 options:
image          : the image to upload and register
09
10 l|-add-launch <user_id>  : user_id can be "all", or "none"
  bucket        : bucket to publish image to
11
 
12 --dry-run                : only report what would be done
options:
13
14 --allow-existing        : if a image is already registered
  l|-add-launch <user_id>  : user_id can be "all", or "none"
15
16 simply report as if work was done
  --dry-run                : only report what would be done
17
18 o|-output <file>          : write registered id and manifest to file
  --allow-existing        : if a image is already registered
19 |--rename <publish_path>  : publish to bucket/<publish_path>
20
  simply report as if work was done
21 default: bucket/<basename(image)>
22
  o|-output <file>          : write registered id and manifest to file
23 t|-type  <type>          : type is one of kernel/ramdisk/image
  |--rename <publish_path>  : publish to bucket/<publish_path>
24
25 v|-verbose                : increase verbosity
  default: bucket/<basename(image)>
26 if type is 'image', then:
27
  t|-type  <type>          : type is one of kernel/ramdisk/image
28 -k | --kernel  k        : use previously registered kernel with id 'k'
29
  v|-verbose                : increase verbosity
30 specify 'none' for no kernel
31  
if type is 'image', then:
32 -K | --kernel-file f    : bundle, upload, use file 'f' as kernel
33
  -k | --kernel  k        : use previously registered kernel with id 'k' specify 'none' for no kernel
34 -r | --ramdisk r        : use previously registered ramdisk with id 'r'
   
35
  -K | --kernel-file f    : bundle, upload, use file 'f' as kernel
36 specify 'none' for no ramdisk
37
  -r | --ramdisk r        : use previously registered ramdisk with id 'r' specify 'none' for no ramdisk
38 -R | --ramdisk-file f  : bundle, upload, use file 'f' as ramdisk
39
  -R | --ramdisk-file f  : bundle, upload, use file 'f' as ramdisk
40 -B | --block-device-mapping m : specify block device mapping in bundle
uec-query-builds
  -B | --block-device-mapping m : specify block device mapping in bundle
view source
 
print?
 
01 Usage: uec-query-builds [options]
===uec-query-builds===
02  
 
03 Options:
Usage: uec-query-builds [options]
04 -h, --help show this help message and exit
05 --suite=SUITE suite to query ('hardy', 'karmic', 'lucid')
  Options:
06 --build-name=BUILD_NAME
-h, --help show this help message and exit
07 build name ('server', 'desktop' ..)
--suite=SUITE suite to query ('hardy', 'karmic', 'lucid')
08 --stream=STREAM stream query ('released', 'daily')
--build-name=BUILD_NAME
09 --base-url=BASE_URL the base url to query
build name ('server', 'desktop' ..)
10 --output=FILE write output to file, default is stdout
--stream=STREAM stream query ('released', 'daily')
11 --serial=SERIAL build serial serial to use (YYYYMMDD)
--base-url=BASE_URL the base url to query
12 --system-suite use output of 'lsb_release --codename --short' for
--output=FILE write output to file, default is stdout
13 suite
--serial=SERIAL build serial serial to use (YYYYMMDD)
14 --config=CONFIG yaml config file to read
--system-suite use output of 'lsb_release --codename --short' for suite
15 --region=REGION the ec2 region to query
--config=CONFIG yaml config file to read
16 --img-type=TYPE the ec2 image type (one of: ebs, instance)
--region=REGION the ec2 region to query
17 --arch=ARCH the architecture. (one of: i386, amd64)
--img-type=TYPE the ec2 image type (one of: ebs, instance)
uec-resize-image
--arch=ARCH the architecture. (one of: i386, amd64)
view source
 
print?
===uec-resize-image===
01 Usage: uec-query-builds [options]
 
02  
Usage: uec-query-builds [options]
03 Options:
04 -h, --help show this help message and exit
  Options:
05 --suite=SUITE suite to query ('hardy', 'karmic', 'lucid')
-h, --help show this help message and exit
06 --build-name=BUILD_NAME
--suite=SUITE suite to query ('hardy', 'karmic', 'lucid')
07 build name ('server', 'desktop' ..)
--build-name=BUILD_NAME
08 --stream=STREAM stream query ('released', 'daily')
build name ('server', 'desktop' ..)
09 --base-url=BASE_URL the base url to query
--stream=STREAM stream query ('released', 'daily')
10 --output=FILE write output to file, default is stdout
--base-url=BASE_URL the base url to query
11 --serial=SERIAL build serial serial to use (YYYYMMDD)
--output=FILE write output to file, default is stdout
12 --system-suite use output of 'lsb_release --codename --short' for
--serial=SERIAL build serial serial to use (YYYYMMDD)
13 suite
--system-suite use output of 'lsb_release --codename --short' for suite
14 --config=CONFIG yaml config file to read
--config=CONFIG yaml config file to read
15 --region=REGION the ec2 region to query
--region=REGION the ec2 region to query
16 --img-type=TYPE the ec2 image type (one of: ebs, instance)
--img-type=TYPE the ec2 image type (one of: ebs, instance)
17 --arch=ARCH the architecture. (one of: i386, amd64)
--arch=ARCH the architecture. (one of: i386, amd64)
18 uecadmin@ubuntuclustercontroller:~$ uec-resize-image --help
 
19 Usage: uec-resize-image [ options ] image size [output]
uecadmin@ubuntuclustercontroller:~$ uec-resize-image --help
20 Resize a UEC image to a new size.
 
21 if output is given, do not modify 'image', but create new file 'output'
Usage: uec-resize-image [ options ] image size [output]
22  
Resize a UEC image to a new size.
23 New size is specified per resize2fs(8), e.g. "1G" for 1 gigabyte
if output is given, do not modify 'image', but create new file 'output'
24 options:
25
  New size is specified per resize2fs(8), e.g. "1G" for 1 gigabyte
26 -v | --verbose    show command output
options:
  -v | --verbose    show command output


==Referensi==
==Referensi==

Latest revision as of 03:16, 22 March 2011

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

Referensi


Pranala Menarik