f5networks.f5_modules.bigip_device_sshd module – Manage the SSHD settings of a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.27.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install f5networks.f5_modules.
To use it in a playbook, specify: f5networks.f5_modules.bigip_device_sshd.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage the SSHD (secure shell daemon) settings of a BIG-IP.
Parameters
Parameter |
Comments |
|---|---|
If you have enabled SSH access, specifies the IP address or address range for other systems that can use SSH to communicate with this system. To specify all addresses, use the value An IP address can be specified, such as 172.27.1.10. IP ranges can be specified, such as 172.27.*.* or 172.27.0.0/255.255.0.0. To remove SSH access, specify an empty list or an empty string. |
|
Whether to enable the banner or not. Choices:
|
|
Specifies the text to include on the pre-login banner, which displays when a user attempts to login to the system using SSH. |
|
Specifies the number of seconds before inactivity causes an SSH session to log out. |
|
Specifies the minimum SSHD message level to include in the system log. Choices:
|
|
When checked Choices:
|
|
Port on which you want the SSH daemon to run. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
Notes
Note
Requires BIG-IP version 12.0.0 or greater
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: Set the banner for the SSHD service from a string
bigip_device_sshd:
banner: enabled
banner_text: banner text goes here
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Set the banner for the SSHD service from a file
bigip_device_sshd:
banner: enabled
banner_text: "{{ lookup('file', '/path/to/file') }}"
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Set the SSHD service to run on port 2222
bigip_device_sshd:
port: 2222
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
If you have enabled SSH access, specifies the IP address or address range for other systems that can use SSH to communicate with this system. Returned: changed Sample: |
|
Whether the banner is enabled or not. Returned: changed Sample: |
|
Specifies the text included on the pre-login banner which displays when a user attempts to login to the system using SSH. Returned: changed and success Sample: |
|
The number of seconds before inactivity causes an SSH session to log out. Returned: changed Sample: |
|
The minimum SSHD message level to include in the system log. Returned: changed Sample: |
|
Specifies whether the system accepts SSH communications or not. Returned: changed Sample: |
|
Port on which you want the SSH daemon to run. Returned: changed Sample: |