On this page
manageiq_provider - Management of provider in ManageIQ.
New in version 2.4.
Synopsis
- The manageiq_provider module supports adding, updating, and deleting provider in ManageIQ.
Requirements (on host that executes module)
- manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/
Options
parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
alerts |
no |
Alerts endpoint connection information.
|
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
manageiq_connection |
yes |
ManageIQ connection configuration information.
|
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
metrics |
no |
Metrics endpoint connection information.
|
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
name |
yes |
The provider's name.
|
|||||||||||||||||||||||||||||||||||||||||||||||
provider |
no |
Default endpoint connection information, required if state is true.
|
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
provider_region |
no |
The provider region name to connect to (e.g. AWS region for Amazon).
|
|||||||||||||||||||||||||||||||||||||||||||||||
state |
no | present |
|
absent - provider should not exist, present - provider should be, valid - provider authentication should be valid.
|
|||||||||||||||||||||||||||||||||||||||||||||
type |
yes |
|
The provider's type.
|
||||||||||||||||||||||||||||||||||||||||||||||
zone |
no | default |
The ManageIQ zone name that will manage the provider.
|
Examples
- name: Create a new provider in ManageIQ ('Hawkular' metrics)
manageiq_provider:
name: 'EngLab'
type: 'OpenShift'
provider:
auth_key: 'topSecret'
hostname: 'example.com'
port: 8443
verify_ssl: False
metrics:
role: 'hawkular'
hostname: 'example.com'
port: 443
verify_ssl: False
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
verify_ssl: False
- name: Update an existing provider named 'EngLab' (defaults to 'Prometheus' metrics)
manageiq_provider:
name: 'EngLab'
type: 'Openshift'
provider:
auth_key: 'verySecret'
hostname: 'next.example.com'
port: 8443
verify_ssl: False
metrics:
hostname: 'next.example.com'
port: 443
verify_ssl: False
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
verify_ssl: False
- name: Delete a provider in ManageIQ
manageiq_provider:
state: 'absent'
name: 'EngLab'
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
verify_ssl: False
- name: Create a new Amazon provider in ManageIQ using token authentication
manageiq_provider:
name: 'EngAmazon'
type: 'Amazon'
provider_region: 'us-east-1'
provider:
hostname: 'amazon.example.com'
userid: 'hello'
password: 'world'
manageiq_connection:
url: 'http://127.0.0.1:3000'
token: 'VeryLongToken'
verify_ssl: False
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/manageiq_provider_module.html