Horizon feed (discovery) plugin

Note

This module is part of the evertrust.horizon collection (version 1.5.0).

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 evertrust.horizon.

To use it in a playbook, specify: evertrust.horizon.horizon_feed.

Synopsis

  • Present a certificate from a discovery campaign to be used by Horizon.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

ca_bundle

path

Path of a CA bundle used to validate the Horizon instance SSL certificate.

campaign

string / required

The name of the discovery campaign to feed into.

certificate_pem

string

The PEM-encoded certificate to feed the discovery campaign with.

src

path

The path to a certificate PEM file

client_cert

path

Path of a client certificate.

Required if you use certificate based authentication

client_key

path

Path of a client certificate’s key.

Required if you use certificate based authentication

endpoint

string / required

Your Horizon instance base endpoint.

It must include the protocol (https://) and no trailing slash nor path.

hostnames

list / elements=string

The certificate’s host hostnames.

ip

string / required

The certificate’s host ip

operating_systems

list / elements=string

The certificate’s host operating system.

paths

string

The path to the certificate on the host machine.

usages

string

The path of the configuration files that were used to find the certificates.

x_api_id

string

Horizon identifier

Required if you use credentials authentication

x_api_key

string

Horizon password

Required if you use credentials authentication

Notes

Note

  • Feeding a certificate requires permissions on the specified discovery campaign.

Examples

- name: Feed a certificate by its content
  evertrust.horizon.horizon_feed:
    endpoint: "https://<horizon-endpoint>"
    x_api_id: "<horizon-id>"
    x_api_key: "<horizon-password>"
    campaign: exampleCampaign
    ip: localhost
    certificate_pem: "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----"

- name: Feed a certificate by a file
  evertrust.horizon.horizon_feed:
    endpoint: "https://<horizon-endpoint>"
    x_api_id: "<horizon-id>"
    x_api_key: "<horizon-password>"
    campaign: exampleCampaign
    ip: localhost
    certificate_pem:
      src: pem/file/path

Authors

  • Evertrust R&D (@EverTrust)