cisco.aci.aci_interface_policy_pim 模块 – 管理协议无关组播 (PIM) 接口策略 (pim:IfPol)

注意

此模块是 cisco.aci 集合（版本 2.10.1）的一部分。

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

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

要在 playbook 中使用它，请指定： cisco.aci.aci_interface_policy_pim。

概要

• 管理 Cisco ACI 结构上租户的协议无关组播接口策略。

参数

参数	注释
annotation string	用于注释对象的用户定义字符串。 如果未在任务中指定值，则将使用环境变量 ACI_ANNOTATION 的值。 如果未在任务中指定值且环境变量 ACI_ANNOTATION 未设置，则将使用默认值。 默认值： "orchestrator:ansible"
authentication_key 别名：auth_key string	身份验证密钥。
authentication_type 别名：auth_type string	身份验证类型。 选项 "none" "md5_hmac"
certificate_name 别名：cert_name string	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则此值默认为 private_key 的基本名称，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则此值默认为 username 值。 如果未在任务中指定值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
control_state list / elements=string	PIM 接口策略控制状态。 这是一个或多个以下控件的列表 multicast_domain_boundary – 组播域的边界。 strict_rfc_compliant – 仅侦听 PIM 协议数据包。 passive – 不发送/接收 PIM 协议数据包。 选项 "multicast_domain_boundary" "strict_rfc_compliant" "passive"
description 别名：descr string	PIM 接口策略的描述。
designated_router_delay 别名：delay integer	PIM 指定路由器延迟。 接受的值范围介于 1 和 65535 之间。 APIC 在创建期间未设置时默认为 3。
designated_router_priority 别名：prio integer	PIM 指定路由器优先级。 接受的值范围介于 1 和 4294967295 之间。 APIC 在创建期间未设置时默认为 1。
hello_interval integer	PIM 在接口上发送 hello 数据包的时间间隔（以秒为单位）。 hello 间隔越小，检测到拓扑更改的速度就越快，但路由流量也会随之增加。 接受的值范围介于 1 和 18724286 之间。 APIC 在创建期间未设置时默认为 30000。
host 别名：hostname string	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果未在任务中指定值，则将使用环境变量 ACI_HOST 的值。
inbound_join_prune_filter_policy 别名：inbound_filter string	接口级别的入站加入/剪枝筛选策略。 可以使用 cisco.aci.aci_pim_route_map_policy 来实现。 要删除它，请传递一个空字符串。
join_prune_interval 别名：jp_interval integer	加入剪枝间隔（以秒为单位）。 接受的值范围介于 60 和 65520 之间。 APIC 在创建期间未设置时默认为 60。
name_alias string	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
neighbor_filter_policy 别名：neighbor_filter string	接口级别的邻居筛选策略。 可以使用 cisco.aci.aci_pim_route_map_policy 来实现。 要删除它，请传递一个空字符串。
outbound_join_prune_filter_policy 别名：outbound_filter string	接口级别的出站加入/剪枝筛选策略。 可以使用 cisco.aci.aci_pim_route_map_policy 来实现。 要删除它，请传递一个空字符串。
output_level string	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息性输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_LEVEL 的值。 选项 "debug" "info" "normal" ← (默认)
output_path string	用于转储模块生成的 ACI JSON 配置对象的文件路径。 如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_PATH 的值。
owner_key string	ACI 对象的 ownerKey 属性的用户定义字符串。 此属性表示一个密钥，使客户端能够拥有其数据以进行实体关联。 如果任务中未指定该值，则将使用环境变量 ACI_OWNER_KEY 的值。
owner_tag string	ACI 对象的 ownerTag 属性的用户定义字符串。 此属性表示一个标签，使客户端能够添加自己的数据。 例如，指示谁创建了这个对象。 如果任务中未指定该值，则将使用环境变量 ACI_OWNER_TAG 的值。
password string	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将改为使用它。 如果任务中未指定该值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
pim 别名: pim_interface_policy, name string	PIM 接口策略名称。 对象创建后，名称无法更改。
port integer	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将使用环境变量 ACI_PORT 的值。
private_key 别名: cert_key string	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响所使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将忽略它。 如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
state string	使用 present 或 absent 添加或删除。 使用 query 列出一个或多个对象。 选项 "absent" "present" ← (默认) "query"
suppress_previous 别名: no_previous, ignore_previous 布尔值	如果为 true，则在向 APIC 发送 POST 更新之前不会发送 GET 请求来检查之前的状态。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致之前的返回值为空。 将不会检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false true
suppress_verification 别名: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为 true，则在向 APIC 发送 POST 更新之后不会发送验证 GET 请求。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议值。 包括默认值在内的当前对象在单个任务中将不可验证。 选项 false true
tenant 别名: tenant_name string	现有租户的名称。
timeout integer	套接字级别的超时时间（以秒为单位）。 如果任务中未指定该值，则将使用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
use_proxy 布尔值	如果为 false，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定该值，则将使用环境变量 ACI_USE_PROXY 的值。 默认值为 true。 选项 false true
use_ssl 布尔值	如果为 false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定该值，则将使用环境变量 ACI_USE_SSL 的值。 当连接为本地连接时，默认值为 true。 选项 false true
username 别名: user string	用于身份验证的用户名。 如果任务中未指定该值，则将使用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。 默认值为 admin。
validate_certs 布尔值	如果为 false，则不会验证 SSL 证书。 仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。 如果任务中未指定该值，则将使用环境变量 ACI_VALIDATE_CERTS 的值。 默认值为 true。 选项 false true

注释

注意

• 在你的 playbook 中使用此模块之前，必须存在使用的 tenant。可以使用 cisco.aci.aci_tenant 模块来实现此目的。

另请参阅

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_pim_route_map_policy

管理独立于协议的多播（PIM）路由图策略（pim:RouteMapPol）。

APIC 管理信息模型参考

有关内部 APIC 类 pim:IfPol 的更多信息。

Cisco ACI 指南

有关如何使用 Ansible 管理 ACI 基础架构的详细信息。

开发 Cisco ACI 模块

有关如何编写自己的 Cisco ACI 模块以进行贡献的详细指南。

示例

- name: Create a PIM interface policy
  cisco.aci.aci_interface_policy_pim:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    pim: my_pim_policy
    control_state: [multicast_domain_boundary, strict_rfc_compliant]
    designated_router_delay: 10
    designated_router_priority: tens_of_micro
    hello_interval: 5
    join_prune_interval: 15
    inbound_join_prune_filter_policy: my_pim_route_map_policy_1
    outbound_join_prune_filter_policy: my_pim_route_map_policy_2
    neighbor_filter_policy: my_pim_route_map_policy_3
    state: present
  delegate_to: localhost

- name: Query a PIM interface policy
  cisco.aci.aci_interface_policy_pim:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    pim: my_pim_policy
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all PIM interface policies in tenant production
  cisco.aci.aci_interface_policy_pim:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a PIM interface policy
  cisco.aci.aci_interface_policy_pim:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    pim: my_pim_policy
    state: present
  delegate_to: localhost

返回值

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

键	描述
current list / elements=string	模块完成后从 APIC 获取的现有配置 返回: 成功 示例: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	从 APIC 返回的错误信息 返回: 失败 示例： {"code": "122", "text": "unknown managed object class foo"}
filter_string string	用于请求的筛选字符串 返回： failure 或 debug 示例： "?rsp-prop-include=config-only"
method string	用于向 APIC 发送请求的 HTTP 方法 返回： failure 或 debug 示例： "POST"
previous list / elements=string	模块启动前 APIC 的原始配置 返回： info 示例： [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	由用户提供的参数组装的配置 返回： info 示例： {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw string	APIC REST API 返回的原始输出（xml 或 json） 返回： parse error 示例： "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
response string	来自 APIC 的 HTTP 响应 返回： failure 或 debug 示例： "OK (30 bytes)"
sent list / elements=string	推送到 APIC 的实际/最小配置 返回： info 示例： {"fvTenant": {"attributes": {"descr": "Production environment"}}}
status integer	来自 APIC 的 HTTP 状态 返回： failure 或 debug 示例： 200
url string	用于向 APIC 发送请求的 HTTP URL 返回： failure 或 debug 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Gaspard Micol (@gmicol)

集合链接

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