cisco.mso.mso_schema_template_external_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_external_epg。

概要 

管理 Cisco ACI Multi-Site 上模式模板中的外部 EPG。

别名：mso_schema_template_externalepg

要求 

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

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

参数 

参数	注释
anp 字典	与外部 EPG 关联的 anp。
名称字符串 / 必需	要关联的 anp 的名称。
模式字符串	定义引用的 anp 的模式。如果未指定此参数，则默认为当前模式。
模板字符串	定义引用的 anp 的模板。如果未指定此参数，则默认为当前模板。
描述字符串	在 3.3 或更高版本的 MSO 上支持外部 EPG 的描述。
display_name 字符串	在 MSO Web 界面上显示的名称。
external_epg 别名：name，externalepg 字符串	要管理的外部 EPG 的名称。
host 别名：hostname 字符串	ACI 多站点编排器主机的 IP 地址或主机名。如果未在任务中指定该值，则将改用环境变量 `MSO_HOST` 的值。
l3out 字典	与外部 EPG 关联的 L3Out。
名称字符串 / 必需	要关联的 L3Out 的名称。
模式字符串	定义引用的 L3Out 的模式。如果未指定此参数，则默认为当前模式。
模板字符串	定义引用的 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"` ← (默认)
密码字符串	用于身份验证的密码。如果未在任务中指定该值，则将改用环境变量 `MSO_PASSWORD` 或 `ANSIBLE_NET_PASSWORD` 的值。
端口整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果未在任务中指定该值，则将改用环境变量 `MSO_PORT` 的值。
preferred_group 布尔值	是否为此外部 EPG 启用首选组。选择 `false` `true`
模式字符串 / 必需	模式的名称。
状态字符串	使用 `present` 或 `absent` 添加或删除。使用 `query` 列出一个对象或多个对象。选择 `"absent"` `"present"` ← (默认) `"query"`
模板字符串 / 必需	模板的名称。
超时整数	套接字级别超时，以秒为单位。默认值为 30 秒。如果任务中未指定该值，则将使用环境变量 `MSO_TIMEOUT` 的值。
类型字符串	外部 EPG 的类型。当类型为云时，anp 需要与外部 EPG 关联。当类型为本地时，l3out 可以与外部 EPG 关联。选择 `"on-premise"` ← (默认) `"cloud"`
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 字典	与外部 EPG 关联的 VRF。
名称字符串 / 必需	要关联的 VRF 的名称。
模式字符串	定义引用的 VRF 的模式。如果未指定此参数，则默认为当前模式。
模板字符串	定义引用的 VRF 的模板。如果未指定此参数，则默认为当前模板。

备注 

注意

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

示例 

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

- name: Add a new external EPG with external epg in cloud
  cisco.mso.mso_schema_template_external_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    external_epg: External EPG 1
    type: cloud
    vrf:
      name: VRF
      schema: Schema 1
      template: Template 1
    anp:
      name: ANP1
      schema: Schema 1
      template: Template 1
    state: present

- name: Remove an external EPG
  cisco.mso.mso_schema_template_external_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    external_epg: external EPG1
    state: absent

- name: Query a specific external EPGs
  cisco.mso.mso_schema_template_external_epg:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    external_epg: external EPG1
    state: query
  register: query_result

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

作者

Dag Wieers (@dagwieers)

参数	注释
anp 字典	与外部 EPG 关联的 anp。
名称字符串 / 必需	要关联的 anp 的名称。
模式字符串	定义引用的 anp 的模式。如果未指定此参数，则默认为当前模式。
模板字符串	定义引用的 anp 的模板。如果未指定此参数，则默认为当前模板。
描述字符串	在 3.3 或更高版本的 MSO 上支持外部 EPG 的描述。
display_name 字符串	在 MSO Web 界面上显示的名称。
external_epg 别名：name，externalepg 字符串	要管理的外部 EPG 的名称。
host 别名：hostname 字符串	ACI 多站点编排器主机的 IP 地址或主机名。如果未在任务中指定该值，则将改用环境变量 `MSO_HOST` 的值。
l3out 字典	与外部 EPG 关联的 L3Out。
名称字符串 / 必需	要关联的 L3Out 的名称。
模式字符串	定义引用的 L3Out 的模式。如果未指定此参数，则默认为当前模式。
模板字符串	定义引用的 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"` ← (默认)
密码字符串	用于身份验证的密码。如果未在任务中指定该值，则将改用环境变量 `MSO_PASSWORD` 或 `ANSIBLE_NET_PASSWORD` 的值。
端口整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果未在任务中指定该值，则将改用环境变量 `MSO_PORT` 的值。
preferred_group 布尔值	是否为此外部 EPG 启用首选组。选择 `false` `true`
模式字符串 / 必需	模式的名称。
状态字符串	使用 `present` 或 `absent` 添加或删除。使用 `query` 列出一个对象或多个对象。选择 `"absent"` `"present"` ← (默认) `"query"`
模板字符串 / 必需	模板的名称。
超时整数	套接字级别超时，以秒为单位。默认值为 30 秒。如果任务中未指定该值，则将使用环境变量 `MSO_TIMEOUT` 的值。
类型字符串	外部 EPG 的类型。当类型为云时，anp 需要与外部 EPG 关联。当类型为本地时，l3out 可以与外部 EPG 关联。选择 `"on-premise"` ← (默认) `"cloud"`
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 字典	与外部 EPG 关联的 VRF。
名称字符串 / 必需	要关联的 VRF 的名称。
模式字符串	定义引用的 VRF 的模式。如果未指定此参数，则默认为当前模式。
模板字符串	定义引用的 VRF 的模板。如果未指定此参数，则默认为当前模板。