list-freeipa-image-upgrade-candidates¶

Description¶

Returns the list of available images for FreeIPA upgrade and the currently installed image.

Synopsis¶

  list-freeipa-image-upgrade-candidates
--environment-crn <value>
[--catalog <value>]
[--allow-major-os-upgrade | --no-allow-major-os-upgrade]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-crn (string)

The CRN of the environment.

--catalog (string)

The URL of the source image catalog. If not specified, the catalog of the current image is used.

--allow-major-os-upgrade | --no-allow-major-os-upgrade (boolean)

Allows the upgrade to a subsequent major OS version in the series.

--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¶

candidates -> (array)

The list of candidate images available for upgrade.

item -> (object)

Information about FreeIPA image.

catalog -> (string)

Image catalog URL.

id -> (string)

Virtual machine image ID from ImageCatalog, machines of the cluster will be started from this image.

os -> (string)

OS type of the image, this property is only considered when no specific image ID is provided.

imageName -> (string)

Image name

date -> (string)

Creation date of the image from catalog.

catalogName -> (string)

Image catalog name.

currentImage -> (object)

Information about FreeIPA image.

catalog -> (string)

Image catalog URL.

id -> (string)

Virtual machine image ID from ImageCatalog, machines of the cluster will be started from this image.

os -> (string)

OS type of the image, this property is only considered when no specific image ID is provided.

imageName -> (string)

Image name

date -> (string)

Creation date of the image from catalog.

catalogName -> (string)

Image catalog name.

Form Factors¶

public, private