• 博客
  • Ansible 社区论坛
  • 文档
Ansible Logo
Ansible 社区文档
Ansible

Ansible 入门

  • Ansible 入门
  • 执行环境入门

安装、升级和配置

  • 安装指南
  • Ansible 移植指南

使用 Ansible

  • 构建 Ansible 清单
  • 使用 Ansible 命令行工具
  • 使用 Ansible Playbook
  • 使用 Ansible Vault 保护敏感数据
  • 使用 Ansible 模块和插件
  • 使用 Ansible 集合
  • 在 Windows 和 BSD 上使用 Ansible
  • Ansible 技巧和窍门

为 Ansible 做贡献

  • Ansible 社区指南
  • Ansible 集合贡献者指南
  • ansible-core 贡献者指南
  • 高级贡献者指南
  • Ansible 文档风格指南

扩展 Ansible

  • 开发者指南

常见的 Ansible 场景

  • 旧版公有云指南

网络自动化

  • 网络入门
  • 网络高级主题
  • 网络开发者指南

Ansible Galaxy

  • Galaxy 用户指南
  • Galaxy 开发者指南

参考和附录

  • 集合索引
    • Amazon 命名空间中的集合
    • Ansible 命名空间中的集合
    • Arista 命名空间中的集合
    • Awx 命名空间中的集合
    • Azure 命名空间中的集合
    • Check_point 命名空间中的集合
    • Chocolatey 命名空间中的集合
    • Cisco 命名空间中的集合
      • Cisco.Aci
        • 描述
        • 插件索引
      • Cisco.Asa
      • Cisco.Dnac
      • Cisco.Intersight
      • Cisco.Ios
      • Cisco.Iosxr
      • Cisco.Ise
      • Cisco.Meraki
      • Cisco.Mso
      • Cisco.Nxos
      • Cisco.Ucs
    • Cloud 命名空间中的集合
    • Cloudscale_ch 命名空间中的集合
    • Community 命名空间中的集合
    • Containers 命名空间中的集合
    • Cyberark 命名空间中的集合
    • Dellemc 命名空间中的集合
    • F5networks 命名空间中的集合
    • Fortinet 命名空间中的集合
    • Frr 命名空间中的集合
    • Gluster 命名空间中的集合
    • Google 命名空间中的集合
    • Grafana 命名空间中的集合
    • Hetzner 命名空间中的集合
    • Hpe 命名空间中的集合
    • Ibm 命名空间中的集合
    • Ieisystem 命名空间中的集合
    • Infinidat 命名空间中的集合
    • Infoblox 命名空间中的集合
    • Inspur 命名空间中的集合
    • Junipernetworks 命名空间中的集合
    • Kaytus 命名空间中的集合
    • Kubernetes 命名空间中的集合
    • Kubevirt 命名空间中的集合
    • Lowlydba 命名空间中的集合
    • Mellanox 命名空间中的集合
    • Microsoft 命名空间中的集合
    • Netapp 命名空间中的集合
    • Netapp_eseries 命名空间中的集合
    • Netbox 命名空间中的集合
    • Ngine_io 命名空间中的集合
    • Openstack 命名空间中的集合
    • Openvswitch 命名空间中的集合
    • Ovirt 命名空间中的集合
    • Purestorage 命名空间中的集合
    • Sensu 命名空间中的集合
    • Servicenow 命名空间中的集合
    • Splunk 命名空间中的集合
    • T_systems_mms 命名空间中的集合
    • Telekom_mms 命名空间中的集合
    • Theforeman 命名空间中的集合
    • Vmware 命名空间中的集合
    • Vultr 命名空间中的集合
    • Vyos 命名空间中的集合
    • Wti 命名空间中的集合
  • 所有模块和插件的索引
  • Playbook 关键字
  • 返回值
  • Ansible 配置设置
  • 控制 Ansible 的行为方式:优先级规则
  • YAML 语法
  • Python 3 支持
  • 解释器发现
  • 发布和维护
  • 测试策略
  • 健全性测试
  • 常见问题解答
  • 词汇表
  • Ansible 参考:模块实用程序
  • 特殊变量
  • Red Hat Ansible 自动化平台
  • Ansible 自动化中心
  • 记录 Ansible 输出

路线图

  • Ansible 路线图
  • ansible-core 路线图




Ansible
  • 集合索引
  • Cisco 命名空间中的集合
  • Cisco.Aci
  • cisco.aci.aci_interface_policy_link_level 模块 – 管理链路层接口策略 (fabric:HIfPol)


cisco.aci.aci_interface_policy_link_level 模块 – 管理链路层接口策略 (fabric:HIfPol)

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.aci.aci_interface_policy_link_level。

  • 概要

  • 参数

  • 另请参阅

  • 示例

  • 返回值

概要

  • 链路层接口策略指定交换机接口的第 1 层参数。

参数

参数

注释

annotation

字符串

用于注释对象的用户定义字符串。

如果在任务中未指定值,则将使用环境变量 ACI_ANNOTATION 的值。

如果在任务中未指定值,并且环境变量 ACI_ANNOTATION 也未指定,则将使用默认值。

默认值: "orchestrator:ansible"

auto_negotiation

布尔值

自动协商使设备能够自动交换有关速度和双工能力的信息。

在创建期间未设置时,APIC 默认为 on。

选择

  • false

  • true ←(默认)

certificate_name

别名:cert_name

字符串

附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。

如果提供了 private_key 文件名,则此值默认为 private_key 的基本名称,不带扩展名。

如果为 private_key 提供了 PEM 格式的内容,则此值默认为 username 值。

如果在任务中未指定值,则将使用环境变量 ACI_CERTIFICATE_NAME 的值。

description

别名:descr

字符串

链路层接口策略的描述。

forwarding_error_correction

字符串

确定转发错误校正 (FEC) 模式。

在创建期间未设置时,APIC 默认为 inherit。

选择

  • "inherit" ←(默认)

  • "kp-fec"

  • "cl91-rs-fec"

  • "cl74-fc-fec"

  • "disable-fec"

  • "ieee-rs-fec"

  • "cons16-rs-fec"

host

别名:hostname

字符串

Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。

如果在任务中未指定值,则将使用环境变量 ACI_HOST 的值。

link_debounce_interval

整数

为物理接口端口启用去抖动计时器,并将其设置为指定的毫秒数。

在创建期间未设置时,APIC 默认为 100。

默认值: 100

link_level_policy

别名:name

字符串

链路层接口策略的名称。

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

整数

用于 REST 连接的端口号。

默认值取决于参数 use_ssl。

如果任务中未指定该值,则将改用环境变量 ACI_PORT 的值。

private_key

别名: cert_key

字符串

用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。

此值也会影响所使用的默认 certificate_name。

此选项与 password 互斥。如果也提供了 password,则将被忽略。

如果任务中未指定该值,则将改用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。

speed

字符串

确定接口策略管理端口速度。

仅在 APIC 5.2 或更高版本中支持 auto 选项。

在创建期间未设置时,APIC 默认为 inherit。

选择

  • "100M"

  • "1G"

  • "10G"

  • "25G"

  • "40G"

  • "50G"

  • "100G"

  • "200G"

  • "400G"

  • "auto"

  • "inherit" ←(默认)

state

字符串

使用 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

timeout

整数

套接字级别超时(以秒为单位)。

如果任务中未指定该值,则将改用环境变量 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

字符串

用于身份验证的用户名。

如果任务中未指定该值,则将改用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。

默认值为 admin。

validate_certs

布尔值

如果为 false,则不会验证 SSL 证书。

仅当在个人控制的站点上使用自签名证书时,才应将其设置为 false。

如果任务中未指定该值,则将改用环境变量 ACI_VALIDATE_CERTS 的值。

默认值为 true。

选择

  • false

  • true

参见

另请参阅

APIC 管理信息模型参考

有关内部 APIC 类 fabric:HIfPol 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a Link Level Policy
  cisco.aci.aci_interface_policy_link_level:
    host: apic
    username: admin
    password: SomeSecretPassword
    link_level_policy: link_level_policy_test
    description: via Ansible
    auto_negotiation: 'on'
    speed: 100M
    link_debounce_interval: 100
    forwarding_error_correction: cl91-rs-fec
    state: present
  delegate_to: localhost

- name: Remove a Link Level Policy
  cisco.aci.aci_interface_policy_link_level:
    host: apic
    username: admin
    password: SomeSecretPassword
    link_level_policy: ansible_test
    state: absent

- name: Query a Link Level Policy
  cisco.aci.aci_interface_policy_link_level:
    host: apic
    username: admin
    password: SomeSecretPassword
    link_level_policy: link_level_policy_test
    state: query
  delegate_to: localhost

- name: Query all Link Level Policies
  cisco.aci.aci_interface_policy_link_level:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

返回值

此处记录了常见的返回值 这里,以下是此模块特有的字段

键

描述

current

list / elements=string

模块完成后,来自 APIC 的现有配置

返回: 成功

示例: [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

从 APIC 返回的错误信息

返回: 失败

示例: {"code": "122", "text": "未知托管对象类 foo"}

filter_string

字符串

用于请求的筛选字符串

返回: 失败或调试

示例: "?rsp-prop-include=config-only"

method

字符串

用于向 APIC 发出请求的 HTTP 方法

返回: 失败或调试

示例: "POST"

previous

list / elements=string

模块启动之前,来自 APIC 的原始配置

返回: 信息

示例: [{"fvTenant": {"attributes": {"descr": "生产", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

从用户提供的参数组装的配置

返回: 信息

示例: {"fvTenant": {"attributes": {"descr": "生产环境", "name": "production"}}}

raw

字符串

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>"

response

字符串

来自 APIC 的 HTTP 响应

返回: 失败或调试

示例: "OK (30 字节)"

sent

list / elements=string

推送到 APIC 的实际/最小配置

返回: 信息

示例: {"fvTenant": {"attributes": {"descr": "生产环境"}}}

status

整数

来自 APIC 的 HTTP 状态

返回: 失败或调试

示例: 200

url

字符串

用于向 APIC 发出请求的 HTTP url

返回: 失败或调试

示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

  • Vasily Prokopov (@vasilyprokopov)

集合链接

  • 问题跟踪器
  • 存储库(源)
上一个 下一个

© 版权归 Ansible 项目贡献者所有。最后更新于 2024 年 12 月 19 日。