Last updated on: 2024-04-01 03:24:20.
bigip_ssl_csr – Create SSL CSR files on the BIG-IP.¶
New in version 1.0.0.
Synopsis¶
- This module creates SSL CSR files on a BIG-IP. CSRs require an associated pre-existing SSL key on the BIG-IP.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
|
challenge_password
string
added in 1.1.0 |
Specifies the
PKCS#9 challenge-password with which to associate this CSR. |
||
|
city
string
added in 1.1.0 |
Specifies the x509 city with which to associate this CSR.
|
||
|
common_name
string
|
The certificate common name.
|
||
|
country
string
added in 1.1.0 |
Specifies the 2 letter x509 country code with which to associate this CSR.
|
||
|
dest
path
/ required
|
The destination on your local filesystem to use for saving the CSR file.
|
||
|
email_address
string
added in 1.1.0 |
Specifies the x509 email-address used to create the certificate signing request.
|
||
|
key_name
string
|
The SSL key 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 with which to associate this CSR.
|
||
|
ou
string
added in 1.1.0 |
Specifies the x509 organizational unit used to create the certificate signing request.
|
||
|
partition
string
added in 1.1.0 |
Default: "Common"
|
Device partition on which to manage resources.
|
|
|
province
string
added in 1.1.0 |
Specifies the x509 state or province used to create the certificate signing request.
|
||
|
state
string
|
|
When
present, ensures that the resource exists.When
absent, ensures that the resource does not exist. |
|
|
subject_alternative_name
string
added in 3.0.0 |
The Subject Alternative Name of the certificate.
|
Examples¶
- 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 with which to associate 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 with which to associate this CSR.
Sample:
US
|
|
email_address
string
|
created |
The x509 email address used to create the certificate signing request.
Sample:
root@local.net
|
|
organization
string
|
created |
The x509 organization used to create the certificate signing request.
Sample:
Foobar Inc.
|
|
ou
string
|
created |
The x509 organizational unit used to create the certificate signing request.
Sample:
IT
|
|
province
string
|
created |
The x509 state or province used to create the certificate signing request.
Sample:
WA
|
|
subject_alternative_name
string
|
created |
The Subject Alternative Name of the certificate.
Sample:
IP:1.2.3.4
|