1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Files
openshift-docs/virt/getting_started/virt-using-the-cli-tools.adoc

55 lines
2.0 KiB
Plaintext

:_mod-docs-content-type: ASSEMBLY
[id="virt-using-the-cli-tools"]
= Using the CLI tools
include::_attributes/common-attributes.adoc[]
:context: virt-using-the-cli-tools
:toclevels: 3
toc::[]
You can manage {VirtProductName} resources by using the `virtctl` command-line tool.
You can access and modify virtual machine (VM) disk images by using the link:https://libguestfs.org[`libguestfs`] command-line tool. You deploy `libguestfs` by using the `virtctl libguestfs` command.
[id="installing-virtctl_virt-using-the-cli-tools"]
== Installing virtctl
To install `virtctl` on {op-system-base-full} 9 or later, Linux, Windows, and MacOS operating systems, you can download and install the `virtctl` binary file.
include::modules/virt-installing-virtctl-binary.adoc[leveloffset=+2]
[id="virtctl-commands_virt-using-the-cli-tools"]
== virtctl commands
The `virtctl` client is a command-line utility for managing {VirtProductName} resources.
[NOTE]
====
The virtual machine (VM) commands also apply to virtual machine instances (VMIs) unless otherwise specified.
====
include::modules/virt-virtctl-information-commands.adoc[leveloffset=+2]
include::modules/virt-vm-information-commands.adoc[leveloffset=+2]
include::modules/virt-vm-manifest-creation-commands.adoc[leveloffset=+2]
include::modules/virt-vm-management-commands.adoc[leveloffset=+2]
include::modules/virt-vm-connection-commands.adoc[leveloffset=+2]
include::modules/virt-vm-export-commands.adoc[leveloffset=+2]
include::modules/virt-hot-plug-and-hot-unplug-commands.adoc[leveloffset=+2]
include::modules/virt-image-upload-commands.adoc[leveloffset=+2]
include::modules/virt-deploying-libguestfs-with-virtctl.adoc[leveloffset=+1]
include::modules/virt-about-libguestfs-tools-virtctl-guestfs.adoc[leveloffset=+2]
[id="using_ansible_{context}"]
== Using Ansible
To use the Ansible collection for {VirtProductName}, see link:https://console.redhat.com/ansible/automation-hub/repo/published/redhat/openshift_virtualization[Red{nbsp}Hat Ansible Automation Hub] ({hybrid-console}).