cisco.mso.mso_schema_site_l3out 模块 – 管理模式模板中的站点本地三层外部网络 (L3Out)

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.mso。您需要更多要求才能使用此模块，请参阅要求以了解详细信息。

要在剧本中使用它，请指定：cisco.mso.mso_schema_site_l3out。

概要 

在 Cisco ACI Multi-Site 上管理模式模板中的站点本地 L3Out。
此模块只能用于 MSO 3.0 或更高版本。
注意 - 对于低于 3.0 的版本使用此模块可能会破坏 MSO。

要求 

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

Multi Site Orchestrator v2.1 或更高版本

参数 

参数	注释
host 别名: hostname 字符串	ACI Multi Site Orchestrator 主机的 IP 地址或主机名。如果未在任务中指定值，则将使用环境变量 `MSO_HOST` 的值。
l3out 别名: name 字符串	要管理的 l3out 的名称。
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` 的值。
schema 字符串 / 必需	模式的名称。
site 字符串 / 必需	站点的名称。
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 字典	与此 L3out 关联的 VRF。
name 字符串 / 必需	要关联的 VRF 的名称。
schema 字符串	定义引用的 VRF 的模式。如果未指定此参数，则默认为当前模式。
template 字符串	定义引用的 VRF 的模板。如果未指定此参数，则默认为当前模式。

注释 

注意

此模块编写用于支持 Multi Site Orchestrator v2.1 或更新版本。某些或全部功能可能无法在早期版本上正常工作。

另请参阅 

另请参阅

cisco.mso.mso_schema_site: 管理模式中的站点。
cisco.mso.mso_schema_template_l3out: 管理模式模板中的 l3outs。

示例 

- name: Add a new site L3Out
  cisco.mso.mso_schema_site_l3out:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    l3out: L3out1
    vrf:
      name: vrfName
      template: TemplateName
      schema: schemaName
    state: present

- name: Remove a site L3Out
  cisco.mso.mso_schema_site_l3out:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    l3out: L3out1
    state: absent

- name: Query a specific site L3Out
  cisco.mso.mso_schema_site_l3out:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    l3out: L3out1
    state: query
  register: query_result

- name: Query all site l3outs
  cisco.mso.mso_schema_site_l3out:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    state: query
  register: query_result

作者

Anvitha Jain (@anvitha-jain)