community.general.manageiq_provider module – Management of provider in ManageIQ

Note

This module is part of the community.general collection (version 10.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.manageiq_provider.

Synopsis

• The manageiq_provider module supports adding, updating, and deleting provider in ManageIQ.

Requirements

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

• manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/

Parameters

Parameter	Comments
alerts dictionary	Alerts endpoint connection information.
auth_key string	Provider’s api endpoint authentication bearer token. defaults to None.
certificate_authority string	The CA bundle string with custom certificates. defaults to None.
hostname string / required	The provider’s api hostname.
password string	Provider’s api endpoint authentication password. defaults to None.
path string	TODO needs documentation.
port integer	The provider’s api port.
project string	TODO needs documentation.
role string	TODO needs documentation.
security_protocol string	How SSL certificates should be used for HTTPS requests. defaults to None. Choices: "ssl-with-validation" "ssl-with-validation-custom-ca" "ssl-without-validation" "non-ssl"
subscription string	TODO needs documentation.
uid_ems string	TODO needs documentation.
userid string	Provider’s api endpoint authentication userid. defaults to None.
validate_certs aliases: verify_ssl boolean	Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True. Choices: false true ← (default)
api_version string	The OpenStack Keystone API version. defaults to None. Choices: "v2" "v3"
azure_tenant_id aliases: keystone_v3_domain_id string	Tenant ID. defaults to None.
host_default_vnc_port_end string	The last port in the host VNC range. defaults to None.
host_default_vnc_port_start string	The first port in the host VNC range. defaults to None.
manageiq_connection dictionary	ManageIQ connection configuration information.
ca_cert aliases: ca_bundle_path string	The path to a CA bundle file or directory with certificates.
password string	ManageIQ password. MIQ_PASSWORD environment variable if set. Otherwise, required if no token is passed in.
token string	ManageIQ token. MIQ_TOKEN environment variable if set. Otherwise, required if no username or password is passed in.
url string	ManageIQ environment URL. MIQ_URL environment variable if set. Otherwise, it is required to pass it.
username string	ManageIQ username. MIQ_USERNAME environment variable if set. Otherwise, required if no token is passed in.
validate_certs aliases: verify_ssl boolean	Whether SSL certificates should be verified for HTTPS requests. Choices: false true ← (default)
metrics dictionary	Metrics endpoint connection information.
auth_key string	Provider’s api endpoint authentication bearer token. defaults to None.
certificate_authority string	The CA bundle string with custom certificates. defaults to None.
hostname string / required	The provider’s api hostname.
password string	Provider’s api endpoint authentication password. defaults to None.
path string	Database name for oVirt metrics. Defaults to ovirt_engine_history.
port integer	The provider’s api port.
project string	TODO needs documentation.
role string	TODO needs documentation.
security_protocol string	How SSL certificates should be used for HTTPS requests. defaults to None. Choices: "ssl-with-validation" "ssl-with-validation-custom-ca" "ssl-without-validation" "non-ssl"
subscription string	TODO needs documentation.
uid_ems string	TODO needs documentation.
userid string	Provider’s api endpoint authentication userid. defaults to None.
validate_certs aliases: verify_ssl boolean	Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True. Choices: false true ← (default)
name string / required	The provider’s name.
project string	Google Compute Engine Project ID. defaults to None.
provider dictionary	Default endpoint connection information, required if state is true.
auth_key string	Provider’s api endpoint authentication bearer token. defaults to None.
certificate_authority string	The CA bundle string with custom certificates. defaults to None.
hostname string / required	The provider’s api hostname.
password string	Provider’s api endpoint authentication password. defaults to None.
path string	TODO needs documentation.
port integer	The provider’s api port.
project string	TODO needs documentation.
role string	TODO needs documentation.
security_protocol string	How SSL certificates should be used for HTTPS requests. defaults to None. Choices: "ssl-with-validation" "ssl-with-validation-custom-ca" "ssl-without-validation" "non-ssl"
subscription string	TODO needs documentation.
uid_ems string	TODO needs documentation.
userid string	Provider’s api endpoint authentication userid. defaults to None.
validate_certs aliases: verify_ssl boolean	Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True. Choices: false true ← (default)
provider_region string	The provider region name to connect to (e.g. AWS region for Amazon).
ssh_keypair dictionary	SSH key pair used for SSH connections to all hosts in this provider.
auth_key string	SSH private key.
certificate_authority string	TODO needs documentation.
hostname string / required	Director hostname.
password string	TODO needs documentation.
path string	TODO needs documentation.
port integer	TODO needs documentation.
project string	TODO needs documentation.
role string	TODO needs documentation.
security_protocol string	TODO needs documentation. Choices: "ssl-with-validation" "ssl-with-validation-custom-ca" "ssl-without-validation" "non-ssl"
subscription string	TODO needs documentation.
uid_ems string	TODO needs documentation.
userid string	SSH username.
validate_certs aliases: verify_ssl boolean	Whether certificates should be verified for connections. Choices: false true ← (default)
state string	absent - provider should not exist, present - provider should be present, refresh - provider will be refreshed Choices: "absent" "present" ← (default) "refresh"
subscription string	Microsoft Azure subscription ID. defaults to None.
tenant_mapping_enabled boolean	Whether to enable mapping of existing tenants. defaults to False. Choices: false ← (default) true
type string	The provider’s type. Choices: "Openshift" "Amazon" "oVirt" "VMware" "Azure" "Director" "OpenStack" "GCE"
zone string	The ManageIQ zone name that will manage the provider. Default: "default"

Attributes

Attribute	Support	Description
check_mode	Support: none	Can run in check_mode and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Create a new provider in ManageIQ ('Hawkular' metrics)
  community.general.manageiq_provider:
    name: 'EngLab'
    type: 'OpenShift'
    state: 'present'
    provider:
      auth_key: 'topSecret'
      hostname: 'example.com'
      port: 8443
      validate_certs: true
      security_protocol: 'ssl-with-validation-custom-ca'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    metrics:
      auth_key: 'topSecret'
      role: 'hawkular'
      hostname: 'example.com'
      port: 443
      validate_certs: true
      security_protocol: 'ssl-with-validation-custom-ca'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    manageiq_connection:
      url: 'https://127.0.0.1:80'
      username: 'admin'
      password: 'password'
      validate_certs: true


- name: Update an existing provider named 'EngLab' (defaults to 'Prometheus' metrics)
  community.general.manageiq_provider:
    name: 'EngLab'
    type: 'Openshift'
    state: 'present'
    provider:
      auth_key: 'topSecret'
      hostname: 'next.example.com'
      port: 8443
      validate_certs: true
      security_protocol: 'ssl-with-validation-custom-ca'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    metrics:
      auth_key: 'topSecret'
      hostname: 'next.example.com'
      port: 443
      validate_certs: true
      security_protocol: 'ssl-with-validation-custom-ca'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    manageiq_connection:
      url: 'https://127.0.0.1'
      username: 'admin'
      password: 'password'
      validate_certs: true


- name: Delete a provider in ManageIQ
  community.general.manageiq_provider:
    name: 'EngLab'
    type: 'Openshift'
    state: 'absent'
    manageiq_connection:
      url: 'https://127.0.0.1'
      username: 'admin'
      password: 'password'
      validate_certs: true


- name: Create a new Amazon provider in ManageIQ using token authentication
  community.general.manageiq_provider:
    name: 'EngAmazon'
    type: 'Amazon'
    state: 'present'
    provider:
      hostname: 'amazon.example.com'
      userid: 'hello'
      password: 'world'
    manageiq_connection:
      url: 'https://127.0.0.1'
      token: 'VeryLongToken'
      validate_certs: true


- name: Create a new oVirt provider in ManageIQ
  community.general.manageiq_provider:
    name: 'RHEV'
    type: 'oVirt'
    state: 'present'
    provider:
      hostname: 'rhev01.example.com'
      userid: 'admin@internal'
      password: 'password'
      validate_certs: true
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    metrics:
      hostname: 'metrics.example.com'
      path: 'ovirt_engine_history'
      userid: 'user_id_metrics'
      password: 'password_metrics'
      validate_certs: true
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    manageiq_connection:
      url: 'https://127.0.0.1'
      username: 'admin'
      password: 'password'
      validate_certs: true

- name: Create a new VMware provider in ManageIQ
  community.general.manageiq_provider:
    name: 'EngVMware'
    type: 'VMware'
    state: 'present'
    provider:
      hostname: 'vcenter.example.com'
      host_default_vnc_port_start: 5800
      host_default_vnc_port_end: 5801
      userid: 'root'
      password: 'password'
    manageiq_connection:
      url: 'https://127.0.0.1'
      token: 'VeryLongToken'
      validate_certs: true

- name: Create a new Azure provider in ManageIQ
  community.general.manageiq_provider:
    name: 'EngAzure'
    type: 'Azure'
    provider_region: 'northeurope'
    subscription: 'e272bd74-f661-484f-b223-88dd128a4049'
    azure_tenant_id: 'e272bd74-f661-484f-b223-88dd128a4048'
    state: 'present'
    provider:
      hostname: 'azure.example.com'
      userid: 'e272bd74-f661-484f-b223-88dd128a4049'
      password: 'password'
    manageiq_connection:
      url: 'https://cf-6af0.rhpds.opentlc.com'
      username: 'admin'
      password: 'password'
      validate_certs: true

- name: Create a new OpenStack Director provider in ManageIQ with rsa keypair
  community.general.manageiq_provider:
    name: 'EngDirector'
    type: 'Director'
    api_version: 'v3'
    state: 'present'
    provider:
      hostname: 'director.example.com'
      userid: 'admin'
      password: 'password'
      security_protocol: 'ssl-with-validation'
      validate_certs: 'true'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    ssh_keypair:
      hostname: director.example.com
      userid: heat-admin
      auth_key: 'SecretSSHPrivateKey'

- name: Create a new OpenStack provider in ManageIQ with amqp metrics
  community.general.manageiq_provider:
    name: 'EngOpenStack'
    type: 'OpenStack'
    api_version: 'v3'
    state: 'present'
    provider_region: 'europe'
    tenant_mapping_enabled: 'False'
    keystone_v3_domain_id: 'mydomain'
    provider:
      hostname: 'openstack.example.com'
      userid: 'admin'
      password: 'password'
      security_protocol: 'ssl-with-validation'
      validate_certs: 'true'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    metrics:
      role: amqp
      hostname: 'amqp.example.com'
      security_protocol: 'non-ssl'
      port: 5666
      userid: admin
      password: password


- name: Create a new GCE provider in ManageIQ
  community.general.manageiq_provider:
    name: 'EngGoogle'
    type: 'GCE'
    provider_region: 'europe-west1'
    project: 'project1'
    state: 'present'
    provider:
      hostname: 'gce.example.com'
      auth_key: 'google_json_key'
      validate_certs: 'false'

Authors

• Daniel Korn (@dkorn)

Collection links

• Issue Tracker
• Repository (Sources)
• Ask for help
• Submit a bug report
• Request a feature
• Communication