f5networks.f5_modules.bigip_profile_server_ssl – Manages server SSL profiles on a BIG-IP
f5networks.f5_modules.bigip_profile_server_ssl – Manages server SSL profiles on a BIG-IP
Note
This plugin is part of the f5networks.f5_modules collection (version 1.6.0).
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_profile_server_ssl
.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
- Manages server SSL profiles on a BIG-IP system.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
certificate string |
Specifies the name of the certificate the system uses for server-side SSL processing. | ||
chain string |
Specifies the certificates-key chain to associate with the SSL profile. | ||
ciphers string |
Specifies the list of ciphers the system supports. When creating a new profile, the default cipher list is provided by the parent profile. | ||
key string |
Specifies the file name of the SSL key. | ||
name string / required |
Specifies the name of the profile. | ||
ocsp_profile string |
Specifies the name of the OCSP profile for purpose of validating status of server certificate. | ||
parent string |
Default: "/Common/serverssl" |
The parent template of this monitor template. Once this value has been set, it cannot be changed. | |
partition string |
Default: "Common" |
Device partition to manage resources on. | |
passphrase string |
Specifies a passphrase used to encrypt the key. | ||
provider dictionary added in 1.0.0 of f5networks.f5_modules |
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 You may omit this option by setting the environment variable | |
password string / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
renegotiation boolean |
|
Enables or disables SSL renegotiation. When creating a new profile, the setting is provided by the parent profile. | |
secure_renegotiation string |
|
Specifies the method of secure renegotiations for SSL connections. When creating a new profile, the setting is provided by the parent profile. When
With the | |
server_certificate string |
|
Specifies the way the system handles server certificates. When When | |
server_name string |
Specifies the fully qualified DNS hostname of the server used in Server Name Indication communications. When creating a new profile, the setting is provided by the parent profile. | ||
sni_default boolean |
|
Indicates the system uses this profile as the default SSL profile when there is no match to the server name, or when the client provides no SNI extension support. When creating a new profile, the setting is provided by the parent profile. There can be only one SSL profile with this setting enabled. | |
sni_require boolean |
|
Requires the network peers also provide SNI support. This setting only takes effect when When creating a new profile, the setting is provided by the parent profile. | |
state string |
|
When When | |
update_password string |
|
|
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 a new server SSL profile
bigip_profile_server_ssl:
name: foo
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
ciphers string |
changed |
The ciphers applied to the profile.
Sample: |
SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA |
renegotiation boolean |
changed |
Renegotiation of SSL sessions.
Sample: True | |
secure_renegotiation string |
changed |
The method of secure SSL renegotiation.
Sample: request |
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_profile_server_ssl_module.html