f5os_tls_cert_key – Manage TLS certificate and key on F5OS devices.

New in version 1.11.0.

Synopsis

  • Manage TLS certificate and key on F5OS devices.

Parameters

Parameter Choices/Defaults Configuration Comments
city
string
This specifies the residing city of the certificate holder.
confirm_key_passphrase
string
This specifies the confirmation of the passphrase for the key.
The value should be the same as key_passphrase.
country
string
This specifies the country of the certificate holder.
days_valid
integer
This specifies the number of days the certificate is valid.
email
string
This specifies the email address of the certificate holder.
key_curve
string
    Choices:
  • prime256v1
  • secp384r1
This specifies the specific elliptic curve used in ECC.
This parameter is required when key_type is ecdsa or encrypted ecdsa.
key_passphrase
string
This specifies the passphrase for the key.
key_size
integer
    Choices:
  • 2048
  • 3072
  • 4096
This specifies the length of the key.
This parameter is required when key_type is rsa or encrypted rsa.
key_type
string
    Choices:
  • rsa
  • encrypted-rsa
  • ecdsa
  • encrypted-ecdsa
This specifies the type of the key.
name
string / required
This specifies the common name of the certificate.
organization
string
This specifies the organization of the certificate holder.
province
string
This specifies the province or state of the certificate holder.
state
string
    Choices:
  • present ←
  • absent
The certificate state. If absent, deletes the certificate if it exists.
If present, the certificate is created.
store_tls
boolean
    Choices:
  • no
  • yes
This specifies whether to store the certificate and key on the device.
subject_alternative_name
string
This specifies the subject alternative name of the certificate.
This parameter is reuiqred for rSeries Platform.
unit
string
This specifies the organizational unit of the certificate holder.
version
integer
This specifies the version of the certificate.

Examples

- name: Create tls cert and key on velos
  f5os_tls_cert_key:
    name: "test_cert"
    email: "name@company.com"
    city: Telangana
    province: Hyderabad
    country: IN
    organization: FZ
    unit: IT
    version: 1
    days_valid: 365
    key_type: "rsa"
    key_size: 2048
    store_tls: true

Return Values

The following are the fields unique to this module:

Key Returned Description
city
string
changed
The residing city of the certificate holder.

Sample:
Delhi
country
string
changed
The country of the certificate holder.

Sample:
IN
days_valid
integer
changed
The number of days the certificate is valid.

Sample:
365
email
string
changed
The email address of the certificate holder.

Sample:
name@company.com
key_curve
string
changed
The specific elliptic curve used in ECC.

Sample:
prime256v1
key_size
integer
changed
The length of the key.

Sample:
2048
key_type
string
changed
The type of the key.

Sample:
rsa
name
string
changed
The common name of the certificate.

Sample:
test_cert
organization
string
changed
The organization of the certificate holder.

Sample:
FZ
province
string
changed
The province or state of the certificate holder.

Sample:
Telangana
subject_alternative_name
string
changed
The subject alternative name of the certificate.

Sample:
DNS:example.com
unit
string
changed
The organizational unit of the certificate holder.

Sample:
IT
version
integer
changed
The version of the certificate.

Sample:
1


Status

Authors

  • Rohit Upadhyay (@rupadhyay)