ovirt_external_providers - Module to manage external providers in oVirt

New in version 2.3.

Synopsis

Module to manage external providers in oVirt

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`.
    password[required] - The password of the user.
    url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`.
    token - Token to be used instead of login with username/password.
    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.
    kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
    authentication_url
    		 no
      Keystone authentication URL of the openstack provider.
      Applicable for those types: os_image, os_volume and os_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.
          name
          		 no
            Name of the the external provider to manage.
            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.
                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 os_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
                    • os_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, os_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_providers:
    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_providers:
    name: foreman_provider
    type: foreman
    url: https://foreman.example.com
    username: admin
    password: 123456

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

                          Return Values

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

                          name description returned type sample
                          openstack_image_provider Dictionary of all the openstack_image_provider attributes. External provider attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_image_provider. On success and if parameter 'type: os_image' is used. dictionary
                          contains:
                          name description returned type sample
                          openstack_network_provider Dictionary of all the openstack_network_provider attributes. External provider attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_network_provider. On success and if parameter 'type: os_network' is used. dictionary
                          contains:
                          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 instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/external_host_provider. On success and if parameter 'type: foreman' is used. dictionary
                          contains:
                          name description returned type sample
                          id ID of the external provider which is managed On success if external provider is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
                          openstack_volume_provider Dictionary of all the openstack_volume_provider attributes. External provider attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/openstack_volume_provider. On success and if parameter 'type: os_volume' is used. dictionary
                          contains:
                          name description returned type sample


                          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

                          This is an Extras Module

                          For more information on what this means please read modules_extra

                          For help in developing on modules, should you be so inclined, please read community, developing_test_pr and developing_modules.