Skip to content

Commit 42240f0

Browse files
authored
Merge pull request #63770 from sabrinajess/CNV27495
CNV-27495: new virtctl manifest commands
2 parents 95c46b4 + 06f3d03 commit 42240f0

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

modules/virt-virtctl-commands.adoc

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ If a port number is not specified, the proxy runs on a random port.
144144
[id='vm-volume-export-commands_{context}']
145145
== VM export commands
146146

147-
You use `virtctl vmexport` commands to create, download, or delete a volume exported from a VM, VM snapshot, or persistent volume claim (PVC).
147+
Use `virtctl vmexport` commands to create, download, or delete a volume exported from a VM, VM snapshot, or persistent volume claim (PVC). Certain manifests also contain a header secret, which grants access to the endpoint to import a disk image in a format that {VirtProductName} can use.
148148

149149
.VM export commands
150150
[width="100%",cols="1a,2a",options="header"]
@@ -174,6 +174,24 @@ Optional:
174174

175175
|`virtctl vmexport download <vmexport_name> --<vm\|snapshot\|pvc>=<object_name> --output=<output_file> --volume=<volume_name>`
176176
|Create a `VirtualMachineExport` CR and then download the volume defined in the CR.
177+
178+
|`virtctl vmexport download export --manifest`
179+
|Retrieve the manifest for an existing export. The manifest does not include the header secret.
180+
181+
|`virtctl vmexport download export --manifest --vm=example`
182+
|Create a VM export for a VM example, and retrieve the manifest. The manifest does not include the header secret.
183+
184+
|`virtctl vmexport download export --manifest --snap=example`
185+
|Create a VM export for a VM snapshot example, and retrieve the manifest. The manifest does not include the header secret.
186+
187+
|`virtctl vmexport download export --manifest --include-secret`
188+
|Retrieve the manifest for an existing export. The manifest includes the header secret.
189+
190+
|`virtctl vmexport download export --manifest --manifest-output-format=json`
191+
|Retrieve the manifest for an existing export in json format. The manifest does not include the header secret.
192+
193+
|`virtctl vmexport download export --manifest --include-secret --output=manifest.yaml`
194+
|Retrieve the manifest for an existing export. The manifest includes the header secret and writes it to the file specified.
177195
|===
178196

179197
[id='vm-memory-dump-commands_{context}']

0 commit comments

Comments
 (0)