Last updated on: 2024-04-01 03:24:20.
bigip_ssl_csr – Create SSL CSR files on the BIG-IP¶
New in version 1.3.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 | |
---|---|---|---|---|
common_name
string
|
The certificate common name.
|
|||
dest
path
/ required
|
Destination on your local filesystem when you want to save the CSR file.
|
|||
force
boolean
|
|
If
false , 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.
|
|||
provider
dictionary
added in 1.0.0 |
A dict object containing connection details.
|
|||
auth_provider
string
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
|||
no_f5_teem
boolean
|
|
If
yes , TEEM telemetry data is not sent to F5.You may omit this option by setting the environment variable
F5_TELEMETRY_OFF .Previously used variable
F5_TEEM is deprecated as its name was confusing. |
||
password
string
/ required
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ.
You may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
|||
server
string
/ required
|
The BIG-IP host or the BIG-IQ host.
You may omit this option by setting the environment variable
F5_SERVER . |
|||
server_port
integer
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
||
timeout
integer
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
|||
transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
||
user
string
/ required
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable
F5_USER . |
|||
validate_certs
boolean
|
|
If
no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.You may omit this option by setting the environment variable
F5_VALIDATE_CERTS . |
||
state
string
|
|
When
present , ensures the resource exists.When
absent , ensures the resource does not exist. |
Notes¶
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires BIG-IP software version >= 12.
- The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples¶
- name: Create an SSL csr
bigip_ssl_csr:
name: csr-name
key_name: key-name
common_name: csr-name
dest: /tmp/csr-name
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values¶
The following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
common_name
string
|
created |
The common name of the CSR file.
Sample:
csr-name
|
csr_name
string
|
created |
The name of the CSR file.
Sample:
csr-name
|