Documentation
  • Docs »
  • manageiq_policies - Management of resource policy_profiles in ManageIQ.

manageiq_policies - Management of resource policy_profiles in ManageIQ.

New in version 2.5.

Synopsis

  • The manageiq_policies module supports adding and deleting policy_profiles in ManageIQ.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
manageiq_connection
required
ManageIQ connection configuration information.
url
required
ManageIQ environment url. MIQ_URL env var if set. otherwise, it is required to pass it.
username
ManageIQ username. MIQ_USERNAME env var if set. otherwise, required if no token is passed in.
password
ManageIQ password. MIQ_PASSWORD env var if set. otherwise, required if no token is passed in.
token
ManageIQ token. MIQ_TOKEN env var if set. otherwise, required if no username or password is passed in.
verify_ssl Default:
"yes"
Whether SSL certificates should be verified for HTTPS requests. defaults to True.
ca_bundle_path
The path to a CA bundle file or directory with certificates. defaults to None.
policy_profiles
list of dictionaries, each includes the policy_profile 'name' key.
required if state is present or absent.
resource_name
required
the name of the resource to which the profile should be [un]assigned
resource_type
required
    Choices:
  • provider
  • host
  • vm
  • blueprint
  • category
  • cluster
  • data store
  • group
  • resource pool
  • service
  • service template
  • template
  • tenant
  • user
the type of the resource to which the profile should be [un]assigned
state
    Choices:
  • absent
  • present ←
  • list
absent - policy_profiles should not exist,
present - policy_profiles should exist,
list - list current policy_profiles and policies.

Examples

- name: Assign new policy_profile for a provider in ManageIQ
  manageiq_policies:
    resource_name: 'EngLab'
    resource_type: 'provider'
    policy_profiles:
      - name: openscap profile
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      verify_ssl: False

- name: Unassign a policy_profile for a provider in ManageIQ
  manageiq_policies:
    state: absent
    resource_name: 'EngLab'
    resource_type: 'provider'
    policy_profiles:
      - name: openscap profile
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      verify_ssl: False

- name: List current policy_profile and policies for a provider in ManageIQ
  manageiq_policies:
    state: list
    resource_name: 'EngLab'
    resource_type: 'provider'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      verify_ssl: False

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
manageiq_policies
dict
 always
List current policy_profile and policies for a provider in ManageIQ

Sample:
{ "changed": false, "profiles": [ { "policies": [ { "active": true, "description": "OpenSCAP", "name": "openscap policy" }, { "active": true, "description": "Analyse incoming container images", "name": "analyse incoming container images" }, { "active": true, "description": "Schedule compliance after smart state analysis", "name": "schedule compliance after smart state analysis" } ], "profile_description": "OpenSCAP profile", "profile_name": "openscap profile" } ] }


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Daniel Korn (@dkorn)

Hint

If you notice any issues in this documentation you can edit this document to improve it.