f5networks.f5_modules.bigip_device_sshd 模块 – 管理 BIG-IP 的 SSHD 设置

注意

此模块是 f5networks.f5_modules 集合（版本 1.32.1）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigip_device_sshd。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP 的 SSHD（安全外壳守护程序）设置。

参数

参数	注释
允许 列表 / 元素=字符串	如果您已启用 SSH 访问，则指定其他可以使用 SSH 与此系统通信的系统的 IP 地址或地址范围。 要指定所有地址，请使用值 all。 可以指定 IP 地址，例如 172.27.1.10。 可以指定 IP 范围，例如 172.27.*.* 或 172.27.0.0/255.255.0.0。 要删除 SSH 访问，请指定空列表或空字符串。
横幅 字符串	是否启用横幅。 选择 “已启用” “已禁用”
banner_text 字符串	指定要包含在登录前横幅上的文本，该横幅在用户尝试使用 SSH 登录系统时显示。
inactivity_timeout 整数	指定在不活动导致 SSH 会话注销之前的时间（以秒为单位）。
log_level 字符串	指定要包含在系统日志中的最低 SSHD 消息级别。 选择 “调试” “debug1” “debug2” “debug3” “错误” “致命” “信息” “静默” “详细”
登录 字符串	选中 enabled 后，指定系统接受 SSH 通信。 选择 “已启用” “已禁用”
端口 整数	您希望 SSH 守护程序在其上运行的端口。
提供程序 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
auth_provider 字符串	配置身份验证提供程序以从远程设备获取身份验证令牌。 此选项在处理 BIG-IQ 设备时真正使用。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选择 false ← (默认) true
密码 别名: pass, pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
服务器 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值: 443
超时 整数	指定与网络设备通信以进行连接或发送命令的超时时间（以秒为单位）。如果在操作完成之前超时，模块将出错。
传输 字符串	配置连接到远程设备时要使用的传输连接。 选择 "rest" ← (默认)
用户 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不会验证 SSL 证书。 仅在个人控制的使用自签名证书的站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选择 false true ← (默认)

说明

注意

• 需要 BIG-IP 版本 12.0.0 或更高版本

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。

• 需要 BIG-IP 软件版本 >= 12。

• F5 模块仅操作 F5 产品的运行配置。要确保 BIG-IP 的特定配置持久保存到磁盘，请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关正确使用该模块来保存运行配置的信息，请参阅该模块的文档。

示例

- 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

返回值

通用返回值记录在此处，以下是此模块独有的字段

键	描述
允许 列表 / 元素=字符串	如果您已启用 SSH 访问，则指定其他可以使用 SSH 与此系统通信的系统的 IP 地址或地址范围。 返回： changed 示例： ["192.0.2.*"]
横幅 字符串	指示横幅是否启用。 返回： changed 示例： "True"
banner_text 字符串	指定在用户尝试使用 SSH 登录系统时，登录前横幅上显示的文本。 返回： changed 和 success 示例： "这是一个公司设备。未经许可连接..."
inactivity_timeout 整数	在不活动导致 SSH 会话注销之前的秒数。 返回： changed 示例： 10
log_level 字符串	包含在系统日志中的最低 SSHD 消息级别。 返回： changed 示例： "debug"
登录 布尔值	指定系统是否接受 SSH 通信。 返回： changed 示例： true
端口 整数	您希望 SSH 守护程序在其上运行的端口。 返回： changed 示例： 22

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）