community / community.general / 2.5.9 / module / ovirt_api_facts
Removed in 3.0.0
Reason:When migrating to collection we decided to use only _info modules. | Alternative:Use M(ovirt.ovirt.ovirt_api_info) instead.
Retrieve information about the oVirt/RHV API
Authors: Ondra Machacek (@machacekondra)
Install with ansible-galaxy collection install community.general:==2.5.9
collections: - name: community.general version: 2.5.9
Retrieve information about the oVirt/RHV API.
# Examples don't contain auth parameter for simplicity, # look at ovirt_auth module to see how to reuse authentication: - name: Gather information oVirt API ovirt_api_info: register: result
- name: Print gathered information ansible.builtin.debug: msg: "{{ result.ovirt_api }}"
auth: description: - 'Dictionary with values needed to create HTTP/HTTPS connection to oVirt:' - C(username)[I(required)] - The name of the user, something like I(admin@internal). Default value is set by I(OVIRT_USERNAME) environment variable. - C(password)[I(required)] - The password of the user. Default value is set by I(OVIRT_PASSWORD) environment variable. - C(url)- A string containing the API URL of the server, usually something like `I(https://server.example.com/ovirt-engine/api)`. Default value is set by I(OVIRT_URL) environment variable. Either C(url) or C(hostname) is required. - C(hostname) - A string containing the hostname of the server, usually something like `I(server.example.com)`. Default value is set by I(OVIRT_HOSTNAME) environment variable. Either C(url) or C(hostname) is required. - C(token) - Token to be used instead of login with username/password. Default value is set by I(OVIRT_TOKEN) environment variable. - C(insecure) - A boolean flag that indicates if the server TLS certificate and host name should be checked. - C(ca_file) - A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If `C(ca_file)` parameter is not set, system wide CA certificate store is used. Default value is set by I(OVIRT_CAFILE) environment variable. - C(kerberos) - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. - C(headers) - Dictionary of HTTP headers to be added to each API call. required: true type: dict fetch_nested: default: false description: - If I(yes) the module will fetch additional data from the API. - It will fetch only IDs of nested entity. It doesn't fetch multiple levels of nested attributes. Only the attributes of the current entity. User can configure to fetch other attributes of the nested entities by specifying C(nested_attributes). type: bool nested_attributes: description: - Specifies list of the attributes which should be fetched from the API. - This parameter apply only when C(fetch_nested) is I(true). type: list
ovirt_api: description: 'Dictionary describing the oVirt API information. Api attributes are mapped to dictionary keys, all API attributes can be found at following url: https://ovirt.example.com/ovirt-engine/api/model#types/api.' returned: On success. type: dict