f5networks.f5_bigip.bigip_ssl_csr (3.4.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_bigip:==3.4.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 3.4.0

Description

This module creates SSL CSR files on a BIG-IP. CSRs require an associated pre-existing SSL key on the BIG-IP.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
ou:
    description:
    - Specifies the x509 organizational unit used to create the certificate signing request.
    type: str
    version_added: 1.1.0
    version_added_collection: f5networks.f5_bigip

city:
    description:
    - Specifies the x509 city with which to associate this CSR.
    type: str
    version_added: 1.1.0
    version_added_collection: f5networks.f5_bigip

dest:
    description:
    - The destination on your local filesystem to use for saving the CSR file.
    required: true
    type: path

name:
    description:
    - The name of the CSR file.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(present), ensures that the resource exists.
    - When C(absent), ensures that the resource does not exist.
    type: str

country:
    description:
    - Specifies the 2 letter x509 country code with which to associate this CSR.
    type: str
    version_added: 1.1.0
    version_added_collection: f5networks.f5_bigip

key_name:
    description:
    - The SSL key used to generate the CSR.
    type: str

province:
    description:
    - Specifies the x509 state or province used to create the certificate signing request.
    type: str
    version_added: 1.1.0
    version_added_collection: f5networks.f5_bigip

partition:
    default: Common
    description:
    - Device partition on which to manage resources.
    type: str
    version_added: 1.1.0
    version_added_collection: f5networks.f5_bigip

common_name:
    description:
    - The certificate common name.
    type: str

organization:
    description:
    - Specifies the x509 organization name with which to associate this CSR.
    type: str
    version_added: 1.1.0
    version_added_collection: f5networks.f5_bigip

email_address:
    description:
    - Specifies the x509 email-address used to create the certificate signing request.
    type: str
    version_added: 1.1.0
    version_added_collection: f5networks.f5_bigip

challenge_password:
    description:
    - Specifies the C(PKCS#9) challenge-password with which to associate this CSR.
    type: str
    version_added: 1.1.0
    version_added_collection: f5networks.f5_bigip

subject_alternative_name:
    description:
    - The Subject Alternative Name of the certificate.
    type: str
    version_added: 3.0.0
    version_added_collection: f5networks.f5_bigip

Outputs

city:
  description: The x509 city with which to associate this CSR.
  returned: created
  sample: Seattle
  type: str
common_name:
  description: The common name of the CSR file.
  returned: created
  sample: csr-name
  type: str
country:
  description: The 2 letter x509 country code with which to associate this CSR.
  returned: created
  sample: US
  type: str
email_address:
  description: The x509 email address used to create the certificate signing request.
  returned: created
  sample: root@local.net
  type: str
organization:
  description: The x509 organization used to create the certificate signing request.
  returned: created
  sample: Foobar Inc.
  type: str
ou:
  description: The x509 organizational unit used to create the certificate signing
    request.
  returned: created
  sample: IT
  type: str
province:
  description: The x509 state or province used to create the certificate signing request.
  returned: created
  sample: WA
  type: str
subject_alternative_name:
  description: The Subject Alternative Name of the certificate.
  returned: created
  sample: IP:1.2.3.4
  type: str