Documentation

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.

Options

parameter required default choices comments
alerts
 no
Alerts endpoint connection information.
Dictionary object alerts
parameter required default choices comments
auth_key
 no
Provider's api endpoint authentication bearer token. defaults to None.
hostname
 yes
The provider's api hostname.
userid
 no
Provider's api endpoint authentication userid. defaults to None.
verify_ssl
 no True
Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
security_protocol
 no None
  • ssl-with-validation
  • ssl-with-validation-custom-ca
  • ssl-without-validation
How SSL certificates should be used for HTTPS requests. defaults to None.
certificate_authority
 no
The CA bundle string with custom certificates. defaults to None.
password
 no
Provider's api endpoint authentication password. defaults to None.
port
 no
The provider's api port.
manageiq_connection
 yes
ManageIQ connection configuration information.
Dictionary object manageiq_connection
parameter required default choices comments
username
 no
ManageIQ username. MIQ_USERNAME env var if set. otherwise, required if no token is passed in.
verify_ssl
 no True
Whether SSL certificates should be verified for HTTPS requests. defaults to True.
url
 yes
ManageIQ environment url. MIQ_URL env var if set. otherwise, it is required to pass it.
ca_bundle_path
 no
The path to a CA bundle file or directory with certificates. defaults to None.
password
 no
ManageIQ password. MIQ_PASSWORD env var if set. otherwise, required if no token is passed in.
token
 no
ManageIQ token. MIQ_TOKEN env var if set. otherwise, required if no username or password is passed in.
metrics
 no
Metrics endpoint connection information.
Dictionary object metrics
parameter required default choices comments
auth_key
 no
Provider's api endpoint authentication bearer token. defaults to None.
hostname
 yes
The provider's api hostname.
userid
 no
Provider's api endpoint authentication userid. defaults to None.
verify_ssl
 no True
Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
security_protocol
 no None
  • ssl-with-validation
  • ssl-with-validation-custom-ca
  • ssl-without-validation
How SSL certificates should be used for HTTPS requests. defaults to None.
certificate_authority
 no
The CA bundle string with custom certificates. defaults to None.
password
 no
Provider's api endpoint authentication password. defaults to None.
port
 no
The provider's api port.
name
 yes
The provider's name.
provider
 no
Default endpoint connection information, required if state is true.
Dictionary object provider
parameter required default choices comments
auth_key
 no
Provider's api endpoint authentication bearer token. defaults to None.
hostname
 yes
The provider's api hostname.
userid
 no
Provider's api endpoint authentication userid. defaults to None.
verify_ssl
 no True
Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
security_protocol
 no None
  • ssl-with-validation
  • ssl-with-validation-custom-ca
  • ssl-without-validation
How SSL certificates should be used for HTTPS requests. defaults to None.
certificate_authority
 no
The CA bundle string with custom certificates. defaults to None.
password
 no
Provider's api endpoint authentication password. defaults to None.
port
 no
The provider's api port.
provider_region
 no
The provider region name to connect to (e.g. AWS region for Amazon).
state
 no present
  • absent
  • present
absent - provider should not exist, present - provider should be, valid - provider authentication should be valid.
type
 yes
  • Openshift
  • Amazon
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.