f5networks.f5_modules.bigip_profile_sip 模块 – 在 BIG-IP 上管理 SIP 配置文件

注意

此模块是 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_profile_sip。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 在 BIG-IP 系统上管理 SIP 配置文件。

参数

参数	注释
community 字符串	当 dialog_aware 为 true 并且配置需要多个 SIP 虚拟服务器-配置文件配对时，此字符串值指示该配对是否属于同一个 SIP 代理功能组。
description 字符串	配置文件的描述。 要完全删除该条目，请设置值为 ''。
dialog_aware 布尔值	当 true 时，系统会收集 SIP 对话信息并自动转发属于已知 SIP 对话的 SIP 消息。 选项 false true
enable_sip_firewall 布尔值	指定是否启用高级防火墙管理器 (AFM) 策略。 当 true 时，在 AFM 中的 DoS 配置文件中配置的 SIP 安全设置将应用于使用此配置文件的虚拟服务器。 选项 false true
insert_record_route_header 布尔值	当 true 时，插入 Record-Route SIP 头，指示后续 SIP 请求消息的下一个跳。 选项 false true
insert_via_header 布尔值	当 true 时，在转发的 SIP 请求中插入 Via 头。 Via 头指示通过代理设备和使用的传输所走的路径。响应消息使用此路由信息。 选项 false true
log_profile 字符串	指定发布者用于发送日志消息的日志设置。 名称的格式可以是分区前缀（/Common/foo），也可以只是对象名称（foo）。 要删除该条目，请设置值为 ''，但是配置文件 log_publisher 也必须设置为 ''。
log_publisher 字符串	指定定义为记录消息的发布者。 名称的格式可以是分区前缀（/Common/foo），也可以只是对象名称（foo）。 要删除该条目，请设置值为 ''，但是配置文件 log_profile 也必须设置为 ''。
max_size 整数	指定 BIG-IP 系统接受的最大 SIP 消息大小。 可接受的值范围是 0 - 4294967295 字节。
name 字符串 / 必需	指定要管理的 SIP 配置文件的名称。
parent 字符串	指定此配置文件继承设置的配置文件。 创建新配置文件时，如果未指定此参数，则默认为系统提供的 sip 配置文件。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。 此选项在使用 BIG-IQ 设备时非常有用。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选项 false ← (默认) true
password 别名：pass、pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
server 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
timeout 整数	指定与网络设备通信的超时时间（秒），用于连接或发送命令。如果在操作完成之前超时，模块将出错。
transport 字符串	配置连接到远程设备时要使用的传输连接。 选项 "rest" ← (默认)
user 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须拥有设备上的管理员权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
secure_via_header 布尔值	选中（启用）后，在转发的 SIP 请求中插入安全的 Via 头。 安全的 Via 头指示消息的来源。 此参数导致插入的Via头指定传输层安全性。要使此选项生效，必须将insert_via_header设置为(true)。 选项 false true
security 布尔值	当true时，启用增强的水平安全层 (HSL) 安全检查。 选项 false true
state 字符串	当present时，确保配置文件存在。 当absent时，确保配置文件被删除。 选项 "present" ← (默认) "absent"
terminate_on_bye 布尔值	当true时，BYE事务完成后关闭连接。 BYE事务是应用程序在准备好关闭两者之间的连接时发送给另一个应用程序的消息。 选项 false true
user_via_header 字符串	当insert_via_header为true时，指定系统作为SIP请求消息中顶部Via头插入的Via值。 有效值必须包含SIP协议和sent_by设置，例如：SIP/2.0/UDP 10.10.10.10:5060。 要完全删除该条目，请设置值为 ''。

注释

注意

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

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

• F5模块仅操作F5产品的运行配置。为了确保BIG-IP特定配置持久保存到磁盘，请务必包含至少一项使用f5networks.f5_modules.bigip_config模块保存运行配置的任务。请参考模块的文档以了解保存运行配置的正确使用方法。

示例

- name: Create a SIP profile
  bigip_profile_sip:
    name: foo
    parent: sip
    log_profile: alg_log
    log_publisher: foo-publisher
    description: this is a new profile
    security: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update SIP profile
  bigip_profile_sip:
    name: foo
    insert_record_route_header: true
    enable_sip_firewall: true
    insert_via_header: true
    user_via_header: "SIP/2.0/UDP 10.10.10.10:5060"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Delete a SIP profile
  bigip_profile_sip:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

常见的返回值已在此处记录此处，以下是此模块特有的字段

Key	描述
community 字符串	指示该对是否属于同一个SIP代理功能组。 返回：changed 示例："foo_community"
description 字符串	配置文件的描述。 返回：changed 示例："custom description"
dialog_aware 布尔值	指定系统是否收集SIP对话信息。 返回：changed 示例：false
enable_sip_firewall 布尔值	指定高级防火墙管理器策略是否启用。 返回：changed 示例：true
insert_record_route_header 布尔值	指定系统是否插入Record-Route SIP头。 返回：changed 示例：true
insert_via_header 布尔值	指定系统是否在转发的SIP请求中插入Via头。 返回：changed 示例：true
log_profile 字符串	发布者用于发送日志消息的日志设置。 返回：changed 示例："/Common/alg_profile"
log_publisher 字符串	定义为记录消息的发布者。 返回：changed 示例："/Common/foo_publisher"
max_size 布尔值	指定BYE事务完成后系统是否关闭连接。 返回：changed 示例：false
parent 字符串	指定此配置文件继承设置的配置文件。 返回：changed 示例："/Common/sip"
secure_via_header 布尔值	指定系统是否在转发的SIP请求中插入安全的Via头。 返回：changed 示例：false
security 布尔值	启用增强的水平安全层安全检查。 返回：changed 示例：true
terminate_on_bye 布尔值	指定BYE事务完成后系统是否关闭连接。 返回：changed 示例：false
user_via_header 字符串	系统作为SIP请求消息中顶部Via头插入的值。 返回：changed 示例："SIP/2.0/UDP 10.10.10.10:5060"

作者

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题追踪器
• 主页
• 仓库 (源代码)