PARALLAX

bigip_device_sshd

Manage SSH daemon settings on a BIG-IP

Collection: f5networks.f5_modules

Full Name: f5networks.f5_modules.bigip_device_sshd

Synopsis

Manage SSH daemon settings on a BIG-IP

Parameters

NameTypeRequiredDefaultDescription
providerdictBIG-IP connection options: server, server_port (443), user, password (private aliases pass/pwd), validate_certs (true), transport (rest), timeout, no_f5_teem (false), auth_provider. Fallbacks belong to the execution host.
allowlistAllowed SSH clients. Omitted/null leaves unchanged. Empty list, [’’] or [’none’] clears; nonempty comparison uses set equality. Native profile: at most 16 entries of 255 UTF8 bytes each. Comma strings split without trimming.
bannerstrenabled or disabled. Omitted leaves unchanged; supplied null fails choices. Returned as a string.
banner_textstrSSH banner text, including empty clearing text. Omitted/null leaves unchanged. Native limit: 4096 UTF8 bytes.
inactivity_timeoutintSSH inactivity timeout. Omitted/null leaves unchanged. Signed32 native profile; zero and negatives are admitted.
log_levelstrdebug, debug1, debug2, debug3, error, fatal, info, quiet or verbose. Omitted leaves unchanged; supplied null fails choices.
loginstrenabled or disabled. Omitted leaves unchanged; supplied null fails choices. Returned as a string.
portintSSH daemon listening port, independent of provider.server_port. Omitted/null leaves unchanged. Signed32 native profile; zero and negatives are admitted.

Example

yaml
- name: Enable SSH banner
  f5networks.f5_modules.bigip_device_sshd:
    banner: enabled
    provider:
      server: lb.mydomain.com
      user: admin
      password: '{{ bigip_password }}'
  delegate_to: localhost

- name: Set SSH banner text
  f5networks.f5_modules.bigip_device_sshd:
    banner_text: Welcome to the BIG-IP
    provider:
      server: lb.mydomain.com
      user: admin
      password: '{{ bigip_password }}'
  delegate_to: localhost

- name: Set SSH listening port
  f5networks.f5_modules.bigip_device_sshd:
    port: 2222
    provider:
      server: lb.mydomain.com
      user: admin
      password: '{{ bigip_password }}'
  delegate_to: localhost
Search
    ↑ ↓ move↵ openesc close