describe-custom-image¶

Description¶

Retrieves data about a specific image from a given catalog.

Synopsis¶

  describe-custom-image
--catalog-name <value>
--image-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--catalog-name (string)

Image catalog name

--image-id (string)

Image UUID

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

imageId -> (string)

Image UUID

imageDate -> (integer)

Image creation date

imageType -> (string)

Object representing a valid VM image type. FREEIPA - FreeIPA image RUNTIME - Cloudera Runtime image

sourceImageId -> (string)

Customized image UUID

sourceImageDate -> (integer)

Customized image creation date

versions -> (map)

Package versions

key -> (string)

value -> (string)

provider -> (string)

Object representing a valid cloud provider name. AWS - The image is an AWS VM image AZURE - The image is an Azure VM image GCP - The image is a GCP VM image

baseParcelUrl -> (string)

Base parcel URL

vmImages -> (array)

List of images

item -> (object)

Model holding information about a custom VM image and the cloud region it belongs to. The format of the image reference is specific to the cloud provider, e.g. URL in case of Azure, AMI ID in case of AWS.

region -> (string)

Region

imageReference -> (string)

Image reference

Form Factors¶

public