hitachivantara.vspone_object.oneobject_node.hv_kmip_server_facts module – Get a list of KMIP servers

Note

This module is part of the hitachivantara.vspone_object collection (version 1.1.1).

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 hitachivantara.vspone_object. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_object.oneobject_node.hv_kmip_server_facts.

New in hitachivantara.vspone_object 1.0.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module queries a list of all configured external KMIP servers.

Requirements

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

python >= 3.7

Parameters

Parameter	Comments
connection_info dictionary / required	Information required to establish a connection to the system.
cluster_name string / required	Cluster name of the system.
http_request_retry_interval_seconds integer / required	Interval between retries of an HTTP request.
http_request_retry_times integer / required	Number of times to retry an HTTP request.
http_request_timeout integer / required	Timeout for HTTP requests.
oneobject_node_client_id string / required	Id for authentication.
oneobject_node_client_secret string	Secret for authentication.
oneobject_node_username string / required	Username for authentication.
oneobject_node_userpass string / required	Password for authentication.
region string / required	Region of the system.
ssl dictionary	SSL configuration.
ca_certs string	Path to the CA certificates file. Default: `""`
ca_path string	Path to the CA certificate file. Default: `""`
check_hostname boolean	Whether to check the hostname. Choices: `false` ← (default) `true`
client_cert string	Path to the client certificate file. Default: `""`
client_key string	Path to the client key file. Default: `""`
ssl_cipher string	SSL cipher to use. Default: `""`
ssl_version string	SSL version to use. Default: `""`
validate_certs boolean / required	Whether to validate SSL certificates. Choices: `false` `true`
spec dictionary	Request parameters for fetching kmip servers.
name string	The user-assigned name of the KMIP server you want to get information about. Type up to 63 Unicode characters.

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples

- name: List KMIP servers
  hitachivantara.vspone_object.oneobject_node.hv_kmip_server_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"

- name: Get KMIP server by name
  hitachivantara.vspone_object.oneobject_node.hv_kmip_server_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      name: "test_kmip_server"

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key	Description
kmip_servers dictionary	Contains detailed information about the KMIP servers. Returned: success
servers dictionary	Dictionary of KMIP servers keyed by their name. Returned: success
host string	The host name or IP address of the KMIP server. Returned: success Sample: `"urloripaddressofkmipserver"`
https_ciphers string	A string of comma-separated cyphers. Returned: success Sample: `"TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_AES_256_GCM_SHA384"`
is_online boolean	Whether the KMIP server is online. Returned: success Sample: `false`
is_primary boolean	Whether the KMIP server is the primary server. Returned: success Sample: `true`
is_tls12_enabled boolean	Whether TLS v1.2 is enabled on the KMIP server. Returned: success Sample: `true`
kmip_protocol string	The version of the KMIP protocol. Returned: success Sample: `"V1_3"`
name string	The name of the KMIP server. Returned: success Sample: `"test_kmip_server"`
port integer	The port number of the KMIP server. Returned: success Sample: `5696`
uuid string	The UUID of the server. Returned: success Sample: `"f2e39602-d960-4812-8c89-3b31212dfdca"`

Authors

Hitachi Vantara, LTD. (@hitachi-vantara)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/hitachivantara/vspone_object/oneobject_node.hv_kmip_server_facts_module.html