Docs4dev
Docs
ansible / 2.4 / ovirt_external_provider_module.html

ovirt_external_provider - Module to manage external providers in oVirt/RHV

New in version 2.3.

Synopsis

  • Module to manage external providers in oVirt/RHV

Requirements (on host that executes module)

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.0.0

Options

parameter required default choices comments
auth
 yes
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
username[required] - The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable.
password[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable.
url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable.
token - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable.
insecure - A boolean flag that indicates if the server TLS certificate and host name should be checked.
ca_file - A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If `ca_file` parameter is not set, system wide CA certificate store is used. Default value is set by OVIRT_CAFILE environment variable.
kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
headers - Dictionary of HTTP headers to be added to each API call.
authentication_url
 no
Keystone authentication URL of the openstack provider.
Applicable for those types: os_image, os_volume and network.
aliases: auth_url
data_center
 no
Name of the data center where provider should be attached.
Applicable for those type: os_volume.
description
 no
Description of the external provider.
fetch_nested
(added in 2.3)
no
If True the module will fetch additional data from the API.
It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying nested_attributes.
name
 no
Name of the external provider to manage.
nested_attributes
(added in 2.3)
no
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
network_type
 no [u'external']
  • external
  • neutron
Type of the external network provider either external (for example OVN) or neutron.
Applicable if type is network.
password
 no
Password of the user specified in username parameter.
Applicable for all types.
poll_interval
 no 3
Number of the seconds the module waits until another poll request on entity status is sent.
read_only
 no
Specify if the network should be read only.
Applicable if type is network.
state
 no present
  • present
  • absent
Should the external be present or absent
tenant_name
 no
Name of the tenant.
Applicable for those types: os_image, os_volume and network.
aliases: tenant
timeout
 no 180
The amount of time in seconds the module should wait for the instance to get into desired state.
type
 no
  • os_image
  • network
  • os_volume
  • foreman
Type of the external provider.
url
 no
URL where external provider is hosted.
Applicable for those types: os_image, os_volume, network and foreman.
username
 no
Username to be used for login to external provider.
Applicable for all types.
wait
 no
True if the module should wait for the entity to get into desired state.

Examples

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Add image external provider:
- ovirt_external_provider:
    name: image_provider
    type: os_image
    url: http://10.34.63.71:9292
    username: admin
    password: 123456
    tenant: admin
    auth_url: http://10.34.63.71:35357/v2.0/

# Add foreman provider:
- ovirt_external_provider:
    name: foreman_provider
    type: foreman
    url: https://foreman.example.com
    username: admin
    password: 123456

# Add external network provider for OVN:
- ovirt_external_provider:
    name: ovn_provider
    type: network
    network_type: external
    url: http://1.2.3.4:9696

# Remove image external provider:
- ovirt_external_provider:
    state: absent
    name: image_provider
    type: os_image

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
external_host_provider
Dictionary of all the external_host_provider attributes. External provider attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/external_host_provider.
On success and if parameter 'type: foreman' is used. dictionary
id
ID of the external provider which is managed
On success if external provider is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
openstack_image_provider
Dictionary of all the openstack_image_provider attributes. External provider attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_image_provider.
On success and if parameter 'type: os_image' is used. dictionary
openstack_network_provider
Dictionary of all the openstack_network_provider attributes. External provider attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_network_provider.
On success and if parameter 'type: network' is used. dictionary
openstack_volume_provider
Dictionary of all the openstack_volume_provider attributes. External provider attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_volume_provider.
On success and if parameter 'type: os_volume' is used. dictionary

Notes

Note

  • In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.0.0

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/ovirt_external_provider_module.html