bigip_device_sshd – Manage the SSHD settings of a BIG-IP
bigip_device_sshd – Manage the SSHD settings of a BIG-IP
New in version 2.2.
Synopsis
- Manage the SSHD settings of a BIG-IP.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
allow - |
Specifies, if you have enabled SSH access, 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 IP address can be specified, such as 172.27.1.10. IP rangees can be specified, such as 172.27.*.* or 172.27.0.0/255.255.0.0. | ||
banner - |
|
Whether to enable the banner or not. | |
banner_text - |
Specifies the text to include on the pre-login banner that displays when a user attempts to login to the system using SSH. | ||
inactivity_timeout - |
Specifies the number of seconds before inactivity causes an SSH session to log out. | ||
log_level - |
|
Specifies the minimum SSHD message level to include in the system log. | |
login - |
|
Specifies, when checked | |
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
| ||
port - |
Port that you want the SSH daemon to run on. | ||
provider - added in 2.5 |
Default: null |
A dict object containing connection details. | |
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
| ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 | ||
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. | |
transport - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 | ||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable |
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 the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
. - 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 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
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') }}"
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Set the SSHD service to run on port 2222
bigip_device_sshd:
password: secret
port: 2222
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 |
---|---|---|
allow string |
changed |
Specifies, if you have enabled SSH access, the IP address or address range for other systems that can use SSH to communicate with this system.
Sample: 192.0.2.* |
banner string |
changed |
Whether the banner is enabled or not.
Sample: True |
banner_text string |
changed and success |
Specifies the text included on the pre-login banner that displays when a user attempts to login to the system using SSH.
Sample: This is a corporate device. Connecting to it without... |
inactivity_timeout integer |
changed |
The number of seconds before inactivity causes an SSH session to log out.
Sample: 10 |
log_level string |
changed |
The minimum SSHD message level to include in the system log.
Sample: debug |
login boolean |
changed |
Specifies that the system accepts SSH communications or not.
Sample: True |
port integer |
changed |
Port that you want the SSH daemon to run on.
Sample: 22 |
Status
- This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
- This module is maintained by an Ansible Partner. [certified]
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.7/modules/bigip_device_sshd_module.html