cisco.mso.mso_schema_template_external_epg_contract 模块 – 在模式模板中管理外部 EPG 合约

注意

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

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

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

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

cisco.mso 0.0.8 中的新增功能

概要 

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

要求 

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

Multi Site Orchestrator v2.1 或更高版本

参数 

参数	注释
contract 字典	与此 EPG 关联的合约。
name 字符串 / 必需	要关联的合约的名称。
schema 字符串	定义引用的 BD 的模式。如果未指定此参数，则默认为当前模式。
template 字符串	定义引用的 BD 的模板。
type 字符串 / 必需	合约的类型。选项 `"consumer"` `"provider"`
external_epg 字符串 / 必需	要管理的 EPG 的名称。
host 别名：hostname 字符串	ACI Multi Site Orchestrator 主机的 IP 地址或主机名。如果未在任务中指定该值，则将改用环境变量 `MSO_HOST` 的值。
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 字符串 / 必需	模式的名称。
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`

备注 

注意

此模块旨在支持 Multi Site Orchestrator v2.1 或更高版本。某些或所有功能可能在早期版本上无法使用。

另请参阅 

另请参阅

cisco.mso.mso_schema_template_external_epg: 管理模式模板中的外部 EPG。
cisco.mso.mso_schema_template_contract_filter: 管理模式模板中的合约过滤器。

示例 

- name: Add a contract to an EPG
  cisco.mso.mso_schema_template_external_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    epg: EPG 1
    contract:
      name: Contract 1
      type: consumer
    state: present

- name: Remove a Contract
  cisco.mso.mso_schema_template_external_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    epg: EPG 1
    contract:
      name: Contract 1
    state: absent

- name: Query a specific Contract
  cisco.mso.mso_schema_template_external_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    epg: EPG 1
    contract:
      name: Contract 1
    state: query
  register: query_result

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

作者

Devarshi Shah (@devarshishah3)