- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ovirt_external_provider – Module to manage external providers in oVirt/RHV

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

- Module to manage external providers in oVirt/RHV

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.7

- ovirt-engine-sdk-python >= 4.3.0

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
auth dictionary / required |  | Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| ca_file string |  | 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.
| headers dictionary |  | Dictionary of HTTP headers to be added to each API call.
| hostname string |  | A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by `OVIRT_HOSTNAME` environment variable. Either `url` or `hostname` is required.
| insecure boolean | Choices: no yes | A boolean flag that indicates if the server TLS certificate and host name should be checked.
| kerberos boolean | Choices: no yes | A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
| password string / required |  | The password of the user. Default value is set by `OVIRT_PASSWORD` environment variable.
| token string |  | Token to be used instead of login with username/password. Default value is set by `OVIRT_TOKEN` environment variable.
| url string |  | A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by `OVIRT_URL` environment variable. Either `url` or `hostname` is required.
| username string / required |  | The name of the user, something like admin@internal. Default value is set by `OVIRT_USERNAME` environment variable.
authentication_keys - added in 2.6 | Default: [] | List of authentication keys. Each key is represented by dict like {'uuid': 'our-uuid', 'value': 'YourSecretValue=='} When you will not pass these keys and there are already some of them defined in the system they will be removed. Applicable for os_volume.
authentication_url - |  | Keystone authentication URL of the openstack provider. Applicable for those types: os_image, os_volume and network. aliases: auth_url
data_center - |  | Name of the data center where provider should be attached. Applicable for those type: os_volume.
description - |  | Description of the external provider.
fetch_nested boolean | Choices: no yes | 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 - |  | Name of the external provider to manage.
nested_attributes list |  | Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.
network_type - | Choices: external ← neutron Default: ["external"] | Type of the external network provider either external (for example OVN) or neutron. Applicable if `type` is network.
password - |  | Password of the user specified in `username` parameter. Applicable for all types.
poll_interval integer | Default: 3 | Number of the seconds the module waits until another poll request on entity status is sent.
read_only boolean | Choices: no yes | Specify if the network should be read only. Applicable if `type` is network.
state - | Choices: present ← absent | Should the external be present or absent When you are using absent for os_volume, you need to make sure that SD is not attached to the data center!
tenant_name - |  | Name of the tenant. Applicable for those types: os_image, os_volume and network. aliases: tenant
timeout integer | Default: 180 | The amount of time in seconds the module should wait for the instance to get into desired state.
type - | Choices: os_image network os_volume foreman | Type of the external provider.
url - |  | URL where external provider is hosted. Applicable for those types: os_image, os_volume, network and foreman.
username - |  | Username to be used for login to external provider. Applicable for all types.
wait boolean | Choices: no yes ← | `yes` if the module should wait for the entity to get into desired state.

## 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.3.0

## 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://1.2.3.4:9292
        username: admin
        password: 123456
        tenant: admin
        auth_url: http://1.2.3.4:35357/v2.0

    # Add volume external provider:
    - ovirt_external_provider:
        name: image_provider
        type: os_volume
        url: http://1.2.3.4:9292
        username: admin
        password: 123456
        tenant: admin
        auth_url: http://1.2.3.4:5000/v2.0
        authentication_keys:
          -
            uuid: "1234567-a1234-12a3-a234-123abc45678"
            value: "ABCD00000000111111222333445w=="

    # 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, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
external_host_provider dictionary | On success and if parameter 'type: foreman' is used. | 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.
id string | On success if external provider is found. | ID of the external provider which is managed Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
openstack_image_provider dictionary | On success and if parameter 'type: os_image' is used. | 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.
openstack_network_provider dictionary | On success and if parameter 'type: network' is used. | 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.
openstack_volume_provider dictionary | On success and if parameter 'type: os_volume' is used. | 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.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Ondra Machacek (@machacekondra)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.