# Copyright (c) 2009-2016 Hewlett Packard Enterprise Development LP
#
# Redistribution and use of this software in source and binary forms,
# with or without modification, are permitted provided that the following
# conditions are met:
#
# Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
from requestbuilder import Arg, Filter, GenericTagFilter
from requestbuilder.exceptions import ArgumentError
import six
from euca2ools.commands.ec2 import EC2Request
class DescribeImages(EC2Request):
DESCRIPTION = ('Show information about images\n\nBy default, only images '
'your account owns and images for which your account has '
'explicit launch permissions are shown.')
ARGS = [Arg('ImageId', metavar='IMAGE', nargs='*',
help='limit results to specific images'),
Arg('-a', '--all', action='store_true', route_to=None,
help='describe all images'),
Arg('-o', '--owner', dest='Owner', metavar='ACCOUNT',
action='append',
help='describe images owned by the specified owner'),
Arg('-x', '--executable-by', dest='ExecutableBy',
metavar='ACCOUNT', action='append',
help='''describe images for which the specified account has
explicit launch permissions''')]
FILTERS = [Filter('architecture', help='CPU architecture'),
Filter('block-device-mapping.delete-on-termination',
help='''whether a volume is deleted upon instance
termination'''),
Filter('block-device-mapping.device-name',
help='device name for a volume mapped to the image'),
Filter('block-device-mapping.snapshot-id',
help='snapshot ID for a volume mapped to the image'),
Filter('block-device-mapping.volume-size',
help='volume size for a volume mapped to the image'),
Filter('block-device-mapping.volume-type',
help='volume type for a volume mapped to the image'),
Filter('description', help='image description'),
Filter('hypervisor', help='image\'s hypervisor type'),
Filter('image-id'),
Filter('image-type',
help='image type ("machine", "kernel", or "ramdisk")'),
Filter('is-public', help='whether the image is public'),
Filter('kernel-id'),
Filter('manifest-location'),
Filter('name'),
Filter('owner-alias', help="image owner's account alias"),
Filter('owner-id', help="image owner's account ID"),
Filter('platform', help='"windows" for Windows images'),
Filter('product-code',
help='product code associated with the image'),
Filter('product-code.type', help='''type of product code
associated with the image ("devpay", "marketplace")'''),
Filter('ramdisk-id'),
Filter('root-device-name'),
Filter('root-device-type',
help='root device type ("ebs" or "instance-store")'),
Filter('state', help='''image state ("available", "pending", or
"failed")'''),
Filter('state-reason-code',
help='reason code for the most recent state change'),
Filter('state-reason-message',
help='message for the most recent state change'),
Filter('tag-key', help='key of a tag assigned to the image'),
Filter('tag-value',
help='value of a tag assigned to the image'),
GenericTagFilter('tag:KEY',
help='specific tag key/value combination'),
Filter('virtualization-type',
help='virtualization type ("paravirtual" or "hvm")')]
LIST_TAGS = ['imagesSet', 'productCodes', 'blockDeviceMapping', 'tagSet']
# noinspection PyExceptionInherit
def configure(self):
EC2Request.configure(self)
if self.args.get('all', False):
if self.args.get('ImageId'):
raise ArgumentError('argument -a/--all: not allowed with '
'a list of images')
if self.args.get('ExecutableBy'):
raise ArgumentError('argument -a/--all: not allowed with '
'argument -x/--executable-by')
if self.args.get('Owner'):
raise ArgumentError('argument -a/--all: not allowed with '
'argument -o/--owner')
def main(self):
if not any(self.args.get(item) for item in ('all', 'ImageId',
'ExecutableBy', 'Owner')):
# Default to owned images and images with explicit launch perms
self.params['Owner'] = ['self']
owned = self.send()
del self.params['Owner']
self.params['ExecutableBy'] = ['self']
executable = self.send()
del self.params['ExecutableBy']
owned['imagesSet'] = (owned.get('imagesSet', []) +
executable.get('imagesSet', []))
return owned
else:
return self.send()
def print_result(self, result):
images = {}
for image in result.get('imagesSet', []):
images.setdefault(image['imageId'], image)
for _, image in sorted(six.iteritems(images)):
self.print_image(image)
def print_image(self, image):
if image.get('rootDeviceType') == 'instance-store':
imagename = image.get('imageLocation')
else:
imagename = '/'.join((image.get('imageOwnerId', ''),
image.get('name')))
print self.tabify((
'IMAGE', image.get('imageId'), imagename,
image.get('imageOwnerAlias') or image.get('imageOwnerId'),
image.get('imageState'),
('public' if image.get('isPublic') == 'true' else 'private'),
image.get('architecture'), image.get('imageType'),
image.get('kernelId'), image.get('ramdiskId'),
image.get('platform'), image.get('rootDeviceType'),
image.get('virtualizationType'), image.get('hypervisor')))
for mapping in image.get('blockDeviceMapping', []):
self.print_blockdevice_mapping(mapping)
for tag in image.get('tagSet', []):
self.print_resource_tag(tag, image.get('imageId'))