3.3. Other Commands
3.3.1. End of File (EOF)
EOF
command to leave the CLI shell using a Ctrl+D
sequence.
EOF
Example 3.10. Example for EOF
[RHEVM shell (connected)]# EOF
3.3.2. List System Capabilities (capabilities)
capabilties
--features
command to list all version capabilities and new features of the current version.
capabilities
--features
Example 3.11. Example for capabilities
[RHEVM shell (connected)]# capabilities --features name : Search - Case Sensitivity description : Ability to specify whether a search query should ignore case, by providing a URL parameter url-parameters_set-parameter-name : case_sensitive url-parameters_set-parameter-context: matrix url-parameters_set-parameter-type : boolean :
3.3.3. Clear the Screen (clear)
clear
command to clear the CLI screen.
clear
Example 3.12. Example for clear
[RHEVM shell (connected)]# clear
3.3.4. Connect to VM (console)
console
command to open a graphical console to a virtual machine. This command opens either an external VNC or SPICE client based upon the virtual machine's display-type
parameter.
console [vm-id|vm-name]
Example 3.13. Example for console
[RHEVM shell (connected)]# console RHEL6-Server
3.3.5. Print Input (echo)
echo
command to print input to the screen. Use the $out
variable to print the last shell command output.
echo [input]
Example 3.14. Example for echo
[RHEVM shell (connected)]# echo "Example text!"
[RHEVM shell (connected)]# echo $out
3.3.6. Exit from the CLI (exit)
exit
command to leave a CLI.
exit
Example 3.15. Example for exit
[RHEVM shell (connected)]# exit
3.3.7. Run a Script (file)
file
command to run a CLI script file. A script is a plain text file that contains a list of commands for execution.
file [file-location]
Example 3.16. Example for file
[RHEVM shell (connected)]# file /example/example-script
3.3.8. Show Help (help)
help
command displays help for CLI command and resource combinations.
help [command] [resource] [options]
Example 3.17. Examples for help
[RHEVM shell (connected)]# help
add
command:
[RHEVM shell (connected)]# help add
add
command on the vm
resource type:
[RHEVM shell (connected)]# help add vm
3.3.9. Display the User Command History (history)
history
command to display the history of user commands for the CLI shell.
history
Example 3.18. Example for history
[RHEVM shell (connected)]# history
Example 3.19. Example for history --first
--first
n parameter:
[RHEVM shell (connected)]# history --first 5
Example 3.20. Example for history --last
--last
n parameter:
[RHEVM shell (connected)]# history --last 5
3.3.10. Show CLI Information (info)
info
command to display environment connection details and version information.
info
Example 3.21. Example for info
[RHEVM shell (connected)]# info backend version: 3.1 sdk version : 3.1.0.4 cli version : 3.1.0.6 python version : 2.7.3.final.0 entry point : https://www.example.com:8443/ovirt-engine/api
3.3.11. Test Connection (ping)
ping
command tests the connection to your Red Hat Virtualization Manager. The command retrieves a remote resource and ensures the URL, user name and password for the connection are correct.
ping
Example 3.22. Example for ping
[RHEVM shell (connected)]# ping success: RHEVM manager could be reached OK.
3.3.12. Run a Shell Command (shell)
shell
command to run a command from the Linux shell. This command helps with performing file management tasks in conjunction with the Red Hat Virtualization Manager shell.
shell [vm-id|vm-name]
Example 3.23. Examples for shell
[RHEVM shell (connected)]# shell ls
[RHEVM shell (connected)]# shell touch example.txt
[RHEVM shell (connected)]# shell cp example.txt /example-dir/.
Note
shell
using the bang (!
) character. For example:
[RHEVM shell (connected)]# !touch example.txt
3.3.13. Show Last Status (status)
status
command to display the most recently run command status.
status
Example 3.24. Example for status
[RHEVM shell (connected)]# status last command status: 0 (OK)
3.3.14. Show System Summary (summary)
summary
command to display a summary of the system status.
summary
Example 3.25. Example for summary
[RHEVM shell (connected)]# summary hosts-active : 1 hosts-total : 2 storage_domains-active: 2 storage_domains-total : 3 users-active : 1 users-total : 1 vms-active : 1 vms-total : 1