Red Hat Enterprise Virtualization 3.3

Command Line Shell Guide

A Guide for Installing and Using the Command Line Shell for Red Hat Enterprise Virtualization

Legal Notice

Copyright © 2014 Red Hat.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack Logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.

Abstract

This following guide contains information for installing and using the Red Hat Enterprise Virtualization Manager Command Line Shell
Preface
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. Getting Help and Giving Feedback
2.1. Do You Need Help?
2.2. We Need Feedback!
1. About the Command Line Interface
1.1. Introduction to the Command Line Interface
2. Using the CLI
2.1. Installing the CLI
2.2. TLS/SSL Certification
2.3. Running the CLI
2.4. Interacting with the CLI
2.5. Collections
3. Quick Start Example
3.1. Creating a Basic Virtualization Environment with the CLI
4. Commands
4.1. Connecting to RHEVM
4.1.1. Connect to RHEVM (connect)
4.1.2. Disconnect from RHEVM (disconnect)
4.2. Resources
4.2.1. List Resources in a Collection (list)
4.2.2. Show a Resource (show)
4.2.3. Add a Resource (add)
4.2.4. Update a Resource (update)
4.2.5. Remove a Resource (remove)
4.2.6. Perform Action on a Resource (action)
4.2.7. Using Sub-Resources (--RESOURCE-identifier)
4.3. Other Commands
4.3.1. .rhevmshellrc Configuration
4.3.2. Connect to VM (console)
4.3.3. Run a Shell Command (shell)
4.3.4. Run a Script (file)
4.3.5. Clear the Screen (clear)
4.3.6. Print Input (echo)
4.3.7. Show Last Status (status)
4.3.8. Show CLI Information (info)
4.3.9. Show System Summary (summary)
4.3.10. Test Connection (ping)
4.3.11. Exit from the CLI (exit)
4.3.12. End of File (EOF)
4.3.13. Show Help (help)
5. Resource Types
5.1. brick
5.2. cdrom
5.3. cluster
5.4. datacenter
5.5. disk
5.6. glustervolume
5.7. group
5.8. host
5.9. network
5.10. nic
5.11. permission
5.12. permit
5.13. quotas
5.14. role
5.15. snapshot
5.16. storageconnection
5.17. storagedomain
5.18. tag
5.19. template
5.20. user
5.21. vm
5.22. vmpool
5.23. vnicprofile
6. CLI Queries
6.1. Query Syntax
6.2. Wildcards
A. Revision History