From fde31cc249e89be7bc94d0cbe6362f06fc0977ba Mon Sep 17 00:00:00 2001 From: Lavanya Date: Mon, 8 Nov 2021 12:26:09 -0500 Subject: [PATCH] BZ-1952538 Update virtctl command options Nov 10 BZ-1952538 Update virtctl command options Nov 9 update virtctl details minor edit peer review --- modules/virt-virtctl-commands.adoc | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/modules/virt-virtctl-commands.adoc b/modules/virt-virtctl-commands.adoc index 4bde9c8113..46514ed8df 100644 --- a/modules/virt-virtctl-commands.adoc +++ b/modules/virt-virtctl-commands.adoc @@ -6,16 +6,31 @@ = Virtctl client commands The `virtctl` client is a command-line utility for managing {VirtProductName} -resources. The following table contains the `virtctl` commands used throughout -the {VirtProductName} documentation. +resources. -To view a list of options that you can use with a command, run it with the `-h` or `--help` flag. For example: +To view a list of `virtctl` commands, run the following command: + +[source,terminal] +---- +$ virtctl help +---- + +To view a list of options that you can use with a specific command, run it with the `-h` or `--help` flag. For example: [source,terminal] ---- $ virtctl image-upload -h ---- +To view a list of global command options that you can use with any `virtctl` command, run the following command: + +[source,terminal] +---- +$ virtctl options +---- + +The following table contains the `virtctl` commands used throughout the {VirtProductName} documentation. + .`virtctl` client commands [width="100%",cols="42%,58%",options="header",]