bigip_device_sshd - Manage the SSHD settings of a BIG-IP¶

New in version 2.2.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

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.9

Parameters ¶

Parameter	Choices/Defaults	Comments
allow	Choices: all IP address, such as 172.27.1.10 IP range, such as 172.27.. or 172.27.0.0/255.255.0.0	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.
banner	Choices: enabled disabled	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	Choices: debug debug1 debug2 debug3 error fatal info quiet verbose	Specifies the minimum SSHD message level to include in the system log.
login	Choices: enabled disabled	Specifies, when checked `enabled`, that the system accepts SSH communications.
password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
port		Port that you want the SSH daemon to run on.
provider (added in 2.5)		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. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
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 can omit this option if the environment variable `F5_SERVER` is set.
user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
server_port	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
validate_certs	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.
transport required	Choices: rest cli ←	Configures the transport connection to use when connecting to the remote device.
server required		The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
validate_certs (added in 2.0)	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.

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.

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. </div> <br/> <div style=”font-size: smaller”><b>Sample:</b></div> <div style=”font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;”>192.0.2.</div> </div> </td> </tr> <tr class=”return-value-column”> <td> <div class=”outer-elbow-container”> <div class=”elbow-key”> <b>banner</b> <br/><div style=”font-size: small; color: red”>string</div> </div> </div> </td> <td><div class=”cell-border”>changed</div></td> <td> <div class=”cell-border”> <div>Whether the banner is enabled or not.</div> <br/> <div style=”font-size: smaller”><b>Sample:</b></div> <div style=”font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;”>True</div> </div> </td> </tr> <tr class=”return-value-column”> <td> <div class=”outer-elbow-container”> <div class=”elbow-key”> <b>banner_text</b> <br/><div style=”font-size: small; color: red”>string</div> </div> </div> </td> <td><div class=”cell-border”>changed and success</div></td> <td> <div class=”cell-border”> <div>Specifies the text included on the pre-login banner that displays when a user attempts to login to the system using SSH. </div> <br/> <div style=”font-size: smaller”><b>Sample:</b></div> <div style=”font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;”>This is a corporate device. Connecting to it without…</div> </div> </td> </tr> <tr class=”return-value-column”> <td> <div class=”outer-elbow-container”> <div class=”elbow-key”> <b>inactivity_timeout</b> <br/><div style=”font-size: small; color: red”>int</div> </div> </div> </td> <td><div class=”cell-border”>changed</div></td> <td> <div class=”cell-border”> <div>The number of seconds before inactivity causes an SSH session to log out. </div> <br/> <div style=”font-size: smaller”><b>Sample:</b></div> <div style=”font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;”>10</div> </div> </td> </tr> <tr class=”return-value-column”> <td> <div class=”outer-elbow-container”> <div class=”elbow-key”> <b>log_level</b> <br/><div style=”font-size: small; color: red”>string</div> </div> </div> </td> <td><div class=”cell-border”>changed</div></td> <td> <div class=”cell-border”> <div>The minimum SSHD message level to include in the system log.</div> <br/> <div style=”font-size: smaller”><b>Sample:</b></div> <div style=”font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;”>debug</div> </div> </td> </tr> <tr class=”return-value-column”> <td> <div class=”outer-elbow-container”> <div class=”elbow-key”> <b>login</b> <br/><div style=”font-size: small; color: red”>bool</div> </div> </div> </td> <td><div class=”cell-border”>changed</div></td> <td> <div class=”cell-border”> <div>Specifies that the system accepts SSH communications or not.</div> <br/> <div style=”font-size: smaller”><b>Sample:</b></div> <div style=”font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;”>True</div> </div> </td> </tr> <tr class=”return-value-column”> <td> <div class=”outer-elbow-container”> <div class=”elbow-key”> <b>port</b> <br/><div style=”font-size: small; color: red”>int</div> </div> </div> </td> <td><div class=”cell-border”>changed</div></td> <td> <div class=”cell-border”> <div>Port that you want the SSH daemon to run on.</div> <br/> <div style=”font-size: smaller”><b>Sample:</b></div> <div style=”font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;”>22</div> </div> </td> </tr> </table> <br/><br/> Status ¶ This module is flagged as preview* which means that it is not guaranteed to have a backwards compatible interface. Author ¶ Tim Rupp (@caphrim007) Hint If you notice any issues in this documentation you can edit this document to improve it. Last updated on Apr 12, 2018. Copyright © 2018 Red Hat, Inc.