cisco.aci.aci_vrf 模块 – 管理上下文或 VRF (fv:Ctx)

注意

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

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

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

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

概要

• 在 Cisco ACI 交换矩阵上管理上下文或 VRF。

• 每个上下文都是与租户关联的专用网络，即 VRF。

• 为 VRF 启用首选组

参数

参数	注释
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 的值。
description 别名：descr 字符串	VRF 的描述。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将改用环境变量 ACI_HOST 的值。
ip_data_plane_learning 别名：ip_dataplane_learning 字符串	是否启用或禁用 IP 数据平面学习。 在创建期间未设置时，APIC 默认设置为 enabled。 选择 "enabled" "disabled"
match_type 字符串	配置 vzAny 下合同的匹配类型 选择 "all" "at_least_one" "at_most_one" "none"
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
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 的值。
policy_control_direction 字符串	确定策略应由交换矩阵在入口还是出口强制执行。 选择 "egress" "ingress"
policy_control_preference 字符串	确定交换矩阵是否应强制执行合同策略以允许路由和数据包转发。 选择 "enforced" "unenforced"
port 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将改用环境变量 ACI_PORT 的值。
preferred_group 字符串	为 vzAny 下的 VRF 启用首选组 选择 "enabled" "disabled"
private_key 别名：cert_key 字符串	用于基于签名身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果同时提供了 password，则会被忽略。 如果任务中未指定此值，则会改用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
状态 字符串	使用 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 字符串	VRF 所属的租户名称。
超时 整数	套接字级别的超时时间（以秒为单位）。 如果任务中未指定此值，则会改用环境变量 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（真）
vrf 别名：context, name, vrf_name 字符串	VRF 的名称。

注释

注意

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

参见

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

APIC 管理信息模型参考

有关内部 APIC 类 fv:Ctx 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new VRF to a tenant
  cisco.aci.aci_vrf:
    host: apic
    username: admin
    password: SomeSecretPassword
    vrf: vrf_lab
    tenant: lab_tenant
    descr: Lab VRF
    policy_control_preference: enforced
    policy_control_direction: ingress
    state: present
  delegate_to: localhost

- name: Remove a VRF for a tenant
  cisco.aci.aci_vrf:
    host: apic
    username: admin
    password: SomeSecretPassword
    vrf: vrf_lab
    tenant: lab_tenant
    state: absent
  delegate_to: localhost

- name: Query a VRF of a tenant
  cisco.aci.aci_vrf:
    host: apic
    username: admin
    password: SomeSecretPassword
    vrf: vrf_lab
    tenant: lab_tenant
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all VRFs
  cisco.aci.aci_vrf:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

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

作者

• Jacob McGill (@jmcgill298)

集合链接

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