cisco.mso.mso_schema_template_vrf 模块 – 在架构模板中管理 VRF

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.mso。您需要其他要求才能使用此模块，请参阅要求获取详细信息。

要在 playbook 中使用它，请指定：cisco.mso.mso_schema_template_vrf。

概要 

管理 Cisco ACI 多站点上的架构模板中的 VRF。

要求 

执行此模块的主机需要以下要求。

多站点编排器 v2.1 或更高版本

参数 

参数	注释
bd_enforcement_status 布尔值	是否启用 BD 强制执行状态。选项 `false` `true`
display_name 字符串	在 MSO Web 界面上显示的名称。
主机 (host) 别名：主机名 (hostname) 字符串	ACI 多站点编排器主机的 IP 地址或主机名。如果任务中未指定此值，则将改为使用环境变量 `MSO_HOST` 的值。
ip_data_plane_learning 字符串	是否启用或禁用 IP 数据平面学习。在创建期间未设置时，APIC 默认值为 `enabled`。选项 `"disabled"` `"enabled"`
layer3_multicast 布尔值	是否启用 L3 多播。选项 `false` `true`
login_domain 字符串	用于身份验证的登录域名称。默认值为 Local。如果任务中未指定此值，则将改为使用环境变量 `MSO_LOGIN_DOMAIN` 的值。使用 HTTPAPI 连接插件时，如果未指定此属性，则将使用清单变量 `ansible_httpapi_login_domain`。
output_level 字符串	影响此 MSO 模块的输出。 `normal` 表示标准输出，包括 `current` 字典 `info` 添加信息输出，包括 `previous`、`proposed` 和 `sent` 字典 `debug` 添加调试输出，包括 `filter_string`、`method`、`response`、`status` 和 `url` 信息如果任务中未指定此值，则将改为使用环境变量 `MSO_OUTPUT_LEVEL` 的值。选项 `"debug"` `"info"` `"normal"` ← (默认)
password 字符串	用于身份验证的密码。如果任务中未指定此值，则将改为使用环境变量 `MSO_PASSWORD` 或 `ANSIBLE_NET_PASSWORD` 的值。
port 整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果任务中未指定此值，则将改为使用环境变量 `MSO_PORT` 的值。
preferred_group 布尔值	是否启用首选端点组。在创建期间未设置时，APIC 默认值为 `false`。选项 `false` `true`
schema 字符串 / 必需	架构的名称。
site_aware_policy_enforcement 布尔值	是否启用站点感知策略强制模式。启用或禁用站点感知策略强制模式将导致暂时中断流量。启用站点感知策略强制模式将增加现有合约的 TCAM 使用率。当需要站间 VRF 合约时，需要在使用者和提供者 VRF 中启用站点感知策略强制模式。启用站点感知策略强制模式时，无法使用合约许可日志记录。选项 `false` `true`
state 字符串	使用 `present` 或 `absent` 添加或删除。使用 `query` 列出对象或多个对象。选项 `"absent"` `"present"` ← (默认) `"query"`
template 字符串 / 必需	模板的名称。
timeout 整数	以秒为单位的套接字级别超时。默认值为 30 秒。如果任务中未指定此值，则将改为使用环境变量 `MSO_TIMEOUT` 的值。
use_proxy 布尔值	如果为 `false`，即使目标主机上的环境变量中定义了代理，它也不会使用代理。如果任务中未指定此值，则将改为使用环境变量 `MSO_USE_PROXY` 的值。默认为 `true`。选项 `false` `true`
use_ssl 布尔值	如果值为`false`，则将使用 HTTP 连接而不是默认的 HTTPS 连接。如果任务中未指定此值，则将改用环境变量`MSO_USE_SSL`的值。使用 HTTPAPI 连接插件时，如果未指定此属性，则将使用清单变量`ansible_httpapi_use_ssl`。使用 HTTPAPI 连接插件 (mso 或 nd) 时，默认值为`false`；使用传统连接方法 (仅限于 mso) 时，默认值为`true`。选项 `false` `true`
用户名字符串	用于身份验证的用户名。如果任务中未指定此值，则将改用环境变量`MSO_USERNAME`或`ANSIBLE_NET_USERNAME`的值。
验证证书布尔值	如果值为`false`，则不会验证 SSL 证书。仅当在使用自签名证书的个人控制站点上使用时，才应将其设置为`false`。如果任务中未指定此值，则将改用环境变量`MSO_VALIDATE_CERTS`的值。默认为 `true`。选项 `false` `true`
VRF 别名：名称字符串	要管理的 VRF 的名称。
vzAny 布尔值	是否启用 vzAny。选项 `false` `true`

备注 

注意

此模块编写用于支持 Multi Site Orchestrator v2.1 或更高版本。某些或所有功能可能在早期版本中不起作用。

示例 

- name: Add a new VRF
  cisco.mso.mso_schema_template_vrf:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    vrf: VRF 1
    state: present

- name: Remove an VRF
  cisco.mso.mso_schema_template_vrf:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    vrf: VRF1
    state: absent

- name: Query a specific VRFs
  cisco.mso.mso_schema_template_vrf:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    vrf: VRF1
    state: query
  register: query_result

- name: Query all VRFs
  cisco.mso.mso_schema_template_vrf:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    state: query
  register: query_result

作者

Akini Ross (@akinross)
Anvitha Jain (@anvitha-jain)
Dag Wieers (@dagwieers)