cisco.mso.mso_schema_template_anp_epg 模块 – 在模式模板中管理端点组 (EPG)

注意

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

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

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

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

概要 

在 Cisco ACI 多站点上管理模式模板中的 EPG。

要求 

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

多站点协调器 v2.1 或更高版本

参数 

参数	注释
access_type 字符串	此参数指示如何访问服务。它仅在 epg_type 为 service 时可用。选项 `"private"` `"public"` `"public_and_private"`
anp 字符串 / 必需	ANP 的名称。
bd 字典	与此 ANP 关联的 BD。
name 字符串 / 必需	要关联的 BD 的名称。
schema 字符串	定义引用的 BD 的模式。如果未指定此参数，则默认为当前模式。
template 字符串	定义引用的 BD 的模板。
deployment_type 字符串	deployment_type 参数指示如何以及在何处部署服务。此参数仅在 epg_type 为 service 时可用。选项 `"cloud_native"` `"cloud_native_managed"` `"third_party"`
description 字符串	显示在 MSO Web 界面上的描述。 MSO 3.3 或更高版本支持描述。
display_name 字符串	显示在 MSO Web 界面上的名称。
epg 别名: name 字符串	要管理的 EPG 的名称。
epg_type 字符串	MSO 3.3 或更高版本支持 EPG 类型参数。选项 `"application"` `"service"`
host 别名: hostname 字符串	ACI 多站点协调器主机的 IP 地址或主机名。如果任务中未指定该值，则将改用环境变量 `MSO_HOST` 的值。
intersite_multicast_source 布尔值	是否启用站点间多播源。如果未指定，此参数默认为 `no`。选项 `false` `true`
intra_epg_isolation 字符串	是否强制执行 EPG 内隔离。如果未指定，此参数默认为 `unenforced`。选项 `"enforced"` `"unenforced"`
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（首选组）布尔值	此 EPG 是否添加到首选组。如果未指定，此参数默认为 `no`。选项 `false` `true`
proxy_arp（代理 ARP）布尔值	是否启用代理 ARP。如果未指定，此参数默认为 `no`。选项 `false` `true`
qos_level（QoS 级别）字符串	服务质量 (QoS) 允许您对网络中的流量进行分类。它有助于优先处理和管理流量，以帮助避免网络拥塞。 MSO 3.1 或更高版本支持合同 QoS 级别参数。
schema 字符串 / 必需	模式的名称。
service_type（服务类型）字符串	service_type 参数指的是云服务的类型。对于每种服务类型，仅支持某些部署类型以及每种部署类型中的某些访问类型。此参数仅在 epg_type 为 service 时可用。
state（状态）字符串	使用 `present` 或 `absent` 进行添加或删除。使用 `query` 列出一个或多个对象。选项 `"absent"（不存在）` `"present"` ← (默认) `"query"（查询）`
subnets（子网）列表 / 元素=字典	与此 ANP 关联的子网。
description 字符串	此子网的描述。
no_default_gateway（无默认网关）布尔值	此子网是否具有默认网关。选项 `false` ← (默认) `true`
scope（范围）字符串	子网的范围。选项 `"private"` ← (默认) `"public"`
shared（共享）布尔值	此子网是否在 VRF 之间共享。选项 `false` ← (默认) `true`
subnet（子网）别名：ip 字符串 / 必需	以 CIDR 表示法表示的 IP 范围。
template 字符串 / 必需	模板的名称。
timeout（超时）整数	套接字级别的超时时间（以秒为单位）。默认值为 30 秒。如果任务中未指定该值，则将使用环境变量 `MSO_TIMEOUT` 的值。
use_proxy（使用代理）布尔值	如果为 `false`，即使在目标主机上的环境变量中定义了代理，也不会使用代理。如果任务中未指定该值，则将使用环境变量 `MSO_USE_PROXY` 的值。默认值为 `true`。选项 `false` `true`
use_ssl（使用 SSL）布尔值	如果为 `false`，将使用 HTTP 连接而不是默认的 HTTPS 连接。如果任务中未指定该值，则将使用环境变量 `MSO_USE_SSL` 的值。当使用 HTTPAPI 连接插件时，如果未指定此属性，则将使用清单变量 `ansible_httpapi_use_ssl`。当使用 HTTPAPI 连接插件（mso 或 nd）时，默认值为 `false`，当使用旧版连接方法（仅适用于 mso）时，默认值为 `true`。选项 `false` `true`
useg_epg（USEG EPG）布尔值	这是否是 USEG EPG。选项 `false` `true`
username（用户名）字符串	用于身份验证的用户名。如果任务中未指定该值，则将使用环境变量 `MSO_USERNAME` 或 `ANSIBLE_NET_USERNAME` 的值。
validate_certs（验证证书）布尔值	如果为 `false`，则不会验证 SSL 证书。仅当在个人控制的站点上使用自签名证书时，才应将其设置为 `false`。如果任务中未指定该值，则将使用环境变量 `MSO_VALIDATE_CERTS` 的值。默认值为 `true`。选项 `false` `true`
vrf（VRF）字典	与此 ANP 关联的 VRF。
name 字符串 / 必需	要关联的 VRF 的名称。
schema 字符串	定义所引用 VRF 的模式。如果未指定此参数，则默认为当前模式。
template 字符串	定义所引用 VRF 的模板。

注释 

注意

此模块旨在支持 Multi Site Orchestrator v2.1 或更高版本。某些或全部功能可能在早期版本上不起作用。

另请参阅 

另请参阅

cisco.mso.mso_schema_template_anp: 管理模式模板中的应用程序网络配置文件 (ANP)。
cisco.mso.mso_schema_template_anp_epg_subnet: 管理模式模板中的 EPG 子网。
cisco.mso.mso_schema_template_bd: 管理模式模板中的桥域 (BD)。
cisco.mso.mso_schema_template_contract_filter: 管理模式模板中的合同过滤器。

示例 

- name: Add a new EPG
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    bd:
      name: bd1
    vrf:
      name: vrf1
    state: present

- name: Add a new EPG with preferred group.
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    state: present
    preferred_group: true

- name: Remove an EPG
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    bd:
      name: bd1
    vrf:
      name: vrf1
    state: absent

- name: Query a specific EPG
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    bd:
      name: bd1
    vrf:
      name: vrf1
    state: query
  register: query_result

- name: Query all EPGs
  cisco.mso.mso_schema_template_anp_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    anp: ANP 1
    epg: EPG 1
    bd:
      name: bd1
    vrf:
      name: vrf1
    state: query
  register: query_result

作者

Dag Wieers (@dagwieers)
Anvitha Jain (@anvitha-jain)