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。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在剧本中使用它，请指定：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`
username 字符串	用于身份验证的用户名。如果在任务中未指定该值，则将使用环境变量 `MSO_USERNAME` 或 `ANSIBLE_NET_USERNAME` 的值。
validate_certs 布尔值	如果为 `false`，则不会验证 SSL 证书。仅当在个人控制的站点上使用自签名证书时，才应将其设置为 `false`。如果在任务中未指定该值，则将使用环境变量 `MSO_VALIDATE_CERTS` 的值。默认为 `true`。选项 `false` `true`
vrf 别名：name 字符串	要管理的 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)