ssl_certificate_module.rst

orphan:

morpheus.core.ssl_certificate module -- Manage SSL Certificates

Note

This module is part of the morpheus.core collection (version 0.7.1).

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 morpheus.core.

To use it in a playbook, specify: morpheus.core.ssl_certificate.

.. rst-class:: ansible-version-added

New in morpheus.core 0.6.0

• Synopsis
• Parameters
• Attributes
• Examples
• Return Values

Synopsis

• Create, Update or Delete SSL Certificates.

Parameters

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Parameter	Comments
.. rst-class:: ansible-option-title certificate .. ansible-option-type-line:: :ansible-option-type:`string`	The SSL Certificate contents.
.. rst-class:: ansible-option-title domain_name .. ansible-option-type-line:: :ansible-option-type:`string`	The Domain Name this SSL Certificate is responsible for.
.. rst-class:: ansible-option-title id .. ansible-option-type-line:: :ansible-option-type:`integer`	Specify the Id of a SSL Certificate to Update or Remove.
.. rst-class:: ansible-option-title key .. ansible-option-type-line:: :ansible-option-type:`string`	The Private Key contents.
.. rst-class:: ansible-option-title name .. ansible-option-type-line:: :ansible-option-type:`string`	Name of the SSL Certificate.
.. rst-class:: ansible-option-title state .. ansible-option-type-line:: :ansible-option-type:`string`	When :ansopt:`morpheus.core.ssl\_certificate#module:state=present` create or update an SSL Certificate. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
.. rst-class:: ansible-option-title wildcard .. ansible-option-type-line:: :ansible-option-type:`boolean`	Is this a wildcard certificate. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`

Attributes

.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}

Attribute	Support	Description
.. rst-class:: ansible-option-title check_mode	:ansible-attribute-support-label:`Support: \ `:ansible-attribute-support-full:`full`	Can run in check_mode and return changed status prediction without modifying target
.. rst-class:: ansible-option-title diff_mode	:ansible-attribute-support-label:`Support: \ `:ansible-attribute-support-full:`full`	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode
.. rst-class:: ansible-option-title platform	:ansible-attribute-support-property:`Platform:` :ansible-attribute-support-full:`httpapi`	Target OS/families that can be operated against

Examples

- name: Create SSL Certificate
  morpheus.core.ssl_certificate:
    state: present
    name: WebSvr SSL Cert
    domain_name: www.domain.tld
    wildcard: false
    certificate: "{{ q('ansible.builtin.file', '/path/to/cert.crt') }}"
    key: "{{ q('ansible.builtin.file', '/path/to/private_key.pem') }}"

- name: Remove SSL Certificate
  morpheus.core.ssl_certificate:
    state: absent
    name: WebSvr SSL Cert

- name: Change Name of SSL Certificate
  morpheus.core.ssl_certificate:
    id: 17
    name: New Name SSL Cert

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Key

Description

.. rst-class:: ansible-option-title certificate .. ansible-option-type-line:: :ansible-option-type:`dictionary`

SSL Certificate Details. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"certificate": {"account\_id": 0, "category": null, "cert\_type": "server", "common\_name": null, "description": null, "domain\_name": "host.domain.tld", "enabled": true, "generated": false, "id": 82, "integration\_id": null, "key\_file\_md5": "aaaa....", "name": "My Domain Cert", "self\_signed": false, "type": {"code": "internal", "id": 1}, "wildcard": false}}`

Authors

• James Riach (@McGlovin1337)

Collection links

.. ansible-links::

  - title: "Repository (Sources)"
    url: "https://www.github.com/gomorpheus/ansible-collection-morpheus-core"
    external: true