bigip_ssl_csr – Create SSL CSR files on the BIG-IP

New in version 1.0.0.

Synopsis

  • This module will create SSL CSR files on a BIG-IP. CSRs require an associated SSL key to pre-exist on the BIG-IP.

Parameters

Parameter Choices/Defaults Configuration Comments
challenge_password
string
added in 1.1.0
Specifies the PKCS#9 challenge-password to be associated with this CSR.
city
string
added in 1.1.0
Specifies the x509 city to be associated with this CSR.
common_name
string
The certificate common name.
country
string
added in 1.1.0
Specifies the 2 letter x509 country code to be associated with this CSR.
dest
path / required
Destination on your local filesystem when you want to save the CSR file.
email_address
string
added in 1.1.0
Specifies the x509 email-address to be used in creation of the certificate signing request.
force
boolean
    Choices:
  • no
  • yes ←
If no, the file will only be transferred if the destination does not exist.
key_name
string
The SSL key to be used to generate the CSR.
name
string / required
The name of the CSR file.
organization
string
added in 1.1.0
Specifies the x509 organization name to be associated with this CSR.
ou
string
added in 1.1.0
Specifies the x509 organizational unit to be used in creation of the certificate signing request.
partition
string
added in 1.1.0
Default:
"Common"
Device partition to manage resources on.
province
string
added in 1.1.0
Specifies the x509 state or province to be used in creation of the certificate signing request.
state
string
    Choices:
  • present ←
  • absent
When present, ensures the resource exists.
When absent, ensures the resource does not exist.

Examples

- hosts: all
  collections:
    - f5networks.f5_bigip
  connection: httpapi

  vars:
    ansible_host: "lb.mydomain.com"
    ansible_user: "admin"
    ansible_httpapi_password: "secret"
    ansible_network_os: f5networks.f5_bigip.bigip
    ansible_httpapi_use_ssl: yes

- name: Create an SSL csr
  bigip_ssl_csr:
    name: csr-name
    key_name: key-name
    common_name: csr-name
    dest: /tmp/csr-name

Return Values

The following are the fields unique to this module:

Key Returned Description
city
string
created
The x509 city to be associated with this CSR.

Sample:
Seattle
common_name
string
created
The common name of the CSR file.

Sample:
csr-name
country
string
created
The 2 letter x509 country code to be associated with this CSR.

Sample:
US
email_address
string
created
The x509 email-address to be used in creation of the certificate signing request.

Sample:
root@local.net
organization
string
created
The x509 organization to be used in creation of the certificate signing request.

Sample:
Foobar Inc.
ou
string
created
The x509 organizational unit to be used in creation of the certificate signing request.

Sample:
IT
province
string
created
The x509 state or province to be used in creation of the certificate signing request.

Sample:
WA


Status

Authors

  • Wojciech Wypior (@wojtek0806)