/ home / community / community.general / 8.5.0 / module / utm_ca_host_key_cert

community.general.utm_ca_host_key_cert (8.5.0) — module

Create, update or destroy ca host_key_cert entry in Sophos UTM

Authors: Stephan Schwarz (@stearz)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Create, update or destroy a ca host_key_cert entry in SOPHOS UTM.

This module needs to have the REST Ability of the UTM to be activated.

Usage examples

Scanned by Steampunk Spotter

- name: Create a ca_host_key_cert entry
  community.general.utm_ca_host_key_cert:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry
    ca: REF_ca/signing_ca_OBJECT_STRING
    meta: REF_ca/meta_x509_OBJECT_STRING
    certificate: |
      --- BEGIN CERTIFICATE ---
      . . .
       . . .
      . . .
      --- END CERTIFICATE ---
    state: present

Scanned by Steampunk Spotter

- name: Remove a ca_host_key_cert entry
  community.general.utm_ca_host_key_cert:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry
    state: absent

Scanned by Steampunk Spotter

- name: Read a ca_host_key_cert entry
  community.general.utm_ca_host_key_cert:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry
    state: info

Inputs

    
ca:
    description:
    - A reference to an existing utm_ca_signing_ca or utm_ca_verification_ca object.
    required: true
    type: str

key:
    description:
    - Optional private key in PEM format.
    type: str

meta:
    description:
    - A reference to an existing utm_ca_meta_x509 object.
    required: true
    type: str

name:
    description:
    - The name of the object. Will be used to identify the entry.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The desired state of the object.
    - V(present) will create or update an object.
    - V(absent) will delete an object if it was present.
    type: str

comment:
    description:
    - Optional comment string.
    type: str

headers:
    default: {}
    description:
    - A dictionary of additional headers to be sent to POST and PUT requests.
    - Is needed for some modules.
    required: false
    type: dict

utm_host:
    description:
    - The REST Endpoint of the Sophos UTM.
    required: true
    type: str

utm_port:
    default: 4444
    description:
    - The port of the REST interface.
    type: int

encrypted:
    default: false
    description:
    - Optionally enable encryption.
    type: bool

utm_token:
    description:
    - The token used to identify at the REST-API. See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en),
      Chapter 2.4.2.
    required: true
    type: str

certificate:
    description:
    - The certificate in PEM format.
    required: true
    type: str

utm_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - The protocol of the REST Endpoint.
    type: str

validate_certs:
    default: true
    description:
    - Whether the REST interface's ssl certificate should be verified or not.
    type: bool

Outputs

result:
  contains:
    _locked:
      description: Whether or not the object is currently locked
      type: bool
    _ref:
      description: The reference name of the object
      type: str
    _type:
      description: The type of the object
      type: str
    ca:
      description: A reference to an existing utm_ca_signing_ca or utm_ca_verification_ca
        object.
      type: str
    certificate:
      description: The certificate in PEM format
      type: str
    comment:
      description: Comment string (may be empty string)
      type: str
    encrypted:
      description: If encryption is enabled
      type: bool
    key:
      description: Private key in PEM format (may be empty string)
      type: str
    meta:
      description: A reference to an existing utm_ca_meta_x509 object.
      type: str
    name:
      description: The name of the object
      type: str
  description: The utm object that was created
  returned: success
  type: complex