- General Configuration
- Settings Overview
- My Settings
- Tasks
- Configuration
- Settings
- Regions
- Region Scope
- Region Settings
- Capacity and Utilization Collection
- Tags
- Company Tag Categories and Tags
- Creating a Tag Category
- Deleting a Tag Category
- Creating a Company Tag
- Deleting a Company Tag
- Importing Tags for Virtual Machines
- Importing Tags for a Virtual Machine from a CSV File
- Importing Custom Values for Virtual Machines and Hosts
- Importing Asset Tags for a Virtual Machine from a CSV File
- Customizing the Help Menu
- Profiles
- Zones
- Servers
- Schedules
- Regions
- Access Control
- Diagnostics
- Region Diagnostics
- Region Aware Server Roles
- Setting the Priority of a Failover Role
- Zone Diagnostics
- Server Diagnostics
- Workers
- Server and Audit Logs
- Collecting Server Logs and Configuration Files
- Setting the Location of the Log Depot for a Specific Server
- Collecting the Current Log Set of a Server
- Collecting All Log Sets from a Server
- Viewing the Server, Audit, and Production Logs
- Viewing the Server Log
- Reloading the Server Log
- Downloading the Server Log
- Viewing the Audit Log
- Reloading the Audit Log
- Downloading the Audit Log
- Viewing the Production Log
- Reloading the Production Log
- Downloading the Production Log
- Database Operations
- Viewing Information on the VMDB
- Database Regions and Replication
- Configuring Database Replication and Centralized Administration
- Backing Up and Restoring a Database
- Performing a Binary Backup and Restoring the Database
- Running Database Garbage Collection
- Changing the Database Password
- Adding a New Appliance to an Existing Region with a Non-default Password
- Configuring Scheduled Database Maintenance
- Creating a Database Dump
- Settings
- SmartProxies
- About
- Default Roles
- EvmRole-super_administrator
- EvmRole-administrator
- EvmRole-approver
- EvmRole-auditor
- EvmRole-desktop
- EvmRole-operator
- EvmRole-security
- EvmRole-support
- EvmRole-user
- EvmRole-user_limited_self_service
- EvmRole-user_self_service
- EvmRole-vm_user
- EvmRole-tenant_administrator
- EvmRole-tenant_quota_administrator
- EvmRole-consumption_administrator
- EvmRole-container_administrator
- EvmRole-container_operator
- EvmRole-reader
General Configuration
Settings Overview
Use the menus located at the top right of the ManageIQ user interface to view or modify the global configuration of your appliance.
Settings
To view or modify global settings for your appliance, click your username to open the settings dropdown menu, and click My Settings to modify. The availability of each menu item depends on the role assigned to your user account. For more information on roles, see Roles.
The following menu items are available from the settings menu:
-
My Settings
This menu is available to all ManageIQ users. The settings in this menu control how elements in the user interface are displayed, time profiles, and tags for the currently logged-in individual user.
-
Tasks
This menu allows you to view virtual machine SmartState Analysis tasks that can be tracked through the console. The status of each task is displayed, including time started, time ended, what part of the task is currently running, and any errors encountered.
Configuration
The Configuration menu is now accessible from the gear icon at the top right corner of the user interface.
This menu allows you to specify enterprise, region, zone, and server settings for your ManageIQ infrastructure. Diagnostics such as logs and the status of processes are also shown here. The Configuration menu is available only to super administrators and administrators.
My Settings
The options under the My Settings menu allow you to configure user interface display options specific to the user account with which you log in to ManageIQ, such as the default view displayed on login, and personal tags. You can also configure the color scheme, and button options on the main dashboard.
These options are available by clicking your username to open the settings menu, then My Settings.
Visual Settings
The options under the Visual menu allow you to configure how user interface elements are displayed in the web user interface. For all options, click Save to update the settings, or click Reset to undo any unsaved changes that have been made on the current screen.
Grid and Tile Icons
This group of settings is used to control the view of your virtual thumbnails. Each thumbnail can be viewed as a single icon or as an icon with four quadrants. Use the quadrant view to see a component’s properties at a glance.
Use the following procedure to change grid and tile icons:
-
From the settings menu, navigate to My Settings, then click on the Visual tab.
-
In Grid/Tile Icons, set items to
ON
to display all four quadrants for the item, orOFF
to display only one icon. -
Click Save.
-
Set Show Infrastructure Provider Quadrants to
ON
to see the four icons in your provider under menu:Compute[Infrastructure > Providers]. -
Set Show Cloud Provider Quadrants to
ON
to see the four icons in your hosts under menu:Cloud[Providers]. -
Set Show Host Quadrants to
ON
to see the four icons in your hosts under menu:Compute[Infrastructure > Hosts]. -
Set Show Datastores Quadrants to
ON
to see the four icons in your datastores under menu:Compute[Infrastructure > Datastores]. -
Set Show VM Quadrants to
ON
to see the four icons in your virtual machines under menu:Compute[Infrastructure > Virtual Machines]. -
Set Show Template Quadrants to
ON
to see the four icons in your templates under menu:Compute[Infrastructure > Virtual Machines > Templates].
Set any of the above options to OFF
to see only one icon instead of
four quadrants.
- Use the Truncate Long Text list to specify how the names of items are displayed if they are too long to show in full. Select the option based on the pattern shown.
Setting Default Items Per Page
Use the following procedure to set the default number of items to display on each resource page.
-
From the settings menu, navigate to My Settings, then click on the Visual tab.
-
In the Default Items Per Page area, select the default number of items to display for each view from the corresponding drop down list.
-
Click Save.
Setting the Start Page
Use the following procedure to set the default start page after logging in. For example, instead of going to the ManageIQ dashboard, you can set the default start page to see a list of your virtual machines.
-
From the settings menu, navigate to My Settings, then click on the Visual tab.
-
In the Start Page area, select the page to display at login.
-
Click Save.
Setting Display Settings
Use the following procedure to set your own themes, colors, and time zone for the console. These settings are specific to the logged-on user.
-
From the settings menu, navigate to My Settings, then click on the Visual tab.
-
Make selections from Display Settings for the following items:
-
Use Chart Theme to select a group of colors and font sizes specifically for charts.
-
Use Time Zone to select the time zone in which to display the console.
Note:
In time zones where clocks are set forward for daylight savings time, the time zone correctly displays as EDT (Eastern Daylight Time) in the console. When the clocks are set back, it correctly displays as EST (Eastern Standard Time).
-
Use Locale to select the language in which to display the console.
-
-
Click Save.
Default Views
The options under the Default Views menu allow you to configure the default layout used to display individual screens in the ManageIQ user interface. The options you select under this menu specify the default options for each screen, but you can also change the layout for each screen using the layout buttons on each screen.
Setting Default Views for the User Interface
Use the following procedure to set general view options:
-
From the settings menu, navigate to My Settings, then click on the Default Views tab.
-
In the General area, click the appropriate button for the way you want to view each type of screen listed. The selected view shows as a blue icon.
-
Click (Grid View) to view virtual thumbnails or icons.
-
Click (Tile View) for a view that combines the virtual thumbnail with some text properties that describe the items.
-
Click (List View) to view a detailed text listing.
-
Click (Expanded View) for an expanded view.
-
Click (Compressed View) for a compressed view.
-
Click (Exists Mode) to view only whether an attribute exists or not.
-
Click Save.
Setting Default Views for Services
Use the following procedure to set default views for services in the menu:Compute[Services] tab.
-
From the settings menu, navigate to My Settings, then click on the Default Views tab.
-
In the Services area, click the appropriate button for the way you want to view each item.
-
Click (Grid View) to view virtual thumbnails or icons.
-
Click (Tile View) for a view that combines the virtual thumbnail with some text properties that describe the items.
-
Click (List View) to view a text listing.
-
-
Click Save.
Setting Default Views for Clouds
Use the following procedure to set default views for clouds in the menu:Compute[Clouds] tab.
-
From the settings menu, navigate to My Settings, then click on the Default Views tab.
-
In the Clouds area, click the appropriate button for the way you want to view each item.
-
Click (Grid View) to view virtual thumbnails or icons.
-
Click (Tile View) for a view that combines the virtual thumbnail with some text properties that describe the items.
-
Click (List View) to view a detailed text listing.
-
-
Click Save.
Setting Default Views for Infrastructure Components
Use the following procedure to set default views for infrastructure components in the menu:Compute[Infrastructure] tab.
-
From the settings menu, navigate to My Settings, then click on the Default Views tab.
-
In the Infrastructure area, click the appropriate button for the way you want to view each item.
-
Click (Grid View) to view virtual thumbnails or icons.
-
Click (Tile View) for a view that combines the virtual thumbnail with some text properties that describe the items.
-
Click (List View) to view a detailed text listing.
-
-
Click Save.
Setting Default Views for Containers
Use the following procedure to set default views for containers in the menu:Compute[Containers] tab.
-
From the settings menu, navigate to My Settings, then click on the Default Views tab.
-
In the Containers area, click the appropriate button for the way you want to view each item.
-
Click (Grid View) to view virtual thumbnails or icons.
-
Click (Tile View) for a view that combines the virtual thumbnail with some text properties that describe the items.
-
Click (List View) to view a text listing.
-
-
Click Save.
Default Filters
The options in the Default Filters menu allow you to configure the default filters displayed for your hosts, virtual machines, and templates. These settings are available to all users.
Setting Default Filters for Cloud
To set default filters for cloud components:
-
From the settings menu, navigate to My Settings, then click on the Default Filters tab.
-
From the Cloud folder, check the boxes for the default filters that you want available. Items that have changed show in blue text.
-
Click Save.
Setting Default Filters for Containers
To set default filters for containers:
-
From the settings menu, navigate to My Settings, then click on the Default Filters tab.
-
From the Containers folder, check the boxes for the default filters that you want available. Items that have changed show in blue text.
-
Click Save.
Setting Default Filters for Infrastructure
To set default filters for infrastructure components:
-
From the settings menu, navigate to My Settings, then click on the Default Filters tab.
-
In the Infrastructure folder, select the default filters that you want available. Items that have changed show in blue text.
-
Click Save.
Setting Default Filters for Physical Infrastructure
To set default filters for physical infrastructure components:
-
From the settings menu, navigate to My Settings, then click on the Default Filters tab.
-
In the Physical Infrastructure folder, select the default filters that you want available. Items that have changed show in blue text.
-
Click Save.
Setting Default Filters for Services
To set default filters for services:
-
From the settings menu, navigate to My Settings, then click on the Default Filters tab.
-
In the Services folder, select the default filters that you want available. Items that have changed show in blue text.
-
Click Save.
Time Profiles
The options under the Time Profiles menu allow you to specify the hours for which data is displayed when viewing capacity and utilization screens. Time profiles are also used to configure performance and trend reports.
Creating a Time Profile
To create a time profile:
-
From the settings menu, navigate to My Settings, then click on the Time Profiles tab.
-
Click (Configuration), and (Add a new Time Profile).
-
Type a meaningful name in the Description field.
-
Select the users who can access the time profile from the Scope list:
-
Select All Users to create a time profile that is available to all users. Only the super administration and administration roles can create, edit, and delete a global profile.
-
Select Current User if this time profile should only be available to the user creating it.
-
-
Check the Days and Hours for the time profile.
-
For Timezone, you can select a specific time zone or, you can let the user select a time zone when displaying data.
-
If you select a specific time zone, you also have the option to Roll Up Daily Performance data. This option is only available to users with the administration or super administration role. Enabling the Roll Up Daily Performance option reduces the time required to process daily capacity and utilization reports and to display daily capacity and utilization charts.
-
Click Add.
Note:
The following relationships exist between time zones and performance reports:
-
The configured time zone in a performance report is used to select rolled up performance data, regardless of the user’s selected time zone.
-
If the configured time zone is null, it defaults to UTC time for performance reports.
-
If there is no time profile with the report’s configured time zone that is also set to roll up capacity and utilization data, the report does not find any records.
For non-performance reports, the user’s time zone is used when displaying dates and times in report rows.
Editing a Time Profile
To edit a time profile:
-
From the settings menu, navigate to My Settings, then click on the Time Profiles tab.
-
Check the time profile you want to edit.
-
Click (Configuration), and (Edit selected Time Profile).
-
Make the required changes.
-
Click Save.
Copying a Time Profile
To copy a time profile:
-
From the settings menu, navigate to My Settings, then click on the Time Profiles tab.
-
Check the time profile you want to copy.
-
Click (Configuration), and (Copy selected Time Profile).
-
Make the required changes.
-
Click Save.
Deleting a Time Profile
To delete a time profile:
-
From the settings menu, navigate to My Settings, then click on the Time Profiles tab.
-
Check the time profile you want to delete.
-
Click (Configuration), and (Delete selected Time Profiles).
-
Click Save.
Tasks
The options under the Tasks menu allow you to view and control currently running tasks in ManageIQ. The status of each task is displayed, including time started, time ended, what part of the task is currently running, and any errors encountered.
My VM and Container Analysis Tasks
The My VM and Container Analysis Tasks menu allows you to view all tasks running on virtual machines and containers for the currently logged-in user.
From the My VM and Container Analysis Tasks menu, you can:
-
See jobs that the logged on user created for the SmartProxy either through a schedule or by manually initiating a SmartState Analysis of a virtual machine or container.
-
See if a job completed successfully, resulted in an error, or is running.
-
See the reason for an error.
-
Filter the tasks by status and state.
-
View the owner or host of the virtual machine or container referenced.
-
Delete a task either explicitly or older than another task.
Filtering the VM and Container Analysis Task List
This procedure describes how to filter the virtual machine and container analysis task list. You can filter the task list by zone, time period, task status, and task state.
To filter the virtual machine and container analysis task list:
-
From the settings menu, select Tasks.
-
Click My VM and Container Analysis Tasks.
-
From the Zone list, select a specific zone, or select <All Zones>.
-
From the 24 Hour Time Period list, select the period of time to view the tasks.
-
For Task Status, select the check boxes next to the status to view.
-
From the Tasks State list, select the state to view.
-
Click Apply.
Deleting a Task from the VM and Container Analysis Task List
To delete a task from the list of virtual machine and container analysis tasks:
-
From the settings menu, select Tasks.
-
Click My VM and Container Analysis Tasks.
-
Select the tasks to delete. From the Delete menu:
-
Click Delete to delete the selected tasks.
-
Click Delete Older to delete the tasks older than the selected tasks.
-
Click Delete All to delete all tasks.
-
-
Click OK.
My Other UI Tasks
The My Other UI Tasks menu allows you to view all tasks running in the user interface for the currently logged-in user.
Filtering the My Other UI Tasks List
This procedure describes how to filter the user interface analysis task list. You can filter the task list by time period, task status, and task state.
To filter the other user interface task list:
-
From the settings menu, select Tasks.
-
Click My Other UI Tasks.
-
From the 24 Hour Time Period list, select the period of time to view the tasks.
-
For Task Status, select the check boxes next to the status to view.
-
From the Tasks State list, select the state to view.
-
Click Apply.
Deleting a My Other UI Task
To delete a task from the list of other user interface tasks:
-
From the settings menu, select Tasks.
-
Click My Other UI Tasks.
-
Select the tasks to delete. From the Delete menu:
-
Click Delete to delete the selected tasks.
-
Click Delete Older to delete the tasks older than the selected tasks.
-
Click Delete All to delete all tasks.
-
-
Click OK.
All VM and Container Analysis Tasks
The All VM and Container Analysis Tasks menu allows you to view all tasks running on virtual machines and containers for all users.
From the All VM and Container Analysis Tasks menu, you can:
-
See jobs that all users have created for the SmartProxy either through a schedule or by manually initiating a SmartState Analysis of a virtual machine or container.
-
See if a job completed successfully, resulted in an error, or is running.
-
See the reason for an error.
-
Filter the tasks by status and state.
-
View the owner or host of the virtual machine or container referenced.
-
Delete a task either explicitly or older than another task.
Filtering the VM and Container Analysis Task List
This procedure describes how to filter virtual machine analysis task lists. You can filter the task list by zone, time period, task status, and task state.
To filter the virtual machine and container analysis task list:
-
From the settings menu, select Tasks.
-
Click All VM and Container Analysis Tasks.
-
From the Zone list, select a specific zone, or select <All Zones>.
-
From the 24 Hour Time Period list, select the period of time to view the tasks.
-
For Task Status, select the check boxes next to the status to view.
-
From the Tasks State list, select the state to view.
-
Click Apply.
Deleting a VM and Container Analysis Task
To delete a task from the list of all virtual machine and container analysis tasks:
-
From the settings menu, select Tasks.
-
Click All VM and Container Analysis Tasks.
-
Select the tasks to delete. From the Delete menu:
-
Click Delete to delete the selected tasks.
-
Click Delete Older to delete the tasks older than the selected tasks.
-
Click Delete All to delete all tasks.
-
-
Click OK.
All Other Tasks
The All Other Tasks menu allows you to view all tasks for all users. This menu is only accessible when you are logged in as the admin user.
Filtering the All Other Tasks List
This procedure describes how to filter the list of all other tasks. You can filter the task list by time period, task status, and task state.
To filter the all other tasks list:
-
From the settings menu, select Tasks.
-
Click All Other Tasks.
-
From the 24 Hour Time Period list, select the period of time to view the tasks.
-
For Task Status, select the check boxes next to the status to view.
-
From the Tasks State list, select the state to view.
-
Click Apply.
Deleting a Task from the All Other Tasks List
To delete a task from the list of all other tasks:
-
From the settings menu, select Tasks.
-
Click All Other Tasks.
-
Select the tasks to delete. From the Delete menu:
-
Click Delete to delete the selected tasks.
-
Click Delete Older to delete the tasks older than the selected tasks.
-
Click Delete All to delete all tasks.
-
-
Click OK.
Configuration
The options under the Configuration menu allow you to configure global options for your ManageIQ environment, view diagnostic information, and view analytics on the servers in the environment. The menu displays the ManageIQ environment at the enterprise, zone, and server levels.
There are four main areas:
-
Settings
This menu allows you to configure global settings for your ManageIQ infrastructure. You can also create analysis profiles and schedules for these profiles.
-
Access Control
This menu contains options for configuring users, groups, roles, and tenants.
-
Diagnostics
This menu displays the status of your servers and their roles and provides access to logs.
-
Database
specify the location of your Virtual Machine Database (VMDB) and its login credentials.
Settings
The options under the Settings area provide a hierarchical view of options that allow you to configure global options for the infrastructure of your ManageIQ environment. At the top level, you have Settings including users, LDAP Groups, account roles, capacity and utilization collection, tag categories, values, and imports, custom variable imports, and license uploads. When you click on Settings and expand it, you can configure Analysis Profiles, Zones, and Schedules.
When you go the Settings accordion, you are automatically taken to the server list under Zones.
Regions
Use Regions for centralizing data which is collected from public and private virtualization environments. A region is ultimately represented as a single database for the VMDB. Regions are particularly useful when multiple geographical locations need to be managed as they enable all the data collection to happen at each particular location and avoid data collection traffic across slow links between networks.
When multiple regions are being used, each with their own unique ID, a master region can be created to centralize the data of all the children regions into a single master database. To do this, configure each child region to replicate its data to the master region database (Red Hat recommends use of region 99). This parent and child region is a one-to-many relationship.
Regions can contain multiple zones, which in turn contain appliances. Zones are used for further segregating network traffic along with enabling failover configurations. Each appliance has the capability to be configured for a number of specialized server roles. These roles are limited to the zone containing the appliance they run on.
Only one failover type of each server role can run in a zone. If multiple appliances have the same failover role, the extras are used as backups that activate only if the primary appliance fails. Non-failover server roles can run on multiple appliances simultaneously in a zone, so resources can be adjusted according to the workload those roles are responsible for.
The following diagram demonstrates an example of the multiple regions working together in a ManageIQ environment.
The Master appliance is located in Chicago and contains a master region and a subregion that manages the worker appliances. The Mahwah technology center contains a single subregion that manages two zones. Likewise the San Diego technology center contains a single subregion managing a single zone.
Note:
-
Replicating a parent region to a higher-level parent is not supported.
-
Parent regions can be configured after the child regions are online.
The following diagram provides a closer look at a region:
In this region, we have several ManageIQ appliances acting as UI nodes and worker nodes. These worker nodes execute tasks on the providers in your environment. The Region also uses a region database that reports to a master database on the main ManageIQ appliance. All appliances can connect to the authentication services (Active Directory, LDAP, Identity Management), outgoing mail (SMTP), and network services (SNMP).
Region Scope
Regions are used to consolidate data from multiple VMDBs to a central database. The database at the top level, the master VMDB, cannot be used for operational tasks such as SmartState Analysis or Capacity and Utilization data collection. It is intended for use as a reporting database that includes all information across multiple subordinate regions. The subordinate regions replicate their information to the master.
Note:
The subordinate regions are not aware of each other from a database perspective. You cannot see information from one subordinate region in another. The only VMDB with data visibility to all subordinate regions is the top level.
Master Regions Scope
-
Reports all information from all subordinate VMDBs reporting up to it.
-
Can perform power operations on virtual machines from subordinate regions.
-
Controls its own access control list.
Subordinate Regions Scope
-
Each subordinate controls its own access control independent of the other regions.
-
Can only do work (such as SmartState Analysis and Capacity and Utilization collection) in its own region.
-
Has no knowledge of the other regions.
-
Replicates its data up to the master region.
Region Settings
In the Region area, set items that apply to your entire ManageIQ infrastructure such as users, LDAP Groups, capacity and utilization collection, company tags and tag categories, and licensing. Regions are also used for database replication.
Capacity and Utilization Collection
Capacity and Utilization Collection Settings
Use C & U Collection Settings to select specifically which clusters and datastores you want to collect usage data for. By selecting a cluster, you are choosing to collect data for all hosts and virtual machines that are part of that cluster. You must also have a server with the Capacity & Utilization Coordinator, Data Collector, and Data Processor roles enabled as well. See Section Server Control Settings.
After a provider has been discovered and its relationships refreshed, view the clusters, hosts, and datastores from the settings menu. Navigate to Configuration, then click on the menu:Settings[Region > C & U Collection] tab.
Enabling a Cluster, Host, or Datastore for Capacity and
Utilization Collection
To enable a cluster, host, or datastore for Capacity and Utilization Collection:
-
Click (Configuration), then click on the Settings accordion.
-
Select Region, then click on the C & U Collection tab.
-
In the Clusters area, check all clusters and hosts that you want to collect data for.
-
In the Datastores area, check all datastores that you want to collect data for.
-
Click Save.
Note:
-
As new clusters, hosts, and datastores are discovered, you will need to come back to this configuration to enable collection of capacity and utilization data unless you have used the Collect for All check boxes.
-
Collect for All Clusters must be checked to be able to collect capacity and utilization data from cloud providers such as Red Hat OpenStack Platform or Amazon EC2.
Tags
Company Tag Categories and Tags
ManageIQ allows you to create your own set of tags and tag categories. Use tags to create a customized, searchable index for your resources. Depending on your database type, your tags may be case sensitive. After creating these values, you can apply them to your resources. There are two kinds of tags.
-
Company tags which you will see under My Company Tags for a resource. Create company tags from the settings menu. Navigate to Configuration, then click the Settings accordion, then menu:Region[My Company Tags]. A selection of company tags is provided to you by default as samples. These can be deleted if you do not need them, but are not recreated by ManageIQ.
-
System tags are assigned automatically by ManageIQ.
Creating a Tag Category
To create a tag category:
-
Click (Configuration).
-
Click on the Settings accordion, then Region, then click on the My Company Categories tab.
-
Click Add under the Actions column to create a new category.
-
In the Category Information area:
-
Use Name to create a short name that refers to category in the VMDB.
Note:
The Name and Single Value fields cannot be changed after the category has been added.
-
Use Description to type a brief explanation of how the category should be used. This shows when you try to add a value to the category.
-
Use Long Description to type a detailed explanation of the category.
-
Set Show in Console to
ON
when the category is ready for use in the console. For example, you want to populate values for the category before exposing it to users. -
Set Single Value to
ON
for categories that can only have a single value assigned to a resource. For example, a virtual machine can only be assigned to one location, but could belong to more than one department. This cannot be changed after the category is created. -
Set Capture C & U Data by Tag to
ON
for the ability to group capacity and utilization data by this tag category. To use this, be sure to assign this tag to all the resources that you want to group by.
-
-
Click Add.
Repeat these steps for each category you need. After you have created the category, you can add values to it.
Deleting a Tag Category
To delete a tag category:
-
Click (Configuration).
-
Click on the Settings accordion, then Region, then click on the My Company Categories tab.
-
Click Delete under the Actions column for the category you want to delete.
-
Click OK to confirm.
Note:
When you delete a tag category, the category values are removed, and any tags from the category are unassigned from all resources.
Creating a Company Tag
To create a company tag:
-
Click (Configuration).
-
Click on the Settings accordion, then Region, then click on the My Company Tags tab.
-
In the Choose a Category area, select a category from the Category list.
Note:
-
Some categories only allow one value to be assigned to a resource.
-
For some databases such as PostgreSQL, tags are case sensitive. For example, filtering by ‘Linux’ in title case give you different results from filtering by ‘linux’ in lower case.
-
-
Click Add under the Actions column, and type a Name and Description for your new value.
-
Click Add once again to add the new entry to the table.
Deleting a Company Tag
To delete a company tag:
-
Click (Configuration).
-
Click on the Settings accordion, then Region, then click on the My Company Tags tab.
-
Click Delete under the Actions column next to the tag to delete it.
Note:
When you delete a tag, the tag is also deleted from any resource to which it was assigned.
-
Click OK to confirm.
Importing Tags for Virtual Machines
You can import a CSV file with tag assignments into the VMDB. For the import to be successful, be aware of the following:
-
The file must be in the following format, with one line for each virtual machine. One virtual machine per tag must be on a separate line even if you are assigning multiple tags of the same category.
-
You must use the display names of the category and the display name for the tag for the import to work.
name,category,entry evm2,Provisioning Scope,All evm2,Exclusions,Do not Analyze evm2,EVM Operations,Analysis Successful rhel6,Department,Presales rhel6,Department,Support
Importing Tags for a Virtual Machine from a CSV File
To import tags for a virtual machine from a CSV file:
-
Make sure the CSV file is in the required format.
-
Click (Configuration).
-
Click on the Settings accordion, then Region, then click on the Import Tags tab.
-
Click Choose file to go to the location where the file is located.
-
Click Upload.
Note:
If there are any problems with the file, such as an incorrect column name, unknown virtual machine, unknown tag, or multiple values for a tag that should have only one, an error message will appear in the console for those records.
-
Click Apply.
Importing Custom Values for Virtual Machines and Hosts
You can import a CSV file with asset tag information into the VMDB for a virtual machine or import custom values for hosts. For the import to be successful, the file must be in the following format, with one line for each virtual machine or host.
-
There are two columns.
-
The first line of the file must have the column names as shown below.
-
The column names are case sensitive.
-
Each value must be separated by a comma.
Virtual Machine Import Example
name,custom_1
Ecommerce,665432
Customer,883452
SQLSrvr,1090430
Firewall,8230500
For virtual machines, the value for custom_1 will show in the VM Summary page as the Custom Identifier page as the Custom Identifier in the Properties area. All of the custom values will show in the Custom Fields area.
Host Import Example
hostname,custom_1,custom_2
esx303.galaxy.local,15557814,19948399
esxd1.galaxy.local,10885574,16416993
esxd2.galaxy.local,16199125,16569419
For hosts, the value for custom_1 will show in the Host Summary page as the Custom Identifier in the Properties area. All of the custom values will show in the Custom Fields area.
Importing Asset Tags for a Virtual Machine from a CSV File
To import asset tags for a virtual machine from a CSV file
-
Make sure the CSV file is in the required format.
-
Click (Configuration).
-
Click on the Settings accordion, then Region, then click on the Import tab.
-
Select the type of custom variable you want to import, either Host or VM.
-
Click Choose file to go to the location where the custom variable file is located.
-
Click Upload.
Note:
If there are any problems with the file, such as an incorrect column name, unknown virtual machine or host, a message appears.
-
Click Apply.
Customizing the Help Menu
ManageIQ allows administrators to customize the help menu. Use this feature to define menu labels, URLs and how each window opens for users.
Note:
Any change to the help menu will take effect upon a full page reload.
Customize the help menu using the following steps:
-
Click (Configuration).
-
Click on the Settings accordion, then Region.
-
Click on the Help Menu tab.
-
Provide custom Menu item labels and an associated URL for each. Define how each window should open by selecting from the options in the Open in menu.
-
Click Submit.
Profiles
Creating an Analysis Profile
You can create an analysis profile by referring to the sample profiles provided in the console. You can copy the sample profile or create a new one.
Creating a Host Analysis Profile
To create a host analysis profile:
-
Click (Configuration).
-
Click on the Settings accordion, then click Analysis Profiles.
-
Click (Configuration), and (Add Host Analysis Profile).
-
In the Basic Information area, type in a Name and Description for the analysis profile.
-
Click File to collect information about a file or group of files.
-
From the File Entry area, click (Click to add a new entry) to add a file or group of files.
- Check Collect Contents to not only check for existence, but also gather the contents of the file. If you do this, then you can use the contents to create policies in ManageIQ Control.
-
Click Event Log to specify event log entries to collect.
-
From the Event Log Entry area, click (Click to add a new entry) to add a type of event log entry. Type in a Name. You can type in a specific message to find in Filter Message. In Level, set the value for the level of the entry and above. Specify the Source for the entry. Finally, set the # number of days that you want to collect event log entries for. If you set this to 0, it will go as far back as there is data available.
-
Click Add.
Creating a Virtual Machine Analysis Profile
To create a virtual machine analysis profile:
-
Click (Configuration).
-
Click on the Settings accordion, then click Analysis Profiles.
-
Click (Configuration), and (Add VM Analysis Profile).
-
In the Basic Information area, type in a Name and Description for the analysis profile.
-
You begin in the Category tab. From the Category Selection area, check the categories you want to collect information for. This is available for virtual machine profiles only.
-
Click the File tab to collect information about a file or group of files.
-
From the File Entry area, click (Add this entry) to add a file or group of files, then type a name. For virtual machines, specify the file to check for. Check the box under Collect Contents if you want to collect the file contents as well. The files can be no larger than 1 MB.
-
Click the Registry tab to collect information on a registry key.
-
From the Registry Entry area, type your Registry Key and Registry Value. To evaluate whether a registry key exists or does not exist on a virtual machine, without providing a value, type * in the Registry Value field. Then, you do not need to know the registry value to collect the keys. This is available for virtual machine profiles only.
-
Click Event Log to specify event log entries to collect.
-
From the Event Log Entry area, complete the fields to add a type of event log entry. You can type in a specific message to find in Filter Message. In Level, set the value for the level of the entry and above. Specify the Source for the entry. Finally, set the # (number) of days that you want to collect event log entries for. If you set this to 0, it will go as far back as there is data available.
-
Click Add.
Editing an Analysis Profile
To edit an analysis profile:
-
Click (Configuration).
-
Click on the Settings accordion, then click Analysis Profiles.
-
Check the analysis profile you want to edit.
-
Click (Edit the selected Analysis Profiles).
-
Make any changes.
-
Click Save.
The changes are added to the analysis profile. The virtual machines or hosts must be re-analyzed to collect the new or modified information.
Copying an Analysis Profile
To copy an analysis profile:
-
Click (Configuration).
-
Click on the Settings accordion, then click Analysis Profiles.
-
Check the analysis profile you want to copy.
-
Click (Copy the selected Analysis Profiles).
-
Type a new Name and Description.
-
Make required changes.
-
Click Add.
Setting a Default Analysis Profile
If you want to set an analysis profile to be used for all virtual machines, you can create a default profile.
To create a default analysis profile:
-
Click (Configuration).
-
Click on the Settings accordion, then click Analysis Profiles.
-
Click on the analysis profile you want to set as the default.
-
Click (Edit the selected Analysis Profile).
-
For a virtual machine profile, enter
default
in lower case in Name. For a host profile, enter host default. -
Click Save.
Zones
You can organize your ManageIQ Infrastructure into zones to configure failover and isolate traffic. A provider that is discovered by a server in a specific zone gets monitored and managed in that zone. All jobs, such as a SmartState Analysis or VM power operation, dispatched by a server in a specific zone can get processed by any ManageIQ appliance assigned to that same zone.
Zones can be created based on your own environment. You can make zones based on geographic location, network location, or function. When first started, a new server is put into the default zone.
Suppose you have four ManageIQ appliances with two in the East zone, appliances A and B, and two in the West zone, appliances C and D. VC East is discovered by one of the ManageIQ appliances in the ManageIQ Eastern zone. If Appliance A dispatches a job of analyzing twenty virtual machines, this job can be processed by either Appliance A or B, but not C or D.
Note:
Only users assigned the super administrator role can create zones. There must always be at least one zone. The Default Zone is provided and cannot be deleted.
Creating a Zone
To create a zone:
-
Click (Configuration).
-
Click on the Settings accordion, then click Zones.
-
Click (Configuration), and (Add a new Zone) to create a zone.
-
In the Zone Information area, type in a Name and Description for the new zone.
-
Use SmartProxy Server IP to specify the IP address of the server that you want SmartProxies installed in this zone to report to. If this is not set, then the IP address of the server that deployed the SmartProxy is used. This does not apply to embedded SmartProxies.
-
Optionally, you can configure NTP servers for the entire zone in the NTP Servers area. These settings will be used if the NTP servers have not been set for the appliance in the menu:Operations[Server] page.
-
In the menu:Credentials[Windows Domain] area, type in Windows domain credentials to be able to collect running processes from Windows virtual machines that are on a domain.
-
In the Settings area, set the number for Max Active VM Scans. The default is
Unlimited
. -
Click Save.
Deleting a Zone
To delete a zone:
-
Click (Configuration).
-
Click on the Settings accordion, then click Zones.
-
Click the zone you want to remove.
Note:
You cannot delete a zone if there are servers assigned to it.
-
Click (Configuration), then click (Delete this Zone).
-
Click OK to confirm.
Editing a Zone
To edit a zone:
-
Click (Configuration).
-
Click on the Settings accordion, then click Zones.
-
Click the zone you want to edit.
-
Click (Configuration), then click (Edit this Zone).
-
Make the required changes.
-
Click Save.
Adding SmartProxy Affinity to a Zone:
Enable SmartProxy Affinity for zones containing servers with the SmartProxy role to run a SmartState Analysis.
To add SmartProxy Affinity to a zone:
-
Click (Configuration).
-
Click on the Settings accordion, then click Zones.
-
Click the zone in which you want to enable SmartProxy Affinity.
-
Click the SmartProxy Affinity tab and click the appropriate server.
-
Click Save.
Servers
Server settings enables you to control how each ManageIQ server operates including authentication, logging, and email. If you have multiple servers in your environment that are reporting to one central VMDB, then you can edit some of these settings from the console by specifying which server you want to change.
Note:
The server selection options are only available if you have multiple servers sharing one VMDB.
Changing Server Settings
To change server settings:
-
Click (Configuration).
-
Click on the Settings accordion, then click Zones.
-
Click the zone where the ManageIQ server is located.
-
In the Servers area, click on the ManageIQ server.
-
Click Server.
-
Make any required changes.
-
Click Save.
Basic Information Settings
-
Use Company Name (maximum 20 characters) to customize the interface with your company’s name. You will see the company name when you are viewing or modifying the tags of an infrastructure object or virtual machine.
-
Specify the Appliance Name (maximum 20 characters) you want displayed as the appliance that you are logged into. You will see this in the upper right corner of the interface with the name of the consoles logged on user.
-
Use Zone to isolate traffic and provide load balancing capabilities. Specify the zone that you want this ManageIQ appliance to be a member of. At startup, the zone is set to default.
-
Use Appliance Time Zone to set the time zone for this server.
Note:
This is the time zone used when created scheduled analyses. This is not the same as the Time Zone parameter, which is found by navigating to the settings menu, then My Settings, then exploring the Display Settings area, and is the time zone displayed in the console.
-
Use Default Locale to specify the default language for this server.
Server Control Settings
A server role defines what a server can do. Red Hat recommends that Database Operations, Event Monitor, Reporting, Scheduler, SmartState Analysis, User Interface, Provider Inventory, Provider Operations, and Web Services be enabled on at least one server in each zone. These roles are enabled by default on all servers.
- Use Default Repository SmartProxy to set the SmartProxy from which you refresh your virtual machine repositories. This host must have access to your repositories to analyze its virtual machines.
Note:
-
Only super administrators can change server roles.
-
If you are using more than one ManageIQ appliance, be sure to set this on all of the appliances.
Server Roles
Note:
-
Server roles that are in an active/active high availability configuration (load balancing and failover protection) are active in more than one location; whereas, roles that are in an active/passive (primary/secondary in the case of ManageIQ) high availability configuration (failover protection), if more than one ManageIQ server in a specific zone or region has this role, only one will be active (primary) at a time and a failover has to occur to the passive (secondary) appliance with that role.
-
For information on region and zone diagnostics and server role priorities, see Diagnostics.
| Server Role | Description | Zone or Region Aware | Primary/Secondary or Active/Active |
|---|---|---|---|
| Automation Engine | Use this role if you want to use this ManageIQ server to process automation tasks. | N/A | Active/Active |
| Capacity and Utilization Coordinator | The Capacity & Utilization Coordinator role checks to see if it is time to collect data, somewhat like a scheduler. If it is time, a job is queued for the Capacity and Utilization Data Collector. The coordinator role is required to complete Capacity and Utilization data collection. If more than one ManageIQ server in a specific zone has this role, only one will be active at a time. | Zone | Primary/Secondary |
| Capacity & Utilization Data Collector | The Capacity & Utilization Data Collector performs the actual collection of capacity and utilization data. This role has a dedicated worker, and there can be more than one ManageIQ server with this role in a zone. | Zone | Active/Active |
| Capacity & Utilization Data Processor | The Capacity & Utilization Data Processor processes all of the data collected, allowing ManageIQ to create charts. This role has a dedicated worker, and there can be more than one ManageIQ server with this role in a zone. | Zone | Active/Active |
| Database Operations | Use Database Operations to enable this ManageIQ server to run database backups or garbage collection. | Zone | Active/Active |
| Embedded Ansible | This role is disabled by default. The Embedded Ansible role supports Ansible Automation Inside functionality. Enable this role to configure playbook repositories and run playbooks natively to back service catalog items. NOTE: Enable the Provider Inventory server role in the same zone as the Embedded Ansible server role to ensure proper functionality. | Region | Primary/Secondary |
| Event Monitor | This role is enabled by default and provides the information shown in timelines. The Event Monitor is responsible for the work between the ManageIQ server and your providers. It starts 2 workers for each provider. One worker, the monitor, is responsible for maintaining a connection to a provider, catching events, and putting them on the ManageIQ message queue for processing. The second worker, the handler, is a message queue worker responsible for delivering only those messages for a provider. You should have at least one of these in each zone. | Zone | Primary/Secondary |
| Git Repository | The Git Repositories Owner server role supports importing domains into automate from a git repository. This feature is available from the Automate > Import/Export screen in the ManageIQ user interface. | Region | Primary/Secondary |
| Notifier | Use this role if you will be using ManageIQ Control or Automate to forward SNMP traps to a monitoring system or send e-mails. See Creating an Alert for details on creating SNMP alerts. If more than one ManageIQ server in a specific region has this role, only one will be active at a time. | Region | Primary/Secondary |
| Provider Inventory | This role is enabled by default. This role is responsible for refreshing provider information including EMS, hosts, virtual machines, and clusters, and is also responsible for capturing datastore file lists. If more than one ManageIQ server in a specific zone has this role, only one will be active at a time. Required in the same zone as a ManageIQ appliance with the Embedded Ansible role enabled. | Zone | Primary/Secondary |
| Provider Operations | This role is enabled by default. This role sends stop, start, suspend, shutdown guest, clone, reconfigure, and unregister to the provider, directly from the console or through a policy action if you have ManageIQ Control. More than one ManageIQ server can have this role in a zone. | Zone | Active/Active |
| RHN Mirror | An appliance with RHN Mirror enabled acts as a server containing a repository with the latest ManageIQ packages. This also configures other appliances within the same region to point to the chosen RHN Mirror server for updates. This provides a low bandwidth method to update environments with multiple appliances. | N/A | Active/Active |
| Reporting | This role is enabled by default. The Reporting role specifies which ManageIQ servers can generate reports. If you do not have a ManageIQ server set to this role in a zone, then no reports can be generated in that zone. You should have at least one of these in each zone. | Zone | Active/Active |
| Scheduler | This role is enabled by default. The Scheduler sends messages to start all scheduled activities such as report generation and SmartState analysis. This role also controls all system schedules such as capacity and utilization data gathering. One server in each region must be assigned this role or scheduled ManageIQ events will not occur. If more than one ManageIQ server in a specific region has this role, only one will be active at a time. | Region | Primary/Secondary |
| SmartProxy | Enabling the SmartProxy role turns on the embedded SmartProxy on the ManageIQ server. The embedded SmartProxy can analyze virtual machines that are registered to a host and templates that are associated with a provider. To provide visibility to repositories, install the SmartProxy on a host from the ManageIQ console. This SmartProxy can also analyze virtual machines on the host on which it is installed. Enabling the SmartProxy role on an appliance requires selecting the SmartProxy Affinity for a zone to run a SmartState Analysis. By default, no selections are enabled under SmartProxy Affinity. | Zone | Active/Active |
| SmartState Analysis | This role is enabled by default. The SmartState Analysis role controls which ManageIQ servers can control SmartState Analyses and process the data from the analysis. You should have at least one of these in each zone. | Zone | Active/Active |
| User Interface | This role is enabled by default. The Web Services role must also be enabled with this role to log into the user interface, as the User Interface role queries the API to receive tokens for login. Uncheck User Interface if you do not want users to be able to access this ManageIQ server using the ManageIQ console. For example, you may want to turn this off if the ManageIQ server is strictly being used for capacity and utilization or reporting generation. More than one ManageIQ server can have this role in a zone. | Zone | Active/Active |
| Web Services | This role is enabled by default. The Web Services roles provides API access and must be enabled if the User Interface role is enabled to log into the user interface. You can also enable the Web Services role to provide API-only access to the server. Uncheck Web Services to stop this ManageIQ server from acting as a web service provider. More than one ManageIQ server can have this role in a zone. | N/A | Active/Active |
| Websocket | This role enables starting or stopping websocket workers required for proxying remote consoles. | N/A | Active/Active |
VMware Console Settings
If you are using the ManageIQ control feature set, then you have the ability to connect to a Web console for virtual machines that are registered to a host. To use this feature, you must have VNC installed, VMware’s WebMKS SDK enabled in ManageIQ, or the VMRC native desktop application installed for your environment.
Note:
See vendor documentation to ensure you are installing appropriate applications for your virtual infrastructure. Once you have installed the required software, you must specify its version in the ManageIQ configuration settings.
-
If you select VNC, type in the port number used. This port must be open on the target virtual machine and the VNC software must be installed there. On the computer that you are running the console from, you must install the appropriate version of Java Runtime if it is not already installed.
-
If you select VMware WebMKS, select the appropriate version.
-
If using VMware VMRC desktop application, be sure that you have fulfilled the requirements for your vCenter version. The correct version of the VMRC desktop application from VMware must be installed on the client computer. To do this, log into the vCenter Web Service and attempt to open a virtual machine console. The vSphere Web Client must be installed on vCenter version 5, and the provider must be registered to it. For vCenter version 4, the VMware vCenter Management Webservices must be running.
NTP Servers Settings In the NTP Servers area, you can
specify the NTP servers to use as source for clock synchronization here. The NTP settings specified here will override Zone NTP settings. Enter one NTP server hostname or IP address in each text box.
Configuring SNMP
You can use Simple Network Management Protocol (SNMP) traps to send alerts for various aspects of a ManageIQ environment.
Requirements
-
Configure your SNMP management station to accept traps from ManageIQ appliances. Consult your management station’s documentation.
-
Each appliance that could process SNMP traps must have the
snmpd
andsnmptrapd
daemons running. -
The region where the appliances are located must have the
Notifier
role enabled and the failover role priority set.
To enable the snmpd
and snmptrapd
daemons
-
Access each SNMP processing appliance using SSH.
-
Set the SNMP daemons to run on start up:
# chkconfig --level 2345 snmpd on # chkconfig --level 2345 snmptrapd on
-
The daemons run automatically when the appliance is restarted, but must be started manually now.
# service snmpd start # service snmptrapd start
To enable the notifier role:
-
Access each SNMP processing appliance using their web interfaces
-
Click Configuration, then click Settings.
-
Select the zone where the EVM server is located, and select the EVM server.
-
In the Server Control area, set the Notifier server role option to
ON
. -
Click Save.
To set the failover priority role:
-
From the settings menu, select . Click Configuration, then click Diagnostics.
-
Select the zone where the EVM server is located.
-
Click Roles by Servers or Servers by Roles to view your servers.
-
In the Status of Roles for Servers in Zone Default Zone area, click the role that you want to set the priority for.
-
Click (Configuration), and (Promote Server) to make this the primary server for this role.
Outgoing SMTP Email Settings
To use the email action in ManageIQ, set an email address to send emails from.
Note:
To be able to send any emails from the server, you must have the Notifier server role enabled. You can test the settings without the role enabled.
-
Use Host to specify the host name of the mail server.
-
Use Port to specify the port for the mail server.
-
Use Domain to specify the domain name for the mail server.
-
Set Start TLS Automatically on
ON
if the mail server requires TLS. -
Select the appropriate SSL Verify Mode.
-
Use the Authentication drop down to specify if you want to use
login
,plain
, or no authentication. -
Use User Name to specify the user name required for login authentication.
-
Use Password to specify the password for login authentication.
-
Use From E-mail Address to set the address you want to send the email from.
-
Use Test E-mail Address if you want to test your email settings. Click Verify to send a test email.
Web Services Settings
Web services are used by the server to communicate with the SmartProxy.
-
Set Mode to invoke to enable 2-way Web services communication between the ManageIQ appliance and the SmartProxy. Set Mode to disabled to use Web services from the SmartProxy to the ManageIQ appliance only. When the ManageIQ appliance has work for the SmartProxy, the work will be placed in a queue in the VMDB. The work will be completed either when the ManageIQ appliance is able to contact the SmartProxy or when the next SmartProxy heartbeat occurs, whichever comes first.
-
If Web Services are enabled, you have the option to use ws-security.
Logging Settings
- Use Log Level to set the level of detail you want in the log. You can select from fatal, error, warn, info, and debug. The default setting is ‘info’.
Custom Support URL Settings
-
Use URL to specify a specific URL that you want to be accessible from the About Product Assistance area.
-
Use Description to set a label for the URL.
Authentication
Use the Authentication tab to specify how you want users authenticated on the console. You can use the VMDB or integrate with LDAP, LDAPS, Amazon, or an external IPA server.
Changing Authentication Settings
To change authentication settings:
-
Click (Configuration).
-
Click the Settings accordion, then click Zones.
-
Click the zone where the server is located.
-
Click the server.
-
Click the Authentication tab.
-
Use Session Timeout to set the period of inactivity before a user is logged out of the console.
-
Set the authentication method in Mode.
-
Click Save.
Workers
Use the Workers page to specify the number of workers and amount of memory allowed to be used for each type.
Note:
Only make these changes when directed to by Red Hat Support.
Changing Settings for a Worker
To change the settings for a worker
-
Click (Configuration).
-
Click on the Settings accordion, then click Zones.
-
Click the zone where the server is located.
-
Click on the server.
-
Click Workers.
-
Go to the type of worker you have been directed to change.
-
If applicable, change Count or Memory Threshold using the dropdown boxes.
-
Click Save.
Database
Use the Database page to specify the location of your Virtual Machine Database (VMDB) and its login credentials. By default, the type is PostgreSQL on the Server.
Note:
The server may not start if the database settings are changed. Be sure to validate your new settings before restarting the server.
Changing a Database Setting
To change a database setting:
-
Click (Configuration).
-
Click on the Settings accordion, then click Zones.
-
Click the zone where the server is located.
-
Click on the server.
-
Click the Database tab.
-
In the Database area, select the Type of database. You can select from External Database on another CFME appliance, External Postgres Database, and Internal Database on this CFME Appliance.
-
Use Hostname to specify the IP address or hostname of the external database server.
-
Use Database Name to specify the name of your VMDB.
-
Specify the User Name to connect to the VMDB.
-
Use Password and Verify Password to specify the password for the user name.
-
-
Click Validate to check the settings.
-
Click Save.
-
Click OK to the warning that the server will restart immediately after you save the changes.
During the restart, you are unable to access the server. When the restart is complete, the new database settings are in effect.
Customization and Logos
Custom Logos
Use Custom Logos to display your own logo in the corner of the ManageIQ user interface and on the login screen. Use the procedures below to upload a custom logo to the user interface, and to customize the login background and login panel text on the user interface.
Note:
-
If you have upgraded from an earlier ManageIQ version and your custom logo was already in use before migration, although your logo image file is still in place in
vmdb/public/upload
you may have to uncheck and recheck the option to Use Custom Logo Image to re-enable displaying your custom logo. See simpara_title for the procedure on how to access the Use Custom Logo Image option, or if you want to upload another custom logo to the user interface and customize the login background image and login panel text. -
Additionally, ensure the option to use configuration settings for the tenant under Access Control is set to
Yes
; see simpara_title for the procedure on how to set the configuration settings.
Uploading a Custom Logo to the User Interface
Note:
Make sure the desired logo is accessible from the computer where you are running the ManageIQ user interface. The file must be in portable network graphics (png) format with dimensions of 350 px x 70 px.
To upload a custom logo to the user interface:
-
Click (Configuration).
-
Click on the Settings accordion, then click Zones.
-
Click the zone where the ManageIQ server is located.
-
Click on the server.
-
Click the Custom Logos tab.
-
In Custom Logo Image (Shown on top right of all screens), click Choose file to go to the location where the logo file is located.
-
Click Upload. The icon is displayed above the file name box, and an option is shown to use the logo.
-
Check Use Custom Logo Image to add the logo to your user interface.
-
Click Save.
Note:
To enable displaying your custom logo, ensure the option to use
configuration settings for the tenant under Access Control is set to
Yes
. See simpara_title for the procedure
on how to set the configuration settings.
Customizing the Login Background
Note:
Make sure the background image that you want to use is accessible from the computer where you are running the user interface. The file must be in PNG format with dimensions of 1280 px x 1000 px.
To customize the login background:
-
Click (Configuration).
-
Click on the Settings accordion, then click Zones.
-
Click the zone where the server is located.
-
Click on the server.
-
Click the Custom Logos tab.
-
In Custom Login & ‘About’ Screen Background Image, click Choose file to go to the location where the background image file is located.
-
Click Upload. The icon is displayed above the file name box, and an option is shown to use the logo.
-
Check Use Custom Login Background Image to add the background image to the login screen of the user interface.
-
Click Save.
Customizing the Login Panel Text
To customize the login panel text:
-
Click (Configuration).
-
Navigate to menu:Settings[Configuration].
-
Click on the Settings accordion, then click Zones.
-
Click the zone where the server is located.
-
Click on the server.
-
Click the Custom Logos tab.
-
In Custom Login Panel Text, enter the text that you want to display on the login screen.
-
Click Use Custom Login Text to switch it to
Yes
. -
Click Save.
Displaying the Custom Configuration Settings
To enable displaying your custom logo in the corner of the ManageIQ user interface and on the login screen:
-
Click (Configuration).
-
Click the Access Control accordion.
-
Click Tenants, then click My Company.
-
Click (Configuration), then click (Edit this item).
-
Click Use Configuration Settings to switch it to
Yes
. -
Click Save.
Advanced Settings
You may be instructed by Red Hat to edit some configuration settings manually. This feature is available for a limited number of options and can only be used by users assigned the super administrator role. Changing settings using this procedure may disable your ManageIQ server.
Editing Configuration Files Manually
To edit configuration files manually:
-
Click Configuration.
-
Click on the Settings accordion, then click Zones.
-
Click the zone where the server is located.
-
You can click the Advanced tab at the zone level to set advanced configuration settings for the entire zone. Or, you can click on the server, and then click the Advanced tab to set advanced configuration settings at the server (appliance) level, which will override zone-level settings.
-
Make the required changes to the configuration file.
-
Click Save.
Configuration Parameters
Table: authentication
| Parameters | Description |
|---|---|
| amazon_key | If using Amazon for the authentication mode, specify your Amazon Key. This is the same as Amazon Access Key in Configuration-Operations-Server-Amazon Settings in the appliance console. Default: blank |
| amazon_secret | If using Amazon for the authentication mode, specify your Amazon Secret. This is the same as Amazon Secret Key in Configuration-Operations-Server-Amazon Settings in the appliance console. Default: blank |
| basedn | If using ldap for the authentication mode, specify your Base DN. This is the same as Base DN in Configuration-Operations- Server-LDAP Settings in the appliance console. Default: blank |
| bind_dn | The user name to bind to the LDAP server. This user must have read access to all users and groups that will be used for ManageIQ authentication and role assignment. This is the same as Bind DN in Configuration-Operations-Server-LDAP Settings in the appliance console. Default: blank |
| bind_pwd: | The password for the bind_dn user. This is the same as Bind Password in Configuration-Operations- Server-LDAP Settings in the appliance console. Default: blank |
| get_direct_groups | Use this to get the LDAP roles from the LDAP users’ home forest. This is the same as Get Roles from Home Forest in the Authentication page for the ManageIQ Server. Default: true |
| group_memberships_max_depth | When traversing group memberships in the LDAP directory it will stop at this value. Default: 2 |
| ldaphost | Use ldaphost to specify the fully qualified domain name of your LDAP server. This is the same as LDAP Host Name in Configuration-Operations-Server-LDAP Settings in the appliance console. Default: blank |
| ldapport | Specify the port of your LDAP server. This is the same as LDAP Port in Configuration-Operations- Server-LDAP Settings in the appliance console. Default: 389 |
| mode | Use database to use the VMDB for security. Use ldap or ldaps to use directory services. This is the same as Mode in Configuration-Operations-Server-Authentication in the appliance console. Default: database |
| user_type | Use userprincipalname to type the user name in the format of user@domainname. Use mail to login with the user’s e-mail address. Use dn-cn for Distinguished Name (CN=<user>) or dn-uid Distinguished Name (UID=<user>) to use just the user name, but be sure to enter the proper user_suffix for either one. This is the same as User Type in Configuration-Operations- Server-LDAP Settings in the appliance console. Default: userprincipalname |
| user_suffix | Domain name to be used with user_type of dn-cn or dn-uid. This is the same as User Suffix in Configuration-Operations- Server-LDAP Settings in the appliance console. Default: blank |
Table: coresident_miqproxy
| Parameters | Description |
|---|---|
| use_vim_broker | Specify if you want the coresident SmartProxy to use a shared connection through the VIM broker to communicate with the VC or ESX host for SmartState Analysis. If it is disabled, then each SmartProxy SmartState Analysis would create its own connection. Default: true |
| concurrent_per_ems | Specify the number of co-resident SmartProxy SmartState Analyses that can be run against a specific management system at the same time. Default: 1 |
| concurrent_per_host | Specify the number of co-resident SmartProxy SmartState Analyses that can be run against a specific host at the same time. Default: 1 |
| scan_via_host | If you change scan_via_host to false, ManageIQ will use the Management System to scan which is limited by the concurrent_per_ems setting instead of the concurrent_per_host setting. Note this will greatly increase traffic to the Management System. Default: true |
Table: ems_refresh
| Parameters | Description |
|---|---|
| capture_vm_created_on_date | Set to false to turn off historical event retrieval. Set to true to turn on. By setting the flag to true ManageIQ will try to set the “ems_created_on” column in the vms table after an ems refresh for new VMs and any VMs with a nil “ems_created_on” value. ManageIQ looks at event information in our database as well as looking up historical event data from the management system. This is optional since the historical lookup could timeout. Default: false |
| collect_advanced_settings | Set to false if you do not want to collect advanced Virtual Machine settings during a management system refresh. This will increase the speed of the refresh, but less data will be collected. If the parameter is not listed, then the value is true. Default: true |
| ec2 | |
| get_private_images | For EC2 refreshes only; whether or not to retrieve private images. Default: true |
| get_public_images | For EC2 refreshes only; whether or not to retrieve public images. Default: false. Warning: setting get_public_images to true loads several thousand images in the VMDB by default and may cause performance issues. |
| get_shared_images | For EC2 refreshes only; whether or not to retrieve shared images. Default: true |
| public_images_filters | For EC2 refreshes only; a filter to reduce the number of public images. Default: all public images |
| ignore_terminated_instances | For EC2 refreshes only; whether or not to ignore terminated instances. Default: true |
| full_refresh_threshold | The number of targeted refreshes requested before they are rolled into a full refresh. For example, if the system and/or the user target a refresh against 7 VMs and 2 Hosts (9 targets), when the refresh actually occurs it will do a partial refresh against those 9 targets only. However, if a 10th had been added, the system would perform a full EMS refresh instead. Default: 100 |
| raise_vm_snapshot_complete_if_created_within: | Raises vm_snapshot_complete event for a snapshot being added to VMDB only if the create time in Virtual Center is within the configured period of time. This prevents raising events for old snapshots when a new VC is added to ManageIQ. Default: 15.minutes |
| refresh_interval | Scheduler does a periodic full EMS refresh every refresh_interval. Default: 24.hours |
Table: host_scan
| Parameters | Description |
|---|---|
| queue_timeout | Time period after which a host SmartState analysis will be considered timed out. Default: 20.minutes |
Table: log
| Parameters | Description |
|---|---|
| level | Specify the required level of logging for the ManageIQ appliance. Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. This is the same as Log Level in Configuration-Operations-Server-Logging in the appliance console and applies immediately to the evm.log file. Default: info |
| level_aws | Specify the level of logging for Amazon Web Services communications. Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. This applies to the aws.log file. Default: info |
| level_aws_in_evm | Specify what level of Amazon Web Services communication log should be also shown in evm.log. Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. Default: error |
| level_fog | Specify the level of logging for Fog communications. Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. This applies to the fog.log file. Default: info |
| level_fog_in_evm | Specify what level of Fog communication log should be also shown in evm.log. Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. Default: error |
| level_rails | Specify the level of logging for Rails. Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. Once changed, this applies immediately to the production.log file. Default: info |
| level_rhevm | Specify the level of logging for Red Hat communications. Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. This applies to the rhevm.log file. Default: warn |
| level_rhevm_in_evm | Specify what level of Red Hat communication log should be also shown in evm.log. Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. Default: error |
| level_vim | Specify the level of logging for VIM (communication with VMware ESX and Virtual Center). Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. This applies to the vim.log file. Default: warn |
| level_vim_in_evm | Specify what level of vim logging should be also shown in evm.log. Possible levels from most detailed to least detailed are: debug, info, warn, error, fatal. Default: error |
Table: db_stats
| Parameters | Description |
|---|---|
| enabled | Specify if you want to keep track of the number of queries, size of queries, number of responses, size of response, min/max for each, number of established connections at for each server process. This information will show in the EVM log. Default: false |
| log_frequency | How frequently in seconds the process will log the database statistic in seconds. Default: 60 |
Table: callsites
| Parameters | Description |
|---|---|
| enabled | Specify if you want keep track of the code that is accessing the database. Enabling call sites will decrease performance because of the amount of information tracked. The db_stats: enabled parameter must be set to true to use this. Default: false |
| depth | Specify how many levels in the call stack to track for each database access. Default: 10 |
| min_threshold | Do not keep track of code that does not access the database this many times per log_frequency. Default: 10 |
| path | Set the path for the ManageIQ appliance log. This is the same as Log Path in Configuration-Operations- Server-Logging in the appliance console. Default: If no value is present, the path is /var/www/miq/vmdb/log. |
| line_limit | Limit how many characters are retained in a single log line. 0 means no limit. Default: 0 |
Table: collection
| Parameters | Description |
|---|---|
ping_depot |
Whether to use TCP port ping to the log depot before performing log collection. Default: true |
ping_depot_timeout |
Specify how long in seconds to wait for response from log depot before deciding that the TCP port ping failed. Default: 20 |
current |
When collecting logs, specifies what is considered current logging as opposed to archived logging. Default: :pattern: log/*.log log/apache/*.log log/*.txt config/* /var/lib/pgsql/data/*.conf /var/lib/pgsql/data/pg_log/* /var/log/syslog* /var/log/daemon.log* /etc/default/ntp* /var/log/messages* /var/log/cron* BUILD GUID VERSION |
archive |
Specifies what is considered archived logging. The default pattern is blank which means *.gz files in the log directory. |
Table: log_depot
| Parameters | Description |
|---|---|
| uri | Specify the URI for the log depot. This is the same as the URI in menu:Configuration[Diagnostics > Collect Logs] in the appliance console. Default: blank |
| username | Specify the user name for the log depot. This is the same as the user ID in menu:Configuration[Diagnostics > Collect Logs] in the appliance console. Default: blank |
| password | Specify the password for the user for the log depot. This is the same as the password in menu:Configuration[Diagnostics > Collect Logs] in the appliance console. Default: blank |
Table: performance
| Parameters | Description |
|---|---|
| capture_threshold | |
| vm | Amount of time in minutes to wait after capture before capturing again. Default: 50.minutes |
| host | Amount of time in minutes to wait after capture before capturing again. Default: 50.minutes |
| ems_cluster | Amount of time in minutes to wait after capture before capturing again. Default: 50.minutes |
| storage | Amount of time in minutes to wait after capture before capturing again. Default: 120.minutes |
| capture_threshold_with_alerts | |
| host | Amount of time in minutes to wait after capture before capturing again. This value is used instead of capture_threshold for Hosts that have alerts assigned based on real time Capacity & Utilization data. Default: 20.minutes |
| ems_cluster | Amount of time in minutes to wait after capture before capturing again. This value is used instead of capture_threshold for clusters that have alerts assigned based on real time Capacity & Utilization data. Default: 50.minutes |
| vm | Amount of time in minutes to wait after capture before capturing again. This value is used instead of capture_threshold for VMs that have alerts assigned based on real time Capacity & Utilization data. Default: 20.minutes |
| concurrent_requests | |
| vm | Amount of time in minutes to wait after capture before capturing again. This value is used instead of capture_threshold for VMs that have alerts assigned based on real time Capacity & Utilization data. Default: 20.minutes |
| hourly | Number of concurrent VC requests to make when capturing hourly raw metrics. Default: 1 |
| realtime | Number of concurrent VC requests to make when capturing real time raw metrics. Default: 20 |
| history | |
| initial_capture_days | How many days to collect data for on first collection. Default: 0 |
| Keep_daily_performances | How long to keep daily performance data in the VMDB. Default: 6.months |
| keep_realtime_performances | How long to keep realtime performance data in the VMDB. Default: 4.hours |
| keep_hourly_performances | How long to keep hourly performance data in the VMDB. Default: 6.months |
| purge_window_size | When the purge needs to delete rows which are older than the keep_realtime_performances, keep_hourly_performances, and keep_daily_performances values, this value sets how many rows to delete in each batch. For example, a value of 1000 will cause us to issue ten 1,000 row deletes. Default: 1000 |
Table: repository_scanning
| Parameters | Description |
|---|---|
| defaultsmartproxy | Specify the SmartProxy for repository scanning. This is the same as Default Repository Smartproxy in Configuration-Operations- Server-VM Server Control in the appliance console. Default: blank |
Table: server
| Parameters | Description |
|---|---|
| case_sensitive_name_search | Specify if you want the search by name on configuration item screens to be case senstive. Default: false |
| company | Specify the label you want to use for your company’s tagging. This is the same as Company Name in Configuration-Operations- Server-Basic Info. Default: “My Company” |
| custom_logo | Specify if you want to use a custom logo. This is the same as Use Custom Logo in Configuration-Custom Logo-Logo Selection. Default: false |
| events | |
| disk_usage_gt_percent | For ManageIQ operational alerts, specify at what threshold the disk usage alerts will be triggered. Default: 80 |
| heartbeat_timeout | How long to wait until the server heartbeat is considered timed out. if the timeout is exceeded, other appliances in the zone/region can vie for the roles active on the timed out ManageIQ appliance. Default: 2.minutes |
| host | ManageIQ Server’s IP address. Default: blank |
| hostname | ManageIQ Server’s hostname. Default: localhost.localdomain |
| listening_port | Specify the port number on which the web server is listening. Note that this does not set the port that VMDB listens on. When deploying the SmartHost from the ManageIQ appliance, it tells the SmartHost (miqhost) what port to talk to the VMDB on. Default: “443” |
| mks_version | Specify the version of the VMware MKS Plugin to use for the VM Console. This is the same as VMware MKS Plugin Version in Configuration-Operations- Server-VM Console. Default : <IP_ADDRESS> |
| name | Set the name to display for the ManageIQ appliance that you are logged on to in the appliance console. This is the same as appliance Name in Configuration-Operations- Server-Basic Information. Default : EVM |
| role | Specify the roles for this ManageIQ Server, separated by commas without spaces. The possible values are automate, database_operations, ems_inventory, ems_metrics_collector, ems_metrics_coordinator, ems_metrics_processor, ems_operations, event, notifier, reporting, scheduler, smartproxy, smartstate, user_interface, web_services. This is the same as Server Roles in Configuration-Operations- Server- Server Control. Default: database_operations, event, reporting, scheduler, smartstate, ems_operations, ems_inventory, user_interface, web_services |
| session_store | Where to store the session information for all web requests. The possible values are sql, memory, or cache. SQL stores the session information in the database regardless of the type of database server. Memory stores all the session information in memory of the server process. Cache stores the information in a memcache server. Default: cache |
| startup_timeout | The amount of time in seconds that the server will wait and prevent logins during server startup before assuming the server has timed out starting and will redirect the user to the log page after login. Default: 300 |
| vnc_port | If using VNC for remote console, the port used by VNC. Default: 5800 |
| zone | Set the Zone for this appliance belongs. This is the same as Zone in Configuration-Operations- Server-Basic Information. Default : default |
| :worker_monitor | Starts and monitors the workers. Parameters specified here will override those set in the workers:default section. |
| poll | How often the worker monitor checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 15.seconds |
| miq_server_time_threshold | How much time to give the server to heartbeat before worker monitor starts to take action against non-responding server. Default: 2.minutes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 1 |
| sync_interval | Time interval to sync active roles and configuration for all workers. Default: 30.minutes |
| wait_for_started_timeout | How long to wait for a started worker to heartbeat before considering the worker timed out. Default: 10.minutes |
| kill_algorithm | |
| name | Criteria used to start killing workers. Default: used_swap_percent_gt_value |
| value | Value of the criteria used. Default: 80 |
| start_algorithm | |
| name | After server startup, criteria that must be met to decide if the ManageIQ Server can start a new worker. Default: used_swap_percent_lt_value |
| value | Value of criteria used. Default: 60 |
Table: session
| Parameters | Description |
|---|---|
| interval | Set the time interval in seconds for checking inactive sessions in appliance console. Default: 60 |
| timeout | Set the time period in seconds in which inactive console sessions are deleted. This is the same as Session Timeout in Configuration-Operations-Server-Authentication in the appliance console. Default: 3600 |
| memcache_server | If you choose memory for session_store, you need to specify the memcache_server to retrieve the session information from. Default: <IP_ADDRESS>:11211 |
| memcache_server_opts | Options to send to memcache server. : blank |
| show_login_info | Specify whether or not you want to see login info on start page. Default: true |
Table: smartproxy_deploy
| Parameters | Description |
|---|---|
| queue_timeout | Timeout for host smartproxy deploy job. Default: 30.minutes |
Table: smtp
| Parameters | Description |
|---|---|
| host | Specify the hostname of the smtp mail server. This is the same as Host in Configuration-Operations-Server-Outgoing SMTP E-mail Server. Default: localhost |
| port | Specify the port of the smtp mail server. This is the same as Port in Configuration-Operations-Server-Outgoing SMTP E-mail Server. Default: “25” |
| domain | Specify the domain of the smtp mail server. This is the same as Domain in Configuration-Operations-Server-Outgoing SMTP E-mail Server. Default: mydomain.com |
| authentication | Specify the type of authentication of the smtp mail server. This is the same as Authentication in Configuration-Operations-Server-Outgoing SMTP E-mail Server. Default: login |
| user_name | Specify the username required for login to the smtp mail server. This is the same as User Name in Configuration-Operations-Server-Outgoing SMTP E-mail Server. Default: evmadmin |
| password | Specify the encrypted password for the user_name account. This is the same as Password in Configuration-Operations-Server-Outgoing SMTP E-mail Server. Default: blank |
| from | Set the address that you want to send e-mails from. This is the same as From E-mail Address in Configuration-Operations-Server-Outgoing SMTP E-mail Server. Default<EMAIL_ADDRESS>|
Table: snapshots
| Parameters | Description |
|---|---|
| create_free_percent | Ensures the % of free space available on the main datastore (datastore where vmx file is located) can support the % growth of the snapshot. The default is to require space for 100% of the provisioned size of all disks that are taking part in the snapshot. A value of 0 means do not check for space before creating the snapshot. Default: 100 |
| remove_free_percent | Ensures the % of free space available on the main datastore (datastore where vmx file is located) has the % free space available to support the snapshot deletion process. Note that the deletion process consists of first composing a new snapshot then removing it once the original snapshot to be deleted has been collapsed in the VM. The default is to require 100% of the size of all disks to complete this process. A value of 0 means do not check for space before removing the snapshot. Default: 100 |
Table: webservices
| Parameters | Description |
|---|---|
| contactwith | Set to ipaddress to contact miqhost using the IP address. Set to hostname to contact miqhost by its hostname. Set to resolved_ipaddress to take the hostname and resolve it to an IP address. Default: ipaddress |
| mode | Set to invoke to use webservices. Set to disable to turn off webservices. This is the same as Mode in Configuration-Operations- Server-Web Services in the appliance console. Default: invoke |
| nameresolution | If set to true, the hostname will be resolved to an IP address and saved with the host information in the VMDB. Default: false |
| security | If Web Services are enabled, you can set this to ws-security. This is the same as Security in Configuration-Operations- Server-Web Services in the appliance console. Note: This is not currently supported. Default: none |
| timeout | Specify the web service timeout in seconds. Default: 120 |
| password | Specify the encrypted password for the user_name account. This is the same as Password in Configuration-Operations-Server-Outgoing SMTP E-mail Server. Default: blank |
| use_vim_broker | Controls if the vim_broker is used to communicate with VMware infrastructure. Default: true |
Table: workers
| Parameters | Description |
|---|---|
| worker_base | |
| defaults | If the following parameters are NOT explicitly defined for a specific worker, then these values will be used. |
| count | Number of this type of worker. Default: 1 |
| gc_interval | How often to do garbage collection for this worker. Default: 15.minutes |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 3.seconds |
| poll_method | If set to normal, the worker checks for work the number of seconds set in the poll parameter. If set to escalate, the worker will increase the time between checks when there is no work to be done. Default: normal |
| poll_escalate_max | The maximum number of time to wait between checks for work. Poll_method must be set to escalate for this option to be used. Default: 30.seconds |
| heartbeat_freq | How often to “heartbeat” the worker. Default: 60.seconds |
| heartbeat_method | Set which way to dispatch work. Possible values are sql or drb. Default: drb |
| heartbeat_timeout | How long to wait until the worker heartbeat is considered timed out. Default: 2.minutes |
| parent_time_threshold | How long to allow the parent to go without heartbeating before considering the “parent’ not responding. For workers, the worker monitor is the parent. For Worker monitor, the Server is the parent. Default: 3.minutes |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 150.megabytes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 10 |
| restart_interval | How long to let a worker remain up before asking it to restart. All queue based workers are set to 2.hours and every other worker does not get restarted by a 0.hours value. Default: 0.hours |
| starting_timeout | How long to wait before checking a worker’s heartbeat when it is starting up to mark it as not responding, similar to a grace period before you begin monitoring it. Default: 10.minutes |
| event_catcher | Associated with Event Monitor Server Role. Captures ems events and queues them up for the event_handler to process. Parameters specified here will override those set in the worker_base:default section. |
| ems_event_page_size | Internal system setting which sets the maximum page size for the event collector history. This should not be modified. Default: 100 |
| ems_event_thread_shutdown_timeout | Internal system setting which determines how long the event catcher at shutdown will wait for the event monitor thread to stop. This should not be modified. Default: 10.seconds |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 2.gigabytes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 1 |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 1.seconds |
| event_catcher_redhat | Contains settings that supersede the event_catcher for event_catcher_redhat. |
| event_catcher_vmware | Contains settings that supersede the event_catcher for event_catcher_vmware. |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 1.seconds |
| event_catcher_openstack | Contains settings that supersede the event_catcher for event_catcher_openstack. |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 15.seconds |
| topics | List of AMQP topics that should be monitored by ManageIQ when gathering events from OpenStack. |
| duration | Qpid Specific. Length of time (in seconds) the receiver should wait for a message from the Qpid broker before timing out. Default: 10.seconds |
| capacity | Qpid Specific. The total number of messages that can be held locally by the Qpid client before it needs to fetch more messages from the broker. Default: 50.seconds |
| amqp_port | Port used for AMQP. Default: 5672 |
| schedule_worker | Settings for Scheduler Server Role and any other work that runs on a schedule. Parameters specified here will override those set in the worker_base:default section. |
| db_diagnostics_interval | How frequently to collect database diagnostics statistics. Default: 30.minutes |
| job_proxy_dispatcher_interval | How often to check for available SmartProxies for SmartState Analysis jobs. Default: 15.seconds |
| job_proxy_dispatcher_stale_message_check_interval | How often to check for the dispatch message in the queue Default: 60.seconds |
| job_proxy_dispatcher_stale_message_timeout | Kill a message if this value is reached. Default: 2.minutes |
| job_timeout_interval | How often to check to see if a job has timed out. Default: 60.seconds |
| license_check_interval | How often to check for valid license. Default: 1.days |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 150.megabytes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 3 |
| performance_collection_interval | Controls how often the schedule worker will put performance collection request on the queue to be picked up by the collection worker. Default: 3.minutes |
| performance_collection_start_delay | How long after ManageIQ Server has started before starting capacity and utilization collection, if collection needs to be done. Default: 5.minutes |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 15.seconds |
| server_logs_stats_interval | How often to log the ManageIQ Server statistics. Default: 5.minutes |
| server_stats_interval | How often to collect the ManageIQ Server statistics. Default: 60.seconds |
| session_timeout_interval | How often to check to see if a UI (appliance console) session has timed out. Default: 30.seconds |
| storage_file_collection_interval | How often to perform file inventory of storage locations. Default: 1.days |
| storage_file_collection_time_utc | What time to perform file inventory of storage locations. Default: “06:00” |
| vdi_refresh_interval | How often to refresh vdi inventory. Default: 20.minutes |
| vm_retired_interval | How often to check for virtual machines that should be retired. Default: 10.minutes |
| vm_scan_interval | How often to check virtual machines to see if scan needs to be done. Default: 10.minutes |
| smis_refresh_worker | Settings for Storage Inventory Server Role and any other work that runs on a schedule. Parameters specified here will override those set in the worker_base:default section |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 15.seconds |
| connection_pool_size | Maximum number of database connections allowed per process. Default: 5 |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 1.gigabytes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 3 |
| smis_update_period | How frequently to update smis information. Default: 1.hours |
| status_update_period | How frequently to update smis status. Default: 5.minutes |
| stats_update_period | How frequently to update smis statistics. Default: 10.minutes |
| vim_broker_worker | Launched for any of these roles: Capacity & Utilization Collector, SmartProxy, SmartState Analysis, Management System Operations, Management System Inventory. Also launched if the use_vim_broker setting is on. Provides connection pooling, caching of data to and from the VMware infrastructure. Parameters specified here will override those set in the workers:default section. |
| heartbeat_freq | How often to heartbeat the worker. Default: 15.seconds |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 1.gigabytes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 3 |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 1.seconds |
| reconnect_retry_interval | Period after which connection is retried. Default: 5.minutes |
| vim_broker_status_interval | Internal system setting which configures how much time to wait after receiving event updates before checking for more updates. Default: 0.seconds |
| wait_for_started_timeout | Time between the worker’s preload and startup time before considering the worker timed out. Default: 10.minutes |
| ui_worker: | Settings for User Interface Server Role. Parameters specified here will override those set in the worker_base:default section. |
| connection_pool_size | Maximum number of database connections allowed per process. Default: 5 |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 1.gigabytes |
| nice_delta: 1 | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 1 |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 60.seconds |
| web_service_worker | Settings for Web Services Server Role. Parameters specified here will override those set in the worker_base:default section. |
| connection_pool_size | Maximum number of database connections allowed per process. Default: 5 |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 1.gigabytes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 1 |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 60.seconds |
| queue_worker_base | Base class of all queue workers that work off of the queue.. |
| defaults | If the following parameters are NOT explicitly defined for a queue worker, then these values will be used. |
| cpu_usage_threshold | How much cpu to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 100.percent |
| queue_timeout | How long a queue message can be worked on before it is considered timed out. Default: 10.minutes |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 400.megabytes |
| restart_interval | Queue workers restart interval. Default: 2.hours |
| poll_method | If set to normal, the worker checks for work the number of seconds set in the poll parameter. If set to escalate, the worker will increase the time between checks when there is no work to be done. Default: normal |
| generic_worker | Performs work that is not classified as any specific type of work. Processes all normal priority or non-specific queue items. Parameters specified here will override those set in the queue_worker_base:default section |
| count | Number of this type of worker. Default: 4 |
| ems_refresh_worker | Performs all ems (management system) refreshes to keep the vmdb in sync with the state of the components of the virtual infrastructure in the various management systems. Parameters specified here will override those set in the queue_worker_base:default section |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 10.seconds |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 2.gigabytes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 7 |
| restart_interval | Queue workers restart interval. Default: 2.hours |
| queue_timeout | How long a message can be worked on before it is considered timed out. Default: 120.minutes |
| event_handler | Associated with Event Monitor Server Role. Handles all events caught by the event catcher worker. Parameters specified here will override those set in the workers:default section. Parameters specified here will override those set in the queue_worker_base:default section |
| cpu_usage_threshold | How much cpu to allow the worker to grow to before gracefully requesting it to exit and restart. The value of 0 means that this worker will never be killed due to CPU usage. Default: 0.percent |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 7 |
| perf_collector_worker | Connects to VC/ESX to collect the raw performance data. Same as the Capacity & Utilization Data Collector Server Role. Parameters specified here will override those set in the queue_worker_base:default section count. Number of this type of worker. Default: 2 |
| count | Number of this type of worker. Default: 2 |
| poll_method | If set to normal, the worker checks for work the number of seconds set in the poll parameter. If set to escalate, the worker will increase the time between checks when there is no work to be done. Default: escalate |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 3 |
| perf_processor_worker | Processes the raw performance data into a reportable format. Same as the Capacity & Utilization Data Processor Server Role. Parameters specified here will override those set in the queue_worker_base:default section |
| count | Number of this type of worker. Default: 2 |
| poll_method | If set to normal, the worker checks for work the number of seconds set in the poll parameter. If set to escalate, the worker will increase the time between checks when there is no work to be done. Default: escalate |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 400.megabytes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 7 |
| priority_worker | Performs all high priority queue items including many tasks on behalf of the UI. UI requests are normally executed by a priority worker so they will not to block the UI. Parameters specified here will override those set in the queue_worker_base:default section |
| count | Number of this type of worker. Default: 2 |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 200.megabytes |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 1 |
| poll | How often the workers checks for work. This value only is only used when the worker has no more work to do from the queue. It will wait for an amount of time determined by the poll value and poll method. Therefore, if there is constant work on the queue, the worker will not wait in between messages. Default: 1.seconds |
| reporting_worker | Compiles reports. Settings for Reporting Server Role. Parameters specified here will override those set in the queue_worker_base:default section |
| count | Number of this type of worker. Default: 2 |
| nice_delta | Tells the worker monitor what Unix “nice” value to assign the workers when starting. A lower number is less nice to other processes. Default: 7 |
| smart_proxy_worker | Performs the embedded scanning of virtual machines. Settings for SmartProxy Server Role. Parameters specified here will override those set in the queue_worker_base:default section |
| count | Number of this type of worker. Default: 3 |
| memory_threshold | How much memory to allow the worker to grow to before gracefully requesting it to exit and restart. Default: 600.megabytes |
| queue_timeout | How long a queue message can be worked on before it is considered timed out. Default: 20.minutes |
| restart_interval | Queue workers restart interval. Default: 2.hours |
Schedules
Scheduling SmartState Analyses and Backups
From the Schedules area in Settings, you can schedule the analyses of virtual machines, hosts, clusters, and datastores to keep the information current. Depending on which resource you want to analyze, you can filter which ones to analyze. You may also specify only one virtual machine or perform an analysis on all virtual machines. In addition, you can schedule compliance checks, and database backups.
Scheduling a SmartState Analysis or Compliance Check
To schedule a SmartState Analysis or Compliance Check:
-
Click (Configuration).
-
Click on the Settings accordion, then click Schedules.
-
Click (Configuration), and (Add a new Schedule).
-
In the Basic Information area, type in a Name and Description for the schedule.
-
Select Active to enable this scan.
-
From the Action list, select the type of analysis to schedule. Based on the type of analysis you choose, you are presented with one of the following group boxes:
-
VM Analysis: Displays VM Selection where you can choose to analyze All VMs, All VMs for Provider, All VMs for Cluster, All VMs for Host, A single VM, or Global Filters.
-
Template Analysis: Displays Template Selection where you can choose to analyze All Templates, All Templates for Provider, All Templates for Cluster, All Templates for Host, A single Template, or Global Filters.
-
Host Analysis: Displays Host Selection where you can choose to analyze All Hosts, All Hosts for Provider, A single Host, or Global Filters.
Note:
You can only schedule host analyses for connected virtual machines, not repository virtual machines that were discovered through that host. Since repository virtual machines do not retain a relationship with the host that discovered them, there is no current way to scan them through the scheduling feature. The host is shown because it may have connected virtual machines in the future when the schedule is set to run.
-
Cluster / Deployment Role Analysis: Displays Cluster Selection where you can choose to analyze All Clusters, All Clusters for Provider, or A single Cluster.
-
Datastore Analysis: Displays Datastore Selection where you can choose to analyze All Datastores, All Datastores for Host, All Datastores for Provider, A single Datastore, or Global Filters.
-
VM Compliance Check: Displays VM Selection where you can choose to analyze All VMs, All VMs for Provider, All VMs for Cluster, All VMs for Host, A single VM, or Global Filters.
-
Host Compliance Check: Displays Host Selection where you can choose to analyze All Hosts, All Hosts for Provider, All Hosts for Cluster, A single Host, or Global Filters.
-
Database Backup: Under Type, displays Network File System, Samba, Amazon AWS S3 and OpenStack Swift.. See Scheduling a Database Backup for details on scheduling a database backup.
-
-
By applying Global Filters within any of the above items, you can designate which virtual machines or hosts to analyze.
-
In Run, set the frequency of the analysis to run. There are further options based on which Run option you choose.
-
Click Once to have the analysis run only one time.
-
Click Daily to run the analysis on a daily basis. You will be prompted to select the number of days between each analysis.
-
Click Hourly to run the analysis hourly. You will be prompted to select the number of hours between each analysis.
-
-
Select a Time Zone.
Note:
If you change the Time Zone, you will need to reset the stating date and time.
-
Type or select a date to begin the schedule in Starting Date.
-
Select a Starting Time based on a 24 hour clock in the selected Time Zone.
-
Click Add.
Scheduling a Database Backup
Note:
Set wal_keep_segments
parameter to a value that ensures
ManageIQ scheduled backups finish. Create a test backup
using a value based on the calculation:
(<pg-volume-free-space>MB/4)/16MB.
Measure free space in MB and ensure the denominator matches in units.
Setting wal_keep_segments
to this value will cause the transaction log
to occupy, at a minimum, one quarter of the current free space. Adjust
your calculation accordingly upon successful testing.
To set the wal_keep_segments
value:
-
SSH to the database appliance
-
Access the database
# psql DBNAME USERNAME
-
Set the
wal_keep_segments
valuepostgres=# ALTER SYSTEM SET wal_keep_segments = <value>;
-
Reload
wal_keep_segments
postgres=# SELECT pg_reload_conf();
On successful backup, revise the value for wal_keep_segments
to save
space based on transaction log size.
To schedule a database backup:
-
Click (Configuration).
-
Click on the Settings accordion, then click Schedules.
-
Click (Configuration), and (Add a new Schedule).
-
In the Basic Information area, type in a Name and Description for the schedule.
-
Select Active to enable this backup schedule.
-
From the Action list, select Database backup.
-
In the Database Backup Settings area, select a type of server to put the backups. You can either use Network File System or Samba.
-
If selecting Samba, enter the Depot Name, URI, User ID, and a valid Password. Then, click Validate to check the settings.
-
If you choose Network File System, enter the Depot Name and URI.
-
-
In Run, set the frequency of the analysis to run. There are further options based on which Run option you choose.
-
Click Once to have the backup run only one time.
-
Click Daily to run the backup on a daily basis. You will be prompted to select the number of days between each backup.
-
Click Hourly to run the backup hourly. You will be prompted to select the number of hours between each backup.
-
-
Select a Time Zone.
Note:
If you change the Time Zone, you will need to reset the stating date and time.
-
Type or select a date to begin the schedule in Starting Date.
-
Select a Starting Time (UTC) based on a 24 hour clock in the selected time zone.
-
Click Add.
Modifying a Schedule
To modify a schedule:
-
Click (Configuration).
-
Click on the Settings accordion, then click Schedules.
-
Click the schedule that you want to edit.
-
Click (Configuration), and then click (Edit this Schedule).
-
Make the required changes.
-
Click Save.
Importing and Exporting Schedules
ManageIQ provides the ability to import and export
schedules using the import_export_schedules.rb
script:
./var/www/miq/vmdb/tools/import_export_schedules.rb -h
| Option | Description |
|---|---|
| -u, –user=<s> | userid (default: admin) |
| -d, –output-dir=<s> | Output directory (default: ./) |
| -s, –schedule=<s> | Schedule name or id |
| -o, –operation=<s> | Export or import (default: export) |
| -y, –import-yaml=<filename/uri> | Imported yaml |
| -h, –help | Show this message |
Usage Example.
Import:
./var/www/miq/vmdb/tools/import_export_schedules.rb -o import -y ./filename.yaml
Export:
./var/www/miq/vmdb/tools/import_export_schedules.rb -s 158
Note that the import_export_schedules.rb
script works for all types of
schedules, including:
-
Report
-
Policy
-
Alert
-
SmartState Analysis
-
Database Backup
-
Automation Task
-
Service Template
Access Control
Click (Configuration). Click on the Access Control accordion to see a hierarchy of the configurable items for users, groups, roles, and tenants. You can add and modify users, groups, account roles, tenants, and projects.
Creating a Tenant
Tenants are used in ManageIQ for controlling visibility of objects.
To create a tenant:
-
Click (Configuration).
-
Click on the Access Control accordion, then click Tenants.
-
Click on the top-level Tenant, click (Configuration), and (Add child Tenant to this Tenant) to create a tenant.
-
Enter a name for the tenant in the Name field.
-
Enter a description for the tenant in the Description field.
-
Click Add.
Creating a Project
A tenant can also contain a self-contained child tenant known as a ‘project’. A project cannot have a child tenant, but it is useful for allocating resources to a small group or team within a larger organization.
To create a project:
-
Click (Configuration).
-
Click on the Access Control accordion, then click Tenants.
-
Click on the Tenant where you want to add a Project, click (Configuration), and (Add Project to this Tenant) to create a project.
-
Enter a name for the project in the Name field.
-
Enter a description for the project in the Description field.
-
Click Add.
Managing Tenant and Project Quotas
Use the following procedure to allocate or edit quotas for tenants and projects.
Note:
Quota is allocated based on the user’s current group. If the user belongs to multiple groups, you must change to the desired group before allocating or editing group quota. See Groups for more details.
-
Click (Configuration).
-
Click on the Access Control accordion, then click Tenants.
-
Click on the Tenant or Project where you want to add a quota, click (Configuration), and (Manage quotas for the Selected Item) to create a quota.
-
In the list of pre-built quotas, switch Enforced next to the quota item you want to enable to
Yes
. -
In the Value field, enter the constraints you want to apply to the quota.
-
Click Save.
Tagging Tenants and Projects
To tag tenants and projects:
-
Click (Configuration).
-
Click on the Access Control accordion, then click Tenants.
-
Select the tenant or project, then click Policy, and select Edit My Company Tags for this Tenant.
-
In Tag Assignment, click Select a customer tag to assign, and select a tag from the list. In the next column, set a corresponding value.
-
Click Save.
Creating a User
To create a user:
-
Click (Configuration).
-
Click on the Access Control accordion, then click Users.
-
Click (Configuration), and (Add a new User) to create a user.
-
Enter a Full Name, Username, Password with confirmation, and Email Address for the user. An email address is required; omitting the user email address can result in unsuccessful provisioning requests.
- If you are using LDAP, but did not enable **Get User Groups from LDAP** in your server’s **Authentication** tab, you will need to define a user. The UserID must match exactly the user’s name as defined in your directory service. Use all lowercase characters to ensure the user can be found in the VMDB. - When the user logs in, they use their LDAP password. -
Select one or more groups from Available Groups.
-
Click Add.
Deleting a User
For security reasons, delete any user that no longer needs access to the information or functions of the server.
To delete a user:
-
Click (Configuration).
-
Click on the Access Control accordion, then click Users.
-
Select the user you want to delete.
-
Click (Configuration), and (Delete selected Users) to delete a user.
Groups
User groups create filters and assign roles to users. You can either create your own groups, or leverage your LDAP directory service to assign groups of users to account roles. For a list of what each pre-defined account role can do, see Roles.
A user can exist in multiple groups. However, a group can only be assigned one account role.
If a user belongs to multiple groups, you can change the user’s current group by navigating to the settings menu, clicking Change Group, then selecting the desired group. The Current Group affects quota and other settings for the user.
Creating a Group
To create a user group:
-
Click (Configuration).
-
Click on the Access Control accordion, then click Groups.
-
Click (Configuration), and (Add a new Group) to create a group.
-
Enter a name for the group in the Name field. To ensure compatibility with tags, use underscores in place of spaces. For example, ManageIQ-
test_group
. -
Select a Role to map to this group. For a description of each ManageIQ role, see Account Roles and Descriptions.
-
Select the Project/Tenant this group must belong to.
-
Limit what users in this group can view by selecting filters in the Assign Filters area.
-
Click the <My Company> Tags tab to select the tags that users in this group can access. Resources with the selected tags attached can be accessed by this group. Select tags using one of the options in the This user is limited to list:
-
Select Specific Tags, then check the boxes for the tags that you want to limit this user to. The items that have changed will show in blue italicized font.
-
Select Tags Based On Expression, then create tags based on an expression using AND, OR, or NOT. This allows you to further limit the resources accessible to a user: for example, to specify a combination of tags that must exist on a resource.
-
-
Click the Host & Clusters tab.
- Check the boxes for the host and clusters that you want to limit this user to. The items that have changed will show in blue italicized font.
-
Click the VMs & Templates tab. This shows folders that you have created in your virtual infrastructure.
- Check the boxes for the folders that you want to limit this user to. The items that have changed will show in blue italicized font.
-
-
Click Add.
After creating a group, assign one or more users to the group by editing a user.
Roles
When you create a group, you must specify a role to give the group rights to resources in the console. The group’s role determines the scope of access for the users that are members of the group.
ManageIQ provides a default group of roles, but you can also create your own, or copy and edit the default groups.
Note:
If you have enabled Get Role from LDAP under LDAP Settings, then the role is determined by the LDAP user’s group membership in the directory service.
To view details of a role and its level of access:
-
Click (Configuration).
-
Click on the Access Control accordion, then click Roles.
-
Click on a role from the list to display role information and the product features the role can access (marked by a checkmark). You can expand the categories under Product Features to see further detail.
The table below shows a summary of the functions available to each role.
Account Roles and Descriptions
| Role | Description |
|---|---|
| Administrator | Administrator of the virtual infrastructure. Can access all infrastructure functionality. Cannot change server configuration. |
| Approver | Approver of processes, but not operations. Can view items in the virtual infrastructure, view all aspects of policies and assign policies to policy profiles. Cannot perform actions on infrastructure items. |
| Auditor | Able to see virtual infrastructure for auditing purposes. Can view all infrastructure items. Cannot perform actions on them. |
| Container Administrator | Administrator with capabilities to configure, view and execute tasks on all containers and related underlying infrastructure. Has access to Nodes, Pods and Projects dashboards. |
| Container Operator | This role can view and execute tasks related to containers and related underlying infrastructure. The Container Operator has access to locked versions of the same dashboards as the Container Administrator. |
| Desktop | Access to VDI pages. |
| Operator | Performs operations of virtual infrastructure. Can view and perform all functions on virtual infrastructure items including starting and stopping virtual machines. Cannot assign policy, but can view policy simulation from Virtual Machine page. |
| Security | Enforces security for the virtual environment. Can assign policies to policy profiles, control user accounts, and view all parts of virtual infrastructure. Cannot create policies or perform actions on virtual infrastructure. |
| Super Administrator | Administrator of ManageIQ and the virtual infrastructure. Can access all functionality and configuration areas. |
| Support | Access to features required by a support department such as diagnostics (logs). Can view all infrastructure items and logs. Cannot perform actions on them. |
| Tenant Administrator | Configures settings applicable to a Tenant. Sets Branding, maps groups/roles, configures LDAP credentials, and configures dashboard settings. |
| Tenant Quota Administrator | Configures quota limits for the tenant, applying usage constraints for CPU, Memory, Storage, Maximum number of VMs, and Maximum number of Templates. |
| User | User of the virtual infrastructure. Can view all virtual infrastructure items. Cannot perform actions on them. |
| User Limited Self Service | Limited User of virtual machines. Can make provision requests. Can access some functions on the virtual machine that the user owns including changing power state. |
| User Self Service | User of virtual machines. Can make provision requests. Can access some functions on the virtual machine that the user owns and that the user’s LDAP groups own including changing power state. |
| Vm User | User of virtual machines. Can access all functions on the virtual machine including changing power state and viewing its console. Cannot assign policy, but can view policy simulation from virtual machine page. |
Creating a Role
To create a role:
-
Click (Configuration).
-
Click on the Access Control accordion, then click Roles.
-
Click (Configuration), and (Add a new Role). Alternatively, you can copy an existing role to a new role by clicking Copy this to a new Role.
-
In the Role Information area, type a name for the new role. For Access Restriction for Services, VMs, and Templates, select if you want to limit users with this role to only see resources owned by the user or their group, owned by the user, or all resources (None):
-
Under Product Features (Editing), navigate to the appropriate feature and enable or disable it:
-
Click Add.
Diagnostics
Click (Configuration). Click on the Diagnostics tab to see the status of the different ManageIQ roles and workers for each server, view and collect logs, and gather data if there are any gaps in capacity and utilization information. The Diagnostics area is designed in a hierarchy.

-
At the zone level, you can see ManageIQ roles by servers and servers by roles. In addition, you can set log collection values for a specific zone, and collect gap data for capacity and utilization.
-
At the server level, you can see the workers for each server, set log collection values for a specific server, and view current logs.
Region Diagnostics
Using the console, you can set the priority of server regional roles, review and reset replication, and create backups of your database either on demand or on a schedule.
Regions are used primarily to consolidate multiple VMDBs into one master VMDB for reporting while zones are used to define functional groups of servers. There can be only one region per VMDB, but multiple zones per region (or VMDB). Some server roles are aware of each other across ManageIQ appliances at the region level. This means that redundancy and failover rules apply at the region level. You can also set priorities for the server roles that provide failover.
Server Role Priorities
If you have multiple servers in your environment with duplicate failover roles, then you can set the priority of the server role.
-
Only server roles that support failover can be marked as primary. These roles only allow one server to be active at a time. These are Notifier, Capacity & Utilization Coordinator, Event Monitor, Scheduler, Storage Inventory, and Provider Inventory.
-
All other server roles are additive. The more servers with that role in a zone the more work that can be performed.
There are three role priorities.
-
Primary: There can only be one primary per zone or region per role. When an appliance is started, the system looks to see if any role is set to primary. If that is the case, the role is activated on that appliance and deactivated from the secondary. In the console, primary roles are shown in bold letters. The text turns red if the server goes down. You must actively set the primary priority.
-
Secondary: This is the default priority. There can be multiple secondaries. When an appliance is started, if no primary is found in the zone, the first appliance to start takes the role. In the console, secondary roles are displayed normally with the word “secondary”.
-
Tertiary: If all appliances with primary roles or secondary roles were down, one of the tertiary would be activated. The reason for tertiary is to ensure that if a server with crucial roles such as Provider Inventory or Event Monitor goes down, you have a way to associate those roles to different appliances by organizing the priorities. Tertiary roles simply show as active in the console.
Region Aware Server Roles
| Role | More than one per Region | Can have Priority Set |
|---|---|---|
| Automation Engine | Y | N |
| Database Operations | Y | N |
| Notifier | N | Y |
| Reporting | Y | N |
| Scheduler | N | Y |
| User Interface | Y | N |
| Web Services | Y | N |
Setting the Priority of a Failover Role
To set the priority of a failover role:
-
Click (Configuration).
-
Click on the Diagnostics accordion, then click the Zone that you want to view.
-
Depending on how you want to view your servers, click either the Roles by Servers tab or the Servers by Roles tab.
-
In the Status of Roles for Servers in Zone Default Zone area, click on the role that you want to set the priority for.
-
Click (Configuration), and (Promote Server) to make this the primary server for this role.
-
Click (Configuration), and (Demote Server) to demote the priority of this server for this role.
Zone Diagnostics