Updating virtctl table

Author: apinnick

modules/virt-virtctl-commands.adoc

@@ -8,7 +8,17 @@
 
 The `virtctl` client is a command-line utility for managing {VirtProductName} resources.
 
-.`virtctl` general commands
+Although the examples refer to virtual machines (VMs), you can use these commands with virtual machine instances (VMIs).
+
+// apinnick: I recommend not breaking these sections into separate modules because of maintenance issues.
+// These sections will never be used independently.
+
+[id='virtctl-information-commands_{context}']
+== Virtctl information commands
+
+You use `virtctl` information commands to view information about the `virtctl` client.
+
+.Information commands
 [width="100%",cols="1a,2a",options="header"]
 |===
 |Command |Description
@@ -25,15 +35,31 @@ The `virtctl` client is a command-line utility for managing {VirtProductName} re
 |View a list of global command options for any `virtctl` command.
 |===
 
-// apinnick: I recommend not breaking these sections into separate modules because of maintenance issues.
-// These sections will never be used independently.
+[id='vm-information-commands_{context}']
+== VM information commands
+
+You can use `virtctl` to view information about VMs.
+
+.VM information commands
+[width="100%",cols="1a,2a",options="header"]
+|===
+|Command |Description
+|`virtctl fslist <vm_name>`
+|View the file systems available on a guest machine.
+
+|`virtctl guestosinfo <vm_name>`
+|View information about the operating systems on a guest machine.
+
+|`virtctl userlist <vm_name>`
+|View the logged-in users on a guest machine.
+|===
 
 [id='vm-management-commands_{context}']
-== VM and VMI management commands
+== VM management commands
 
-You can use `virtctl` to manage virtual machine (VM) or virtual machine instance (VMI) states and to migrate a VM.
+You use `virtctl` virtual machine (VM) management commands to manage VMs.
 
-.`virtctl` VM management commands
+.VM management commands
 [width="100%",cols="1a,2a",options="header"]
 |===
 |Command |Description
@@ -49,12 +75,11 @@ You can use `virtctl` to manage virtual machine (VM) or virtual machine instance
 |`virtctl stop <vm_name> --grace-period 0 --force`
 |Force stop a VM. This option might cause data inconsistency or data loss.
 
-|`virtctl pause vm\|vmi <vm_name>`
-|Pause a VM or VMI. The machine state is kept
-in memory.
+|`virtctl pause vm <vm_name>`
+|Pause a VM. The machine state is kept in memory.
 
 |`virtctl unpause vm\|vmi <vm_name>`
-|Unpause a VM or VMI.
+|Unpause a VM.
 
 |`virtctl migrate <vm_name>`
 |Migrate a VM.
@@ -64,40 +89,49 @@ in memory.
 |===
 
 [id='vm-and-vmi-connection-commands_{context}']
-== VM and VMI connection commands
+== VM connection commands
 
-You can use `virtctl` to connect to the serial console, expose a port, set a proxy connection, specify a port, and open a VNC connection to a VM.
+You use `virtctl` connection commands to expose ports and connect to virtual machines (VMs).
 
-.`virtctl console`, `expose`, and `vnc` commands
+.VM connection commands
 [width="100%",cols="1a,2a",options="header"]
 |===
 |Command |Description
-|`virtctl console <vmi_name>`
-|Connect to the serial console of a VMI.
+|`virtctl console <vm_name>`
+|Connect to the serial console of a VM.
 
 |`virtctl expose <vm_name>`
-|Create a service that forwards a designated port of a VM or VMI and expose the service on the specified port of the node.
+|Create a service that forwards a designated port of a VM and expose the service on the specified port of the node.
+
+|`virtctl scp -i <ssh_key> <filename> <vm_username>@<vm_name>`
+|Copy a file from your machine to a VM. The command uses the private key of an SSH key pair. The VM must be configured with its public key.
+
+|`virtctl scp -i <ssh_key> <vm_username@<vm_name>:<filename> .`
+|Copy a file from a VM to your machine. The command uses the private key of an SSH key pair. The VM must be configured with its public key.
 
-|`virtctl vnc --kubeconfig=$KUBECONFIG <vmi_name>`
-|Open a Virtual Network Client (VNC) connection to a VMI.
+|`virtctl ssh -i <ssh_key> <user_name>@<vm_name>`
+|Open an SSH connection with a VM. The command uses the private key of an SSH key pair. The VM must be configured with its public key.
 
-Accessing the graphical console of a VMI through VNC requires a remote viewer on your local machine.
+|`virtctl vnc --kubeconfig=$KUBECONFIG <vm_name>`
+|Connect to the VNC console of a VM.
 
-|`virtctl vnc --kubeconfig=$KUBECONFIG --proxy-only=true <vmi_name>`
+Accessing the graphical console of a VM through VNC requires a remote viewer on your local machine.
+
+|`virtctl vnc --kubeconfig=$KUBECONFIG --proxy-only=true <vm_name>`
 |Display the port number and connect manually to a VMI by using any viewer through the VNC connection.
 
-|`virtctl vnc --kubeconfig=$KUBECONFIG --port=<port-number> <vmi_name>`
+|`virtctl vnc --kubeconfig=$KUBECONFIG --port=<port-number> <vm_name>`
 |Specify a port number to run the proxy on the specified port, if that port is available.
 
 If a port number is not specified, the proxy runs on a random port.
 |===
 
 [id='vm-volume-export-commands_{context}']
-== VM volume export commands
+== VM export commands
 
 You can use `virtctl vmexport` commands to create, download, or delete a volume exported from a VM, VM snapshot, or persistent volume claim (PVC).
 
-.`virtctl vmexport` commands
+.VM export commands
 [width="100%",cols="1a,2a",options="header"]
 |===
 |Command |Description
@@ -158,7 +192,7 @@ $ virtctl vmexport download <vmexport_name> --vm\|pvc=<object_name> \
   --volume=<volume_name> --output=<output_file>
 ----
 
-.`virtctl memory-dump` commands
+.VM memory dump commands
 [width="100%",cols="1a,2a",options="header"]
 |===
 |Command |Description
@@ -190,7 +224,7 @@ This command removes the association between the VM and the PVC, so that the mem
 
 You can use the `virtctl image-upload` commands to upload a VM image to a data volume.
 
-.`virtctl image-upload` commands
+.Image upload commands
 [width="100%",cols="1a,2a",options="header"]
 |===
 |Command |Description
@@ -201,21 +235,3 @@ You can use the `virtctl image-upload` commands to upload a VM image to a data v
 |Upload a VM image to a new data volume of a specified requested size.
 |===
 
-[id='environment-information-commands_{context}']
-== Environment information commands
-
-You can use `virtctl` to view information about versions, file systems, guest operating systems, and logged-in users.
-
-.`virtctl` environment information commands
-[width="100%",cols="1a,2a",options="header"]
-|===
-|Command |Description
-|`virtctl fslist <vmi_name>`
-|View the file systems available on a guest machine.
-
-|`virtctl guestosinfo <vmi_name>`
-|View information about the operating systems on a guest machine.
-
-|`virtctl userlist <vmi_name>`
-|View the logged-in users on a guest machine.
-|===

virt/virt-using-the-cli-tools.adoc

@@ -1,20 +1,19 @@
 :_content-type: ASSEMBLY
 [id="virt-using-the-cli-tools"]
-= Using the CLI tools
+= Using the virtctl and oc tools
 include::_attributes/common-attributes.adoc[]
 :context: virt-using-the-cli-tools
 :toclevels: 3
 
 toc::[]
 
-The two primary CLI tools used for managing resources in the cluster are:
+You use two primary CLI tools used for managing cluster resources:
 
-* The {VirtProductName} `virtctl` client
-* The {product-title} `oc` client
+* {VirtProductName} `virtctl` client
++
+See xref:../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[Installing the `virtctl` client].
 
-== Prerequisites
-
-* You must xref:../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[install the `virtctl` client].
+* {product-title} `oc` client
 
 include::modules/virt-openshift-client-commands.adoc[leveloffset=+1]