Unresolved directive in <stdin> - include::topics/installation.adoc[]

1. Configuring ManageIQ

Although the ManageIQ appliance comes configured to be integrated immediately into your environment, you can make some changes to its configuration.

The ManageIQ appliance is intended to have minimal configuration options.

1.1. Changing Configuration Settings

The following procedure describes how to make changes to the configuration settings on the ManageIQ appliance.

  1. Start the appliance and open a terminal console.

  2. Log in to the appliance using the SSH key.

  3. Enter the appliance_console command. The ManageIQ appliance summary screen displays.

  4. Press Enter to manually configure settings.

  5. Press the number for the item you want to change, and press Enter. The options for your selection are displayed.

  6. Follow the prompts to make the changes.

  7. Press Enter to accept a setting where applicable.

The ManageIQ appliance console automatically logs out after five minutes of inactivity.

1.2. Advanced Configuration Settings

After logging in, you can use the following menu items for advanced configuration of the appliance:

  • Use Set DHCP Network Configuration to use DHCP to obtain the IP address and network configuration for your ManageIQ appliance. The appliance is initially configured as a DHCP client with bridged networking.

  • Use Set Static Network Configuration if you have a specific IP address and network settings you need to use for the ManageIQ appliance.

  • Use Test Network Configuration to check that name resolution is working correctly.

  • Use Set Hostname to specify a hostname for the ManageIQ appliance.

    A valid fully qualified hostname for the ManageIQ appliance is required for SmartState analysis to work correctly,

  • Use Set Timezone to configure the time zone for the ManageIQ appliance.

  • Use Set Date and Time to configure the date and time for the ManageIQ appliance.

  • Use Restore Database from Backup to restore the Virtual Management Database (VMDB) from a previous backup.

  • Use Setup Database Region to create regions for VMDB replication.

  • Use Configure Database to configure the VMDB. Use this option to configure the database for the appliance after installing and running it for the first time.

  • Use Configure Database Replication to configure a primary or standby server for VMDB replication.

  • Use Configure Database Maintenance to configure the VMDB maintenance schedule.

  • Use Configure Application Database Failover Monitor to start or stop VMDB failover monitoring.

  • Use Extend Temporary Storage to add temporary storage to the appliance. The appliance formats an unpartitioned disk attached to the appliance host and mounts it at /var/www/miq_tmp. The appliance uses this temporary storage directory to perform certain image download functions.

  • Use Configure External Authentication (httpd) to configure authentication through an IPA server.

  • Use Generate Custom Encryption Key to regenerate the encryption key used to encode plain text password.

  • Use Harden Appliance Using SCAP Configuration to apply Security Content Automation Protocol (SCAP) standards to the appliance. You can view these SCAP rules in the /var/www/miq/lib/appliance_console/config/scap_rules.yml file.

  • Use Stop EVM Server Processes to stop all server processes. You may need to do this to perform maintenance.

  • Use Start EVM Server Processes to start the server. You may need to do this after performing maintenance.

  • Use Restart Appliance to restart the ManageIQ appliance. You can either restart the appliance and clear the logs or just restart the appliance.

  • Use Shut Down Appliance to power down the appliance and exit all processes.

  • Use Summary Information to go back to the network summary screen for the ManageIQ appliance.

  • Use Quit to leave the ManageIQ appliance console.

1.3. Configuring a Worker Appliance

You can use multiple appliances to facilitate horizontal scaling, as well as for dividing up work by roles. Accordingly, configure an appliance to handle work for one or many roles, with workers within the appliance carrying out the duties for which they are configured. You can configure a worker appliance through the terminal. The following steps demonstrate how to join a worker appliance to an appliance that already has a region configured with a database.

  1. Start the appliance and open a terminal console.

  2. Log in to the appliance using the SSH key.

  3. Enter the appliance_console command. The ManageIQ appliance summary screen displays.

  4. Press Enter to manually configure settings.

  5. Select 8) Configure Database from the menu.

  6. You are prompted to create or fetch a security key. Select the option to fetch the key from the first ManageIQ appliance. All ManageIQ appliances in a multi-region deployment must use the same key.

  7. Choose 2) External for the database location.

  8. Enter the database hostname or IP address when prompted.

  9. Enter the database name or leave blank for the default (vmdb_production).

  10. Enter the database username or leave blank for the default (root).

  11. Enter the chosen database user’s password.

  12. Confirm the configuration if prompted.

2. Logging In After Installing ManageIQ

Once ManageIQ is installed, you can log in and perform administration tasks.

Log in to ManageIQ for the first time after installing by:

  1. Navigate to the URL for the login screen. (https://xx.xx.xx.xx on the virtual machine instance)

  2. Enter the default credentials (Username: admin | Password: smartvm) for the initial login.

  3. Click Login.

2.1. Changing the Default Login Password

Change your password to ensure more private and secure access to ManageIQ.

  1. Navigate to the URL for the login screen. (https://xx.xx.xx.xx on the virtual machine instance)

  2. Click Update Password beneath the Username and Password text fields.

  3. Enter your current Username and Password in the text fields.

  4. Input a new password in the New Password field.

  5. Repeat your new password in the Verify Password field.

  6. Click Login.

Appendix A: Appendix

A.1. Appliance Console Command-Line Interface (CLI)

Currently, the appliance_console_cli feature is a subset of the full functionality of the appliance_console itself, and covers functions most likely to be scripted using the command-line interface (CLI).

  1. After starting the ManageIQ appliance, log in with a user name of root and the default password of smartvm. This displays the Bash prompt for the root user.

  2. Enter the appliance_console_cli or appliance_console_cli --help command to see a list of options available with the command, or simply enter appliance_console_cli --option <argument> directly to use a specific option.

Table 1. Database Configuration Options



--region (-r)

region number (create a new region in the database - requires database credentials passed)

--internal (-i)

internal database (create a database on the current appliance)


database disk device path (for configuring an internal database)

--hostname (-h)

database hostname


database port (defaults to 5432)

--username (-U)

database username (defaults to root)

--password (-p)

database password

--dbname (-d)

database name (defaults to vmdb_production)

Table 2. v2_key Options



--key (-k)

create a new v2_key

--fetch-key (-K)

fetch the v2_key from the given host

--force_key (-f)

create or fetch the key even if one exists


ssh username for fetching the v2_key (defaults to root)


ssh password for fetching the v2_key

Table 3. IPA Server Options



--host (-H)

set the appliance hostname to the given name

--ipaserver (-e)

IPA server FQDN

--ipaprincipal (-n)

IPA server principal (default: admin)

--ipapassword (-w)

IPA server password

--ipadomain (-o)

IPA server domain (optional). Will be based on the appliance domain name if not specified.

--iparealm (-l)

IPA server realm (optional). Will be based on the domain name of the ipaserver if not specified.

  • In order to configure authentication through an IPA server, in addition to using Configure External Authentication (httpd) in the appliance_console, external authentication can be optionally configured via the appliance_console_cli (command-line interface).

  • Specifying --host will update the hostname of the appliance. If this step was already performed via the appliance_console and the necessary updates made to /etc/hosts if DNS is not properly configured, the --host option can be omitted.

Table 4. Certificate Options



--ca (-c)

CA name used for certmonger (default: ipa)

--internal (-i)

create a database on the current appliance

--postgres-client-cert (-g)

install certs for postgres client


install certs for postgres server


install certs for http server (to create certs/httpd* values for a unique key)

--extauth-opts (-x)

external authentication options

The certificate options augment the functionality of the certmonger tool and enable creating a certificate signing request (CSR), and specifying certmonger the directories to store the keys.

Table 5. Other Options




initialize the given device for temp storage (volume mounted at /var/www/miq_tmp)

--verbose (-v)

print more debugging info

Example Usage
$ ssh root@appliance.test.company.com

To create a new database locally on the server using /dev/sdb:

# appliance_console_cli --internal --dbdisk /dev/sdb --region 0 --password smartvm

To copy the v2_key from a host some.example.com to local machine:

# appliance_console_cli --fetch-key some.example.com --sshlogin root --sshpassword smartvm

You could combine the two to join a region where db.example.com is the appliance hosting the database:

# appliance_console_cli --fetch-key db.example.com --sshlogin root --sshpassword smartvm --hostname db.example.com --password mydatabasepassword

To configure external authentication:

# appliance_console_cli --host appliance.test.company.com
                        --ipaserver ipaserver.test.company.com
                        --ipadomain test.company.com
                        --iparealm TEST.COMPANY.COM
                        --ipaprincipal admin
                        --ipapassword smartvm1

To uninstall external authentication:

# appliance_console_cli  --uninstall-ipa