Parameter |
Choices/Defaults |
Comments |
alerts
|
|
Alerts endpoint connection information.
|
|
hostname
required |
|
The provider's api hostname.
|
|
port
|
|
The provider's api port.
|
|
userid
|
|
Provider's api endpoint authentication userid. defaults to None.
|
|
password
|
|
Provider's api endpoint authentication password. defaults to None.
|
|
auth_key
|
|
Provider's api endpoint authentication bearer token. defaults to None.
|
|
verify_ssl
|
Default:
"yes"
|
Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
|
|
security_protocol
|
Choices:
- 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
|
|
The CA bundle string with custom certificates. defaults to None.
|
api_version
(added in 2.5) |
|
The OpenStack Keystone API version. defaults to None.
|
azure_tenant_id
(added in 2.5) |
|
Tenant ID. defaults to None.
aliases: keystone_v3_domain_id
|
host_default_vnc_port_end
(added in 2.5) |
|
The last port in the host VNC range. defaults to None.
|
host_default_vnc_port_start
(added in 2.5) |
|
The first port in the host VNC range. defaults to None.
|
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.
|
metrics
|
|
Metrics endpoint connection information.
|
|
hostname
required |
|
The provider's api hostname.
|
|
port
|
|
The provider's api port.
|
|
userid
|
|
Provider's api endpoint authentication userid. defaults to None.
|
|
password
|
|
Provider's api endpoint authentication password. defaults to None.
|
|
auth_key
|
|
Provider's api endpoint authentication bearer token. defaults to None.
|
|
verify_ssl
bool |
|
Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
|
|
security_protocol
|
Choices:
- ssl-with-validation
- ssl-with-validation-custom-ca
- ssl-without-validation
- non-ssl
|
How SSL certificates should be used for HTTPS requests. defaults to None.
|
|
certificate_authority
|
|
The CA bundle string with custom certificates. defaults to None.
|
|
path
|
Default:
"ovirt_engine_history"
|
Database name for oVirt metrics. Defaults to ovirt_engine_history.
|
name
required |
|
The provider's name.
|
project
(added in 2.5) |
|
Google Compute Engine Project ID. defaults to None.
|
provider
|
|
Default endpoint connection information, required if state is true.
|
|
hostname
required |
|
The provider's api hostname.
|
|
port
|
|
The provider's api port.
|
|
userid
|
|
Provider's api endpoint authentication userid. defaults to None.
|
|
password
|
|
Provider's api endpoint authentication password. defaults to None.
|
|
auth_key
|
|
Provider's api endpoint authentication bearer token. defaults to None.
|
|
verify_ssl
bool |
|
Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
|
|
security_protocol
|
Choices:
- ssl-with-validation
- ssl-with-validation-custom-ca
- ssl-without-validation
- non-ssl
|
How SSL certificates should be used for HTTPS requests. defaults to None.
|
|
certificate_authority
|
|
The CA bundle string with custom certificates. defaults to None.
|
provider_region
|
|
The provider region name to connect to (e.g. AWS region for Amazon).
|
ssh_keypair
(added in 2.5) |
|
SSH key pair used for SSH connections to all hosts in this provider.
|
|
hostname
required |
|
Director hostname.
|
|
userid
|
|
SSH username.
|
|
auth_key
|
|
SSH private key.
|
state
|
Choices:
- absent
present ←
- refresh
|
absent - provider should not exist, present - provider should be present, refresh - provider will be refreshed
|
subscription
(added in 2.5) |
|
Microsoft Azure subscription ID. defaults to None.
|
tenant_mapping_enabled
bool
(added in 2.5) |
|
Whether to enable mapping of existing tenants. defaults to False.
|
type
required |
Choices:
- Openshift
- Amazon
- oVirt
- VMware
- Azure
- Director
- OpenStack
- GCE
|
The provider's type.
|
zone
|
Default:
"default"
|
The ManageIQ zone name that will manage the provider.
|