Chapter 3. Commands

3.1. Connecting to RHEVM

3.1.1. Connect to RHEVM (connect)

The connect command connects to Red Hat Enterprise Virtualization Manager. The URL, user name, certificate authority file, and password for connecting to the Red Hat Enterprise Virtualization Manager can be configured in the .rhevmshellrc file. The connect command uses the parameters in this file to connect to the Manager, so that the user does not need to specify options each time.
Syntax

connect [options]

Note

You do not need to specify additional options if you have configured your user name, password, URL, and certificate authority file in the .rhevmshellrc file.

Table 3.1. Options for connect

Option Description Required
--url The URL to the Red Hat Enterprise Virtualization Manager's REST API. This takes the form of https://[server]/api. Yes
--username The user name and directory service domain of the user attempting access to the Red Hat Enterprise Virtualization Manager. This takes the form of [username]@[domain]. Yes
--password The password for the user attempting access to the Red Hat Enterprise Virtualization Manager. Yes
--key-file The key file for connection via SSL. No
--cert-file The certificate file for connection via SSL. No
--ca-file The certificate authority file for connection via SSL. Yes, unless --insecure is used
--insecure Allow the CLI to connect via SSL without certification. Use this option with caution because it can allow man-in-the-middle (MITM) attackers to spoof the identity of the server. Yes, but only if no certificate authority is provided
--filter Enable filtering based upon user permissions. No
--port The port number for connection to the REST API, if not specified as part of the --url. No
--timeout The timeout period for connection. No

Example 3.1. Example for connect when .rhevmshellrc is not configured

[RHEVM shell (disconnected)]# connect --url "https://rhevm.example.com/api" --username "admin@exampleids.com" --password "p@55w0rd!" --ca-file "/home/user/ca.crt"

 ==========================================
 >>> connected to RHEVM manager 3.5.0.0 <<<
 ==========================================

[RHEVM shell (connected)]#

Note

Instead of specifying the certificate you can use the '--insecure' option to connect without certification, however this is not recommended as it may allow man-in-the-middle (MITM) attackers to spoof the identity of the server.

3.1.2. Disconnect from RHEVM (disconnect)

The disconnect command disconnects from Red Hat Enterprise Virtualization Manager.
Syntax

disconnect

Example 3.2. Example for disconnect

[RHEVM shell (connected)]# disconnect

  =======================================
  >>> disconnected from RHEVM manager <<<
  =======================================

[RHEVM shell (disconnected)]#