f5networks / f5networks.f5_modules / 1.28.0 / module / bigip_device_sshd Manage the SSHD settings of a BIG-IP | "added in version" 1.0.0 of f5networks.f5_modules" Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)f5networks.f5_modules.bigip_device_sshd (1.28.0) — module
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections: - name: f5networks.f5_modules version: 1.28.0
Manage the SSHD (secure shell daemon) settings of a BIG-IP.
- 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
port: description: - Port on which you want the SSH daemon to run. type: int allow: 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. - To specify all addresses, use the value C(all). - 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. elements: str type: list login: choices: - enabled - disabled description: - When checked C(enabled), specifies the system accepts SSH communication. type: str banner: choices: - enabled - disabled description: - Whether to enable the banner or not. type: str provider: description: - A dict object containing connection details. suboptions: auth_provider: description: - Configures the auth provider for to obtain authentication tokens from the remote device. - This option is really used when working with BIG-IQ devices. type: str no_f5_teem: default: false description: - If C(yes), TEEM telemetry data is not sent to F5. - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF). - Previously used variable C(F5_TEEM) is deprecated as its name was confusing. type: bool password: aliases: - pass - pwd description: - 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 C(F5_PASSWORD). required: true type: str server: description: - The BIG-IP host or the BIG-IQ host. - You may omit this option by setting the environment variable C(F5_SERVER). required: true type: str server_port: default: 443 description: - The BIG-IP server port. - You may omit this option by setting the environment variable C(F5_SERVER_PORT). type: int timeout: description: - 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. type: int transport: choices: - rest default: rest description: - Configures the transport connection to use when connecting to the remote device. type: str user: description: - 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 C(F5_USER). required: true type: str validate_certs: default: true description: - If C(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 C(F5_VALIDATE_CERTS). type: bool type: dict version_added: 1.0.0 version_added_collection: f5networks.f5_modules log_level: choices: - debug - debug1 - debug2 - debug3 - error - fatal - info - quiet - verbose description: - Specifies the minimum SSHD message level to include in the system log. type: str banner_text: description: - Specifies the text to include on the pre-login banner, which displays when a user attempts to login to the system using SSH. type: str inactivity_timeout: description: - Specifies the number of seconds before inactivity causes an SSH session to log out. type: int
allow: 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: 192.0.2.* type: list banner: description: Whether the banner is enabled or not. returned: changed sample: true type: str banner_text: description: - 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: This is a corporate device. Connecting to it without... type: str inactivity_timeout: description: - The number of seconds before inactivity causes an SSH session to log out. returned: changed sample: 10 type: int log_level: description: The minimum SSHD message level to include in the system log. returned: changed sample: debug type: str login: description: Specifies whether the system accepts SSH communications or not. returned: changed sample: true type: bool port: description: Port on which you want the SSH daemon to run. returned: changed sample: 22 type: int