Skip to content

convert.md

Latest commit

 

History

History
112 lines (73 loc) · 2.25 KB

convert.md

File metadata and controls

112 lines (73 loc) · 2.25 KB
title convert
parent Command line
ancestor Image Customizer
nav_order 2

convert subcommand

Converts an image from one format to another without performing any customization or file injection. This is useful for simple format conversion tasks, especially when converting to COSI or bare-metal-image formats.

Usage

imagecustomizer convert \
  --build-dir ./build \
  --image-file input.vhdx \
  --output-image-file output.cosi \
  --output-image-format cosi

Added in v1.2.

--build-dir=DIRECTORY-PATH

Optional. Required for cosi and baremetal-image output formats.

The directory where the tool will place its temporary files, if required.

Added in v1.2.

--image-file=FILE-PATH

Required.

The path to the image to convert.

Supported image formats: vhd, vhd-fixed, vhdx, qcow2, and raw.

Added in v1.2.

--output-image-file=FILE-PATH

Required.

The file path to write the converted image to.

Added in v1.2.

--output-path=FILE-PATH

An alias to --output-image-file.

Added in v1.2.

--output-image-format=FORMAT

Required.

The image format of the output image.

Supported image formats: vhd, vhd-fixed, vhdx, qcow2, raw, cosi, and baremetal-image.

See output.image.format for detailed descriptions of each format.

Added in v1.2.

--cosi-compression-level=LEVEL

Optional. Default: 9

The zstd compression level (1-22) for COSI partition images.

Higher compression levels produce smaller files but take significantly longer to compress. Decompression speed is largely unaffected by the compression level.

Added in v1.2.

Examples

Convert VHDX to COSI

imagecustomizer convert \
  --build-dir ./build \
  --image-file base-image.vhdx \
  --output-image-file converted-image.cosi \
  --output-image-format cosi

Convert QCOW2 to VHD Fixed (for Azure)

imagecustomizer convert \
  --image-file vm-image.qcow2 \
  --output-image-file azure-image.vhd \
  --output-image-format vhd-fixed

Convert with Custom COSI Compression

imagecustomizer convert \
  --build-dir ./build \
  --image-file large-image.raw \
  --output-image-file compressed-image.cosi \
  --output-image-format cosi \
  --cosi-compression-level 15