ieisystem.inmanage.generate_ssl module – Generate SSL certificate

Note

This module is part of the ieisystem.inmanage collection (version 4.0.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 ieisystem.inmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ieisystem.inmanage.generate_ssl.

New in ieisystem.inmanage 4.0.0

Synopsis

  • Generate SSL certificate on ieisystem Server.

Requirements

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

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

city_locality

string / required

City or Locality.

Maximum length of 128 alpha-numeric characters.

Special characters ‘’, ‘#’ and ‘$’ are not allowed.

common_name

string / required

Common name for which the certificate is to be generated.

Maximum length of 64 alpha-numeric characters.

Special characters ‘’, ‘#’ and ‘$’ are not allowed.

country

string / required

Country code.

Only two characters are allowed.

Special characters are not allowed.

email

string / required

Email Address of the organization.

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

organization

string / required

Name of the organization for which certificate is to be generated.

Maximum length of 64 alpha-numeric characters.

Special characters ‘’, ‘#’ and ‘$’ are not allowed.

organization_unit

string / required

Section or Unit of the organization for which certificate is to be generated.

Maximum length of 64 alpha-numeric characters.

Special characters ‘’, ‘#’ and ‘$’ are not allowed.

password

string

Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

provider

dictionary

A dict object containing connection details.

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

password

string

Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

username

string

Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

state_province

string / required

State or Province.

Maximum length of 128 alpha-numeric characters.

Special characters ‘’, ‘#’ and ‘$’ are not allowed.

username

string

Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

valid_time

integer / required

Requested validity days for the certificate.

Value ranges from 1 to 3650 days.

Notes

Note

  • Does not support check_mode.

Examples

- name: Generate SSL test
  hosts: inmanage
  connection: local
  gather_facts: false
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Generate SSL"
    ieisystem.inmanage.generate_ssl:
      common_name: "tests"
      organization: "test"
      organization_unit: "yanfa"
      city_locality: "jinan"
      state_province: "Shandong"
      country: "CN"
      email: "[email protected]"
      valid_time: 10
      provider: "{{ inmanage }}"

Return Values

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

Key

Description

changed

boolean

Check to see if a change was made on the device.

Returned: always

message

string

Messages returned after module execution.

Returned: always

state

string

Status after module execution.

Returned: always

Authors

  • WangBaoshan (@ieisystem)