New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
allow_non_ssl bool (added in 2.7) |
| Enables or disables acceptance of non-SSL connections. When creating a new profile, the setting is provided by the parent profile. | |
cert_key_chain | One or more certificates and keys to associate with the SSL profile. This option is always a list. The keys in the list dictate the details of the client/key/chain combination. Note that BIG-IPs can only have one of each type of each certificate/key type. This means that you can only have one RSA, one DSA, and one ECDSA per profile. If you attempt to assign two RSA, DSA, or ECDSA certificate/key combo, the device will reject this. This list is a complex list that specifies a number of keys. | ||
key required | Contains a key name. | ||
cert required | Specifies a cert name for use. | ||
chain | Contains a certificate chain that is relevant to the certificate and key mentioned earlier. This key is optional. | ||
passphrase | Contains the passphrase of the key file, should it require one. Passphrases are encrypted on the remote BIG-IP device. Therefore, there is no way to compare them when updating a client SSL profile. Due to this, if you specify a passphrase, this module will always register a changed event. | ||
ciphers | Specifies the list of ciphers that the system supports. When creating a new profile, the default cipher list is provided by the parent profile. | ||
name required | Specifies the name of the profile. | ||
options (added in 2.7) |
| Options that the system uses for SSL processing in the form of a list. When creating a new profile, the list is provided by the parent profile. When a '' or none value is provided all options for SSL processing are disabled. | |
parent | Default: /Common/clientssl | The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the clientssl parent on the Common partition. | |
partition (added in 2.5) | Default: Common | Device partition to manage resources on. | |
password required | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD .aliases: pass, pwd | ||
provider (added in 2.5) | Default: None | A dict object containing connection details. | |
ssh_keyfile | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE . | ||
timeout | Default: 10 | 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. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
user 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 F5_USER . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
password required | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD .aliases: pass, pwd | ||
validate_certs bool |
| 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 . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
secure_renegotiation (added in 2.7) |
| Specifies the method of secure renegotiations for SSL connections. When creating a new profile, the setting is provided by the parent profile. When request is set the ssystem request secure renegotation of SSL connections.require is a default setting and when set the system permits initial SSL handshakes from clients but terminates renegotiations from unpatched clients.The require-strict setting the system requires strict renegotiation of SSL connections. In this mode the system refuses connections to insecure servers, and terminates existing SSL connections to insecure servers. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
state (added in 2.5) |
| When present , ensures that the profile exists.When absent , ensures the profile is removed. | |
user 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 F5_USER . | ||
validate_certs bool (added in 2.0) |
| 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 . |
Note
pip install f5-sdk
.- name: Create client SSL profile bigip_profile_client_ssl: state: present server: lb.mydomain.com user: admin password: secret name: my_profile delegate_to: localhost - name: Create client SSL profile with specific ciphers bigip_profile_client_ssl: state: present server: lb.mydomain.com user: admin password: secret name: my_profile ciphers: "!SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA" delegate_to: localhost - name: Create client SSL profile with specific SSL options bigip_profile_client_ssl: state: present server: lb.mydomain.com user: admin password: secret name: my_profile options: - no-sslv2 - no-sslv3 delegate_to: localhost - name: Create client SSL profile require secure renegotiation bigip_profile_client_ssl: state: present server: lb.mydomain.com user: admin password: secret name: my_profile secure_renegotation: request delegate_to: localhost - name: Create a client SSL profile with a cert/key/chain setting bigip_profile_client_ssl: state: present server: lb.mydomain.com user: admin password: secret name: my_profile cert_key_chain: - cert: bigip_ssl_cert1 key: bigip_ssl_key1 chain: bigip_ssl_cert1 delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
allow_non_ssl bool | changed | Acceptance of non-SSL connections. Sample: True |
ciphers string | changed | The ciphers applied to the profile. Sample: !SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA |
options list | changed | The list of options for SSL processing. Sample: ['no-sslv2', 'no-sslv3'] |
secure_renegotation string | changed | The method of secure SSL renegotiation. Sample: request |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_profile_client_ssl_module.html