cisco.aci.aci_l3out_logical_interface_profile_ospf_policy 模块 – 管理三层外部 (L3Out) OSPF 接口配置文件 (ospf:IfP)

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.aci.aci_l3out_logical_interface_profile_ospf_policy。

概要

• 管理 Cisco ACI 交换结构上的 L3Out 逻辑接口配置文件 OSPF 策略。

参数

参数	注释
annotation 字符串	用于注释对象的用户定义字符串。 如果任务中未指定该值，则将改用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定该值，且环境变量 ACI_ANNOTATION 也未指定，则将使用默认值。 默认值： "orchestrator:ansible"
certificate_name 别名: cert_name 字符串	附加到用于基于签名身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基本名称，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定该值，则将改用环境变量 ACI_CERTIFICATE_NAME 的值。
host 别名: hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将改用环境变量 ACI_HOST 的值。
interface_profile 别名: interface_profile_name, logical_interface 字符串	现有接口配置文件的名称。
l3out 别名: l3out_name 字符串	现有 L3Out 的名称。
node_profile 别名: node_profile_name, logical_node 字符串	节点配置文件的名称。
ospf_auth_key 字符串	OSPF 身份验证密钥。 当使用 ospf_auth_key 时，此模块将始终显示为 changed，因为该模块无法知道当前配置的密钥是什么。
ospf_auth_type 字符串	OSPF 身份验证类型。值 default 表示“无身份验证”设置。 选项 "default" "simple" "md5"
ospf_policy 别名: name, ospf_policy_name 字符串	现有 OSPF 接口策略的名称。
output_level 字符串	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果任务中未指定该值，则将改用环境变量 ACI_OUTPUT_LEVEL 的值。 选项 "debug" "info" "normal" ← (默认)
output_path 字符串	将用于转储模块生成的 ACI JSON 配置对象的文件路径。 如果任务中未指定该值，则将改用环境变量 ACI_OUTPUT_PATH 的值。
owner_key 字符串	ACI 对象的 ownerKey 属性的用户定义字符串。 此属性表示一个键，用于使客户端能够拥有其数据以进行实体关联。 如果任务中未指定该值，则将改用环境变量 ACI_OWNER_KEY 的值。
owner_tag 字符串	ACI 对象的 ownerTag 属性的用户定义字符串。 此属性表示一个标签，用于使客户端能够添加自己的数据。 例如，指示谁创建了此对象。 如果任务中未指定该值，则将改用环境变量 ACI_OWNER_TAG 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将改用它。 如果任务中未指定该值，则将改用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port integer	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将改用环境变量 ACI_PORT 的值。
private_key aliases: cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将忽略它。 如果任务中未指定该值，则将改用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
state 字符串	使用 present 或 absent 进行添加或删除。 使用 query 列出一个或多个对象。 选项 "absent" "present" ← (默认) "query"
suppress_previous aliases: no_previous, ignore_previous boolean	如果为 true，则在向 APIC 发送 POST 更新之前，不会发送 GET 来检查先前状态。 如果任务中未指定该值，则将改用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致先前的返回值为空。 将不检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false true
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	如果为 true，则在向 APIC 发送 POST 更新后，不会发送验证 GET。 如果任务中未指定该值，则将改用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议值。 在单个任务中，当前对象（包括默认值）将无法验证。 选项 false true
tenant aliases: tenant_name 字符串	现有租户的名称。
timeout integer	套接字级别的超时时间（以秒为单位）。 如果任务中未指定该值，则将改用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
use_proxy boolean	如果为 false，即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定该值，则将改用环境变量 ACI_USE_PROXY 的值。 默认值为 true。 选项 false true
use_ssl boolean	如果为 false，则将使用 HTTP 连接，而不是默认的 HTTPS 连接。 如果任务中未指定该值，则将改用环境变量 ACI_USE_SSL 的值。 当连接为本地连接时，默认值为 true。 选项 false true
username aliases: user 字符串	用于身份验证的用户名。 如果任务中未指定该值，则将改用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。 默认值为 admin。
validate_certs boolean	如果为 false，则不会验证 SSL 证书。 只有在个人控制的使用自签名证书的站点上使用时，才应将其设置为 false。 如果任务中未指定该值，则将改用环境变量 ACI_VALIDATE_CERTS 的值。 默认值为 true。 选项 false true

注释

注意

• 在 playbook 中使用此模块之前，必须存在 tenant、l3out、node_profile、interface_profile 和 ospf_policy。cisco.aci.aci_tenant、cisco.aci.aci_l3out、cisco.aci.aci_l3out_logical_node_profile、cisco.aci.aci_l3out_logical_interface_profile 和 (cisco.aci.aci_interface_policy_ospf) 可用于此目的。

另请参阅

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_l3out

管理第 3 层外部 (L3Out) 对象 (l3ext:Out)。

cisco.aci.aci_l3out_logical_node_profile

管理第 3 层外部 (L3Out) 逻辑节点配置文件 (l3ext:LNodeP)。

cisco.aci.aci_l3out_logical_interface_profile

管理第 3 层外部 (L3Out) 逻辑接口配置文件 (l3ext:LIfP)。

cisco.aci.aci_interface_policy_ospf

管理 OSPF 接口策略 (ospf:IfPol)。

APIC 管理信息模型参考

有关内部 APIC 类 ospf:IfP 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new interface profile OSPF policy
  cisco.aci.aci_l3out_logical_interface_profile_ospf_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    ospf_policy: my_ospf_interface_policy
    state: present
  delegate_to: localhost

- name: Add a new interface profile OSPF policy with authentication
  cisco.aci.aci_l3out_logical_interface_profile_ospf_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    ospf_policy: my_ospf_interface_policy
    ospf_auth_type: simple
    ospf_auth_key: my_auth_key
    state: present
  delegate_to: localhost

- name: Delete an interface profile OSPF policy
  cisco.aci.aci_l3out_logical_interface_profile_ospf_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    ospf_policy: my_ospf_interface_policy
    state: absent
  delegate_to: localhost

- name: Query an interface profile OSPF policy
  cisco.aci.aci_l3out_logical_interface_profile_ospf_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    ospf_policy: my_ospf_interface_policy
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

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

作者

• Jason Juenger (@jasonjuenger)

• Gaspard Micol (@gmicol)

集合链接

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