vmware.vmware.key_provider_info module – Gather information about one or more key providers in a vCenter instance.

Note

This module is part of the vmware.vmware collection (version 2.9.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware.

To use it in a playbook, specify: vmware.vmware.key_provider_info.

Synopsis

  • This module allows you to gather information about one or more key providers in a vCenter instance.

Parameters

Parameter

Comments

hostname

string

The hostname or IP address of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

password

aliases: pass, pwd

string

The password of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

provider_name

aliases: name, id

string

The name or ID of the key provider to gather information about.

If this is not provided, all key providers will be returned.

Only one of provider_name or type is allowed.

proxy_host

string

The address of a proxy that will receive all HTTPS requests and relay them.

The format is a hostname or a IP.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

The port of the HTTP proxy that will receive all HTTPS requests and relay them.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead.

type

string

The type of key provider to gather information about.

If this is not provided, all key provider types will be returned.

Only one of provider_name or type is allowed.

Choices:

  • "standard"

  • "native"

username

aliases: admin, user

string

The username of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • All modules require API write access and hence are not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

  • Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Examples

- name: Gather information about all key providers
  vmware.vmware.key_provider_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"

- name: Gather information about a specific key provider
  vmware.vmware.key_provider_info:
    provider_name: my-standard-key-provider

- name: Gather information about native key providers only
  vmware.vmware.key_provider_info:
    type: native

- name: Gather information about standard key providers only
  vmware.vmware.key_provider_info:
    type: standard

Return Values

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

Key

Description

key_providers

dictionary

Dictionary of key providers in the vCenter instance.

The key is the provider ID, the value is a dictionary with provider information.

Each provider includes id, type, and default.

Native providers also include backed_up and tpm_required.

Standard providers include a servers list with KMIP server details (id, address, port, username, proxy_address, proxy_port).

Returned: always

Sample: {"default-native-key-provider": {"backed_up": true, "default": true, "id": "default-native-key-provider", "tpm_required": true, "type": "native"}, "my-native-key-provider": {"backed_up": false, "default": false, "id": "my-native-key-provider", "tpm_required": true, "type": "native"}, "my-standard-key-provider": {"default": false, "id": "my-standard-key-provider", "servers": [{"address": "10.0.0.1", "id": "kms-server-1", "port": 5696, "proxy_address": "10.0.0.2", "proxy_port": 5697, "username": "kmsuser"}, {"address": "10.0.0.3", "id": "kms-server-2", "port": 5696, "proxy_address": "", "proxy_port": null, "username": ""}], "type": "standard"}}

Authors

  • Ansible Cloud Team (@ansible-collections)