community.general.manageiq_provider module – Management of provider in ManageIQ
Note
This module is part of the community.general collection (version 9.5.1).
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 endpoint connection information. |
|
Provider’s api endpoint authentication bearer token. defaults to None. |
|
The CA bundle string with custom certificates. defaults to None. |
|
The provider’s api hostname. |
|
Provider’s api endpoint authentication password. defaults to None. |
|
TODO needs documentation. |
|
The provider’s api port. |
|
TODO needs documentation. |
|
TODO needs documentation. |
|
How SSL certificates should be used for HTTPS requests. defaults to None. Choices:
|
|
TODO needs documentation. |
|
TODO needs documentation. |
|
Provider’s api endpoint authentication userid. defaults to None. |
|
Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True. Choices:
|
|
The OpenStack Keystone API version. defaults to None. Choices:
|
|
Tenant ID. defaults to None. |
|
The last port in the host VNC range. defaults to None. |
|
The first port in the host VNC range. defaults to None. |
|
ManageIQ connection configuration information. |
|
The path to a CA bundle file or directory with certificates. |
|
ManageIQ password. |
|
ManageIQ token. |
|
ManageIQ environment URL. |
|
ManageIQ username. |
|
Whether SSL certificates should be verified for HTTPS requests. Choices:
|
|
Metrics endpoint connection information. |
|
Provider’s api endpoint authentication bearer token. defaults to None. |
|
The CA bundle string with custom certificates. defaults to None. |
|
The provider’s api hostname. |
|
Provider’s api endpoint authentication password. defaults to None. |
|
Database name for oVirt metrics. Defaults to |
|
The provider’s api port. |
|
TODO needs documentation. |
|
TODO needs documentation. |
|
How SSL certificates should be used for HTTPS requests. defaults to None. Choices:
|
|
TODO needs documentation. |
|
TODO needs documentation. |
|
Provider’s api endpoint authentication userid. defaults to None. |
|
Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True. Choices:
|
|
The provider’s name. |
|
Google Compute Engine Project ID. defaults to None. |
|
Default endpoint connection information, required if state is true. |
|
Provider’s api endpoint authentication bearer token. defaults to None. |
|
The CA bundle string with custom certificates. defaults to None. |
|
The provider’s api hostname. |
|
Provider’s api endpoint authentication password. defaults to None. |
|
TODO needs documentation. |
|
The provider’s api port. |
|
TODO needs documentation. |
|
TODO needs documentation. |
|
How SSL certificates should be used for HTTPS requests. defaults to None. Choices:
|
|
TODO needs documentation. |
|
TODO needs documentation. |
|
Provider’s api endpoint authentication userid. defaults to None. |
|
Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True. Choices:
|
|
The provider region name to connect to (e.g. AWS region for Amazon). |
|
SSH key pair used for SSH connections to all hosts in this provider. |
|
SSH private key. |
|
TODO needs documentation. |
|
Director hostname. |
|
TODO needs documentation. |
|
TODO needs documentation. |
|
TODO needs documentation. |
|
TODO needs documentation. |
|
TODO needs documentation. |
|
TODO needs documentation. Choices:
|
|
TODO needs documentation. |
|
TODO needs documentation. |
|
SSH username. |
|
Whether certificates should be verified for connections. Choices:
|
|
absent - provider should not exist, present - provider should be present, refresh - provider will be refreshed Choices:
|
|
Microsoft Azure subscription ID. defaults to None. |
|
Whether to enable mapping of existing tenants. defaults to False. Choices:
|
|
The provider’s type. Choices:
|
|
The ManageIQ zone name that will manage the provider. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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'