cisco.mso.mso_schema_site_vrf_region_hub_network 模块 – 在模式模板中管理站点本地 VRF 区域中心网络

注意

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

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

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

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

概要 

在 Cisco ACI Multi-Site 上管理模式模板中的站点本地 VRF 区域中心网络。
“中心网络”功能是在 Multi-Site Orchestrator (MSO) 3.0(1) 版（针对 AWS）和 3.0(2) 版（针对 Azure）中引入的。

要求 

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

Multi Site Orchestrator v2.1 或更高版本

参数 

参数	注释
host 别名：hostname 字符串	ACI Multi Site Orchestrator 主机的 IP 地址或主机名。如果任务中未指定该值，则将改为使用环境变量 `MSO_HOST` 的值。
hub_network 字典	要管理的中心网络。
name 字符串 / 必需	中心网络的名称。 hub-default 是默认创建的中心网络。
tenant 字符串 / 必需	中心网络的租户名称。
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` 的值。
region 字符串 / 必需	区域的名称。
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 字符串 / 必需	VRF 的名称。

注意 

注意

ACI MultiSite PATCH API 有一个缺陷，需要通过索引引用某些对象。当在更改/删除对象时并发访问时，可能会导致静默损坏，因为可能会引用错误的对象。此模块受此缺陷影响。
此模块编写的目的是支持 Multi Site Orchestrator v2.1 或更高版本。某些或全部功能可能无法在早期版本上运行。

另请参阅 

另请参阅

cisco.mso.mso_schema_site_vrf_region: 管理模式模板中的站点本地 VRF 区域。
cisco.mso.mso_schema_template_vrf: 管理模式模板中的 VRF。

示例 

- name: Add a new site VRF region hub network
  cisco.mso.mso_schema_site_vrf_region_hub_network:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    region: us-west-1
    hub_network:
      name: hub-default
      tenant: infra
    state: present

- name: Remove a site VRF region hub network
  cisco.mso.mso_schema_site_vrf_region_hub_network:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    state: absent

- name: Query site VRF region hub network
  cisco.mso.mso_schema_site_vrf_region_hub_network:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    vrf: VRF1
    region: us-west-1
    state: query
  register: query_result

作者

Cindy Zhao (@cizhao)