3.3. Other Commands

3.3.1. End of File (EOF)

Use the EOF command to leave the CLI shell using a Ctrl+D sequence.
Syntax

EOF

Example 3.10. Example for EOF

Leave the CLI shell: 
[RHEVM shell (connected)]# EOF

3.3.2. List System Capabilities (capabilities)

Use the capabilties --features command to list all version capabilities and new features of the current version.
Syntax

capabilities --features

Example 3.11. Example for capabilities

List system capabilities of the current version: 
[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)

Use the clear command to clear the CLI screen.
Syntax

clear

Example 3.12. Example for clear

Clear the screen: 
[RHEVM shell (connected)]# clear

3.3.4. Connect to VM (console)

Use the 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.
Syntax

console [vm-id|vm-name]

Example 3.13. Example for console

Open graphical console to a virtual machines: 
[RHEVM shell (connected)]# console RHEL6-Server

3.3.6. Exit from the CLI (exit)

Use the exit command to leave a CLI.
Syntax

exit

Example 3.15. Example for exit

Leave the CLI: 
[RHEVM shell (connected)]# exit

3.3.7. Run a Script (file)

Use the file command to run a CLI script file. A script is a plain text file that contains a list of commands for execution.
Syntax

file [file-location]

Example 3.16. Example for file

Run a script file: 
[RHEVM shell (connected)]# file /example/example-script

3.3.8. Show Help (help)

Use the help command displays help for CLI command and resource combinations.
Syntax

help [command] [resource] [options]

Example 3.17. Examples for help

Get CLI help: 
[RHEVM shell (connected)]# help
Get help for the add command: 
[RHEVM shell (connected)]# help add
Get help for the add command on the vm resource type: 
[RHEVM shell (connected)]# help add vm

3.3.9. Display the User Command History (history)

Use the history command to display the history of user commands for the CLI shell.
Syntax

history

Example 3.18. Example for history

Display the user command history: 
[RHEVM shell (connected)]# history

Example 3.19. Example for history --first

Display the first specified entries in the user command history with the --first n parameter: 
[RHEVM shell (connected)]# history --first 5

Example 3.20. Example for history --last

Display the last specified entries in the user command history with the --last n parameter: 
[RHEVM shell (connected)]# history --last 5

3.3.10. Show CLI Information (info)

Use the info command to display environment connection details and version information.
Syntax

info

Example 3.21. Example for info

View CLI information: 
[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/api

3.3.11. Test Connection (ping)

Use the ping command tests the connection to your Red Hat Enterprise Virtualization Manager. The command retrieves a remote resource and ensures the URL, user name and password for the connection are correct.
Syntax

ping

Example 3.22. Example for ping

Test your connection: 
[RHEVM shell (connected)]# ping

success: RHEVM manager could be reached OK.

3.3.12. Run a Shell Command (shell)

Use the shell command to run a command from the Linux shell. This command helps with performing file management tasks in conjunction with the Red Hat Enterprise Virtualization Manager shell.
Syntax

shell [vm-id|vm-name]

Example 3.23. Examples for shell

List files in current working directory: 
[RHEVM shell (connected)]# shell ls
Create a file: 
[RHEVM shell (connected)]# shell touch example.txt
Copy a file: 
[RHEVM shell (connected)]# shell cp example.txt /example-dir/.

Note

The CLI offers an alternative to the shell using the bang (!) character. For example: 
[RHEVM shell (connected)]# !touch example.txt

3.3.13. Show Last Status (status)

Use the status command to display the most recently run command status.
Syntax

status

Example 3.24. Example for status

View the last status: 
[RHEVM shell (connected)]# status

last command status: 0 (OK)

3.3.14. Show System Summary (summary)

Use the summary command to display a summary of the system status.
Syntax

summary

Example 3.25. Example for summary

Display system status: 
[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