ManageIQ

Versions: Latest / Quinteros / Petrosian / Oparin / Najdorf / Morphy / Lasker / Kasparov / Jansa / Ivanchuk / Hammer / Gaprindashvili / Fine / Euwe

Table of Contents

1. Policies
- 1.1. Control Policies
- 1.2. Compliance Policies
2. Conditions
3. Actions
4. Policy Profiles
Appendix A: Appendix

1. Policies

Policies are used to manage your virtual environment. There are two types of policies available: compliance and control. Compliance policies are used to harden your virtual infrastructure, making sure that your security requirements are adhered to. Control policies are used to check for a specific condition and perform an action based on the outcome. For example:

Prevent virtual machines from running without an administrator account.
Prevent virtual machines from starting if certain patches are not applied.
Configure the behavior of a production virtual machine to only start if it is running on a production host.
Force a SmartState Analysis when a host is added or removed from a cluster.

1.1. Control Policies

A control policy is a combination of an event, a condition, and an action. This combination provides management capabilities in your virtual environment.

An event is a trigger to check a condition.
A condition is a test triggered by an event.
An action is an execution that occurs if a condition is met.

1.1.1. Creating Control Policies

Create control policies by combining an event, a condition, and an action. Plan carefully the purpose of your policy before creating it. You can also use a scope expression that is tested immediately when the policy is triggered by an event. If the item is out of scope, then the policy does not continue on to the conditions, and none of the associated actions run.

The procedure below describes how to create a control policy, its underlying conditions, and assign its events and actions in one process. Conditions and custom actions can be created separately as well. Those procedures are described in later sections in conditions and actions. Also, a description of all events is provided in events.

Navigate to Control Explorer.
Click the Policies accordion, and select Control Policies.
Select either Host Control Policies or VM Control Policies or Replicator Control Policies or Pod Control Policies or Container Node Control Policies or Container Image Control Policies.
Click (Configuration), (Add a New Host / VM / Replicator / Pod / Node / Image Control Policy).
Type in a Description.
Uncheck Active if you do not want this policy processed even when assigned to a resource.
You can enter a Scope here (You can also create a scope as part of a condition, or not use one at all). If the host or virtual machine is not included in the scope, no actions will be run.
In the Notes area, add a detailed explanation of the policy.
Click Add. You are brought to the page where you add conditions and events to your new policy.
Click (Configuration) to associate conditions, events, and actions with the policy.

1.1.2. Editing Basic Information, Scope, and Notes for a Policy

As your enterprise’s needs change, you can change the name of a policy or its scope. If the items being evaluated are out of scope, policy processing stops and no actions run.

Navigate to Control Explorer.
Click the Policies accordion, and select the policy to edit.
Click (Configuration), (Edit Basic Info, Scope, and Notes).
In the Scope area, create a general condition based on a simple attribute. Or, click on an existing expression to edit it. Based on what you choose, different options appear. Configuring a Scope is optional for a policy.
- Click Field to create criteria based on field values.
- Click Count of to create criteria based on the count of something, such as the number of snapshots for a virtual machine, or the number of virtual machines on a host.
- Click Tag to create criteria based on tags assigned to your resources. For example, you can check the power state of a virtual machine or see if it is tagged as production.
- Click Find to seek a particular value, and then check a property. For example, finding the Admin account and checking that it is enabled. Use the following check commands:
  - Check Any: The result is true if one or more of the find results satisfy the check condition.
  - Check All: All of the find results must match for a true result.
  - Check Count: If the result satisfies the expression in check count, the result is true.
- Click Registry to create criteria based on registry values. For example, you can check if DCOM is enabled on a Windows System. Note that this applies only to Windows operating systems. Registry will only be available if you are editing a VM Control Policy.
Click (Commit Expression Element Changes) to add the scope.
In the Notes area, make the required changes.
Click Save.

1.1.3. Copying a Policy

You can copy a policy if its contents are similar to a new one that you want to create, then change the condition or event associated with it. This enables you to make new policies efficiently.

Navigate to Control Explorer.
Click the Policies accordion, and select the policy you want to copy.
Click (Configuration), and an option to copy the policy should appear; for example, (Copy this Image Policy).
Click OK to confirm.

The new policy is created with a prefix of Copy of in its description, and it can be viewed in the Policy accordion.

1.1.4. Deleting a Policy

You can remove policies that you no longer need. You can only remove policies that are not assigned to a policy profile.

Navigate to Control Explorer.
Click the Policies accordion, and select the policy you want to remove.
Click (Configuration), (Delete this Host/VM and Instance/Replicator/Pod/Node/Image Policy).
Click OK to confirm.

1.1.5. Creating a New Policy Condition

If you have not already created a condition to use with this policy, you can create one directly from inside the policy. A condition can contain two elements: a scope, and an expression. The expression is mandatory, but the scope is optional. A scope is a general attribute that is quickly checked before evaluating a more complex expression. You can create a scope at either the policy or condition level.

Navigate to Control Explorer.
Click the Policies accordion, and select the policy you want to create a new condition for.
Click (Configuration), (Create a new Condition assigned to this Policy).
Type in a Description for the condition. It must be unique to all the conditions.
Click (Edit this Scope) in the Scope area to create a general expression based on a simple attribute, such as operating system version. Based on what you choose, different options display. Scope is optional.
- Click Field to create criteria based on field values.
- Click Count of to create criteria based on the count of something, such as the number of snapshots for a virtual machine, or the number of virtual machines on a host.
- Click Tag to create criteria based on tags assigned to your resources. For example, you can check the power state of a virtual machine or see if it is tagged as production.
- Click Find to seek a particular value, and then check a property. For example, finding the Admin account and checking that it is enabled. Use the following check commands:
  - Check Any: The result is true if one or more of the find results satisfy the check condition.
  - Check All: All of the find results must match for a true result.
  - Check Count: If the result satisfies the expression in check count, the result is true.
- Click Registry to create criteria based on registry values. For example, you can check if DCOM is enabled on a Windows System. Note that this applies only to Windows operating systems. Registry is only available if you are creating a VM Control Policy.
Click (Commit expression element changes) to add the scope.
Click (Edit this Expression) in the Expression area. Based on what you choose, options display as per the choices presented in the Scope area detailed above.
Click (Commit Expression Element Changes) to add the expression.
In Notes, type in a detailed explanation of the condition.
Click Add.

The condition is created and is assigned directly to the policy. Note that the condition can be assigned to other policies.

1.1.6. Editing Policy Condition Assignments

Use this procedure to use a condition that has already been created either separately or as part of another policy. You can also remove a condition from a policy that no longer applies.

Navigate to Control Explorer.
Click the Policies accordion, and select the policy you want to assign conditions to.
Click (Configuration), (Edit this Policy’s Condition assignments).
From the Condition Selection area, you can assign conditions to the policy, remove all conditions from the policy, or remove specific conditions from the policy.
- To add one or several conditions, select all the conditions you want to apply from the Available Conditions box. Use Ctrl to add multiple conditions to a policy. Then, click (Move selected Conditions into this Policy).
- Click (Remove all Conditions from this Policy) to unassign any conditions from this policy.
- To remove one or some conditions, select all the conditions you want to remove from the Policy Conditions box. Use Ctrl to select multiple conditions. Then, click (Remove selected Conditions from this Policy)
Click Save.

1.1.7. Editing Policy Event Assignments

The policy evaluates its scopes and conditions when specified events occur in your virtual infrastructure. This procedure enables you to select those events and the actions that should occur based on the evaluation of the scopes and conditions for the policy.

Navigate to Control Explorer.
Click the Policies accordion and select the control policy you want to assign events to.
Click (Configuration), (Edit this Policy’s Event assignments).
Check all the events you want to assign to this policy.
Click Save.

1.1.8. Assigning an Action to an Event

This procedure describes how to assign an action to an event.

Navigate to Control Explorer.
Click the Policies accordion, and select the policy you want to assign actions to.
From the Events area, click on the description of the event you want to assign an action to.
Click (Configuration), (Edit Actions for this Policy Event).

Select all the appropriate actions from the Available Actions box, inside the Order of Actions if ALL Conditions are True. These are the actions that will take place if the resources meet the Condition of the Policy.

Each selected action can be executed synchronously or asynchronously; synchronous actions will not start until the previous synchronous action is completed, and asynchronous action allows the next action to start whether or not the first action has completed. Also, at least one ManageIQ server in the ManageIQ zone must have the notifier server role enabled for the trap to be sent.

Click the add button ( ), then:
- Click the action, then click (Set selected Actions to Asynchronous) to make it asynchronous.
- Click the action, then click (Set selected Actions to Synchronous) to make it synchronous. If creating a synchronous action, use the up and down arrows to identify in what order you want the actions to run.
Select all the actions from the appropriate Available Actions box, inside of the Order of Actions if ANY Conditions are False. These are the actions that take place if the resources do not meet the condition of the policy.
Click Save.

1.2. Compliance Policies

Compliance policies are specifically designed to secure your environment by checking conditions that you create. These conditions can include the same conditions that you would use in a control policy, and most of the procedures are the same. However, a compliance policy automatically assigns the mark as a compliant action when the entity type (virtual machine or host, for example) to which the policy applies passes all of the conditions. If any of the conditions are not met, then the virtual machine or host is marked as non-compliant. The compliance status is shown in the summary screen for the entity type and on the compare and drift screens.

1.2.1. Creating a Compliance Policy

Create compliance policies by assigning or creating a condition. ManageIQ automatically assigns the events and actions to the compliance policy as opposed to a control policy where you must define this yourself. The entity type (VM or host, for example) compliance check event is assigned to the compliance policy. A compliance policy runs the mark as compliant action when the virtual machine or host passes all of the conditions. If any of the conditions are not met, then the virtual machine or host is marked as non-compliant.

If you do not know how to create a condition, see Creating a New Policy Condition. Carefully plan the purpose of your policy before creating it. You can also use a scope expression that is tested immediately when the compliance check event triggers the policy. If the item is out of scope, then the policy does not continue on to the conditions, and none of the associated actions run.

Navigate to Control Explorer.
Click on the Policies accordion, and select Compliance Policies.
Select either Host Compliance Policies or VM Compliance Policies or Replicator Compliance Policies or Pod Compliance Policies or Container Node Compliance Policies or Container Image Compliance Policies.
Click (Configuration), (Add a new Compliance Policy).
Type in a Description for the policy.
Uncheck Active if you do not want this policy processed even when assigned to a resource.
You can enter a scope here. (You can also create a scope as part of a condition, or not use one at all.) If the host or virtual machine is not included in the scope, no actions run.
In the Notes area, add a detailed explanation of the policy.
Click Add.

You should add one or several conditions:

You can create a new condition by clicking (Configuration), (Create a new Condition assigned to this Policy), as described in Creating a New Policy Condition.
You can use an existing condition by clicking (Configuration), (Edit this Policy’s Condition assignments), as described in Editing Policy Condition Assignments.

By default, if any of the conditions are false, the virtual machine is marked as non-compliant. To add other actions, such as sending an email if the virtual machine fails the compliance test:

Click the Compliance Check event under the policy (exact name depends on entity type, for example VM Compliance Check).
Click (Configuration), (Edit Actions for this Policy Event).
Select Stop Virtual Machine and Send Email from the Available Actions area in Order of Actions if ANY conditions are False. (Mark as Non-Compliant should already be selected.)
Click (Move selected Actions into this Event).
Click Add.

You can now make this part of a policy profile. After assigning the policy profile to the virtual machine, you can check it for its compliance status either on a schedule or on demand.

1.2.2. Creating a Compliance Condition to Check Host File Contents

ManageIQ Control provides the ability to create a compliance condition that checks file contents. Use this to be sure that internal operating system settings meet your security criteria. Regular expressions are used to create the search pattern. Test your regular expressions thoroughly before using them in a production environment.

Note that to search file contents you will need to have collected the file using a host analysis profile.

Navigate to Control Explorer.
Click the Conditions accordion, and select Host Conditions.
Click (Configuration), (Add a New Host Condition).
In Basic Information, type in a Description for the condition.
Editing the Scope area is not necessary for this procedure. Skip editing any Scope conditions.
If the Expression area is not automatically opened, click (Edit this Expression), then edit the condition area to create a general condition based on a simple attribute. Based on what you choose, different options appear.
- Click Find, then Host.Files : Name, and the parameters to select the file that you want to check.
- Click Check Any, Contents, Regular Expression Matches, and type the expression. For example, if you want to make sure that permit root login is set to no, type ^\s*PermitRootLogin\s+no.
Click (Commit expression element changes) to add the expression.
In Notes area, type in a detailed explanation of the condition.
Click Add.

1.2.3. Checking for Compliance

After you have created your compliance policies and assigned them to a policy profile, you can check compliance in two ways. You can either schedule the compliance check or perform the check directly from the summary screen.

The compliance check runs all compliance policies that are assigned to the host or virtual machine. If the item fails any of the checks, it is marked as non-compliant in the item’s summary screen.

To schedule, you must have EvmRole-administrator access to the ManageIQ server.

Scheduling a Compliance Check

Click (Configuration).
Click the Settings accordion, and select Schedules.
Click (Configuration), (Add a new Schedule).
In the Adding a new Schedule area, type in a name and description for the schedule.
Select Active if you want to enable this scan.
From the Action dropdown, select the type of compliance check you want to schedule. Depending on the type of analysis you choose, you are presented with one of the following group boxes:
- If you choose VM Compliance Check, you are presented with VM Selection where you can choose to check all VMs, all VMs for a specific provider, all VMs for a cluster, all VMs for a specific host, a single VM, or you can select VMs using a global filter.
- If you choose Host Compliance Check, you are presented with Host Selection where you can choose to analyze all hosts, all hosts for a specific provider, all hosts for a cluster, a single host, or you can select hosts using a global filter.
- If you choose Container Image Compliance Check, you are presented with Image Selection where you can choose to analyze all images, all images for a specific provider, or a single image.

You can only schedule a host analysis 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.

From the Run dropdown, select how often you want the analysis to run. Your options after that depend on which run option you choose.
- Select Once to have the analysis run just one time.
- Select Daily to run the analysis on a daily basis. You are prompted to select how many days you want between each analysis.
- Select Hourly to run the analysis hourly. You are prompted to select how many hours you want between each analysis.
Select the time zone for the schedule.
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.

Checking a Virtual Machine for Compliance from the Summary Screen

Navigate to Compute Infrastructure Virtual Machines, select the virtual machine you want to check for compliance.
Click (Policy), and then (Check Compliance of Last Known Configuration).
A confirmation message appears. Click OK.
To view the compliance history, click on the virtual machine. Under Compliance, if History is Available, click on it to see its compliance history.

Checking a Host for Compliance from the Summary Screen

Navigate to Compute Infrastructure Hosts, click the host you want to check for compliance.
Click (Policy), and then (Check Compliance of Last Known Configuration) or (Analyze then Check Compliance).
To view the compliance history, click Available next to History.

Checking a Replicator for Compliance from the Summary Screen

Navigate to Compute Containers Replicators, select the replicator you want to check for compliance.
Click (Policy), and then (Check Compliance of Last Known Configuration).
A confirmation message appears. Click OK.
. To view the compliance history, click on the replicator. Under Compliance, if History is Available, click to see its compliance history.

Checking a Pod for Compliance from the Summary Screen

Navigate to Compute Containers Pods, select the pod you want to check for compliance.
Click (Policy), and then (Check Compliance of Last Known Configuration).
A confirmation message appears. Click OK.
To view the compliance history, click on the pod. Under Compliance, if History is Available, click to see its compliance history.

Checking a Container Node for Compliance from the Summary Screen

Navigate to Compute Containers Container Nodes, click the node you want to check for compliance.
Click (Policy), and then (Check Compliance of Last Known Configuration).
A confirmation message appears. Click OK.
To view the compliance history, click on the node. Under Compliance, if History is Available, click to see its compliance history.

Checking a Container Image for Compliance from the Summary Screen

Navigate to Compute Infrastructure Container Images, select the container image you want to check for compliance.
Click (Policy), and then (Check Compliance of Last Known Configuration).
A confirmation message appears. Click OK.
To view the compliance history, click on the container image. Under Compliance, if History is Available, click to see its compliance history.

2. Conditions

Conditions are tests performed on attributes of virtual machines. A condition can contain two elements, a scope, and an expression. The expression is mandatory, but the scope is optional. A scope is a general attribute that is quickly checked before evaluating a more complex expression. For example, you might use a scope to check the operating system, and use an expression to check for a specific set of applications or security patches that only apply to the operating system referenced in the scope. If no conditions, scope or expression, are defined for a policy, the policy is considered unconditional and returns a true value.

2.1. Creating a Condition

You can create a condition either from within a policy screen or by going directly to the expression editor in the ManageIQ console. You need to define a description and an expression element. The expression element defines what criteria you want to use to test the condition.

Navigate to Control Explorer.
Click the Conditions accordion, and select either Host / Node Conditions or VM and Instance Conditions or Replicator Conditions or Pod or Node Conditions or Image Conditions.
Click (Configuration), then (Add a New Host / VM / Replicator / Pod / Node / Image Condition).
Enter a Description for the condition.
Click Edit this Scope in the Scope area to create a general condition based on a simple attribute. Based on what you choose, different options appear. Creating a scope is optional.
- Click Field to create criteria based on field values.
- Click Count of to create criteria based on the count of something, such as the number of network adapters on the host.
- Click Tag to create criteria based on tags assigned to your resources. For example, you can check the power state of a virtual machine or see if it is tagged as production.
- Click Find to seek a particular value, and then check a property. For example, finding the Admin account and checking that it is enabled. Use the following check commands:
  - Check Any: The result is true if one or more of the find results satisfy the check condition.
  - Check All: All of the find results must match for a true result.
  - Check Count: If the result satisfies the expression in check count, the result is true.
- Click Registry to create criteria based on registry values. For example, you can check if DCOM is enabled on a Windows System. Note that this applies only to Windows operating systems. Registry will only be available if you are creating a VM Condition.
Click (Commit expression element changes) to add the scope.
Click Edit this Expression in the Expression area to create a general condition based on a simple attribute. Based on what you choose, different options appear.
- Click Field to create criteria based on field values.
- Click Count of to create criteria based on the count of something, such as the number of snapshots for a virtual machine, or the number of virtual machines on a host.
- Click Tag to create criteria based on tags assigned to your resources. For example, you can check the power state of a virtual machine or see if it is tagged as production.
- Click Find to seek a particular value, and then check a property. For example, finding the Admin account and checking that it is enabled. Use the following check commands.
  - Check Any: The result is true if one or more of the find results satisfy the check condition.
  - Check All: All of the find results must match for a true result.
  - Check Count: If the result satisfies the expression in check count, the result is true.
- Click Registry to create criteria based on registry values. For example, you can check if DCOM is enabled on a Windows System. Note that this applies only to Windows operating systems.
Click (Commit expression element changes) to add the expression.
In Notes, type in a detailed explanation of the condition.
Click Add.

2.2. Editing a Condition

Edit a condition to add more expressions to it or modify its properties. You can edit conditions that you have created.

Navigate to Control Explorer.
Click the Conditions accordion, and click on the condition you want to edit.
Click (Configuration), (Edit this Condition).
Click in either the Scope or Expression area, and click the part of the condition to edit.
Make any edits for the current expression.
- Click (Commit expression element changes) to add the changes.
- Click (Undo the previous change) to cancel the last action executed.
- Click (Redo the previous change) to repeat the previous action executed.
- Click (AND with a new expression element) to create a logical AND with a new expression element.
- Click (OR with a new expression element) to create a logical OR with a new expression element.
- Click (Wrap this expression element with a NOT) to create a logical NOT on an expression element
- Click (Remove this expression element) to take out the current expression element.
When you have made all of the changes to the condition, click Save.

2.3. Copying a Condition

You can copy a condition to create a similar condition, then change the values associated with it. You can copy the sample conditions provided to customize them to your environment.

Navigate to Control Explorer.
Click the Conditions accordion, and select the condition you want to copy.
Click (Configuration), (Copy this Condition to a new Condition).
Make any changes you need for the new condition. The description must be unique to all conditions.
Click Add.

2.4. Deleting a Condition

Remove conditions that are no longer applicable. You can only delete conditions that are not part of a policy. To be able to delete the condition, you must remove the policy first.

Navigate to Control Explorer.
Click the Conditions accordion, and click on the condition you want to remove.
Click (Configuration), (Delete this VM and Instance Condition).
Click OK to confirm.

3. Actions

Actions are performed after the condition is evaluated. Control comes with a set of default actions that you can choose from. You can also create some of your own.

Table 1. Default Actions and Descriptions
Action	Description
Cancel vCenter Task	Stop current vCenter Task. Due to limitations of vCenter, this applies only to cloning tasks.
Check Host or VM Compliance	Run compliance checks.
Collect Running Processes on VM Guest OS	Collect the list of running processes from the guest operating system.
Connect All CD-ROM Drives for Virtual Machine	Connect all the CD-ROM drives for the virtual Machine.
Connect All Floppy Drives for Virtual Machine	Connect all the floppy drives for the virtual machine.
Connect All Floppy and CD-ROM Drives for Virtual Machine	Connect all of the floppy and CD-ROM drives for virtual machine.
Convert to Template	Convert this virtual machine to a template.
Delete all Snapshots	Remove all snapshots for a virtual machine.
Delete Most Recent Snapshot	Removes a virtual machine’s most recent snapshot.
Delete VM from Disk	Remove the virtual machine from disk.
Disconnect All CD-ROM Drives for Virtual Machine	Disconnect all the CD-ROM drives for the virtual machine.
Disconnect All Floppy Drives for Virtual Machine	Disconnect all the floppy drives for the virtual machine.
Disconnect All Floppy and CD-ROM Drives for Virtual Machine	Disconnect all of the floppy and CD-ROM drives for virtual machine.