cisco.mso.mso_schema_template_vrf_contract 模块 – 在架构模板中管理VRF合同

注意

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

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

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

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

cisco.mso 0.0.8 中的新增功能

概要 

在 Cisco ACI 多站点上管理架构模板中的 VRF 合同。

要求 

以下是执行此模块的主机所需的条件。

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

参数 

参数	注释
contract 字典	与该 VRF 关联的合同。
name 字符串 / 必需	要关联的合同的名称。
schema 字符串	定义引用合同的架构。如果未指定此参数，则默认为当前架构。
template 字符串	定义引用合同的模板。
type 字符串 / 必需	合同的类型。选项 `"consumer"` `"provider"`
host 别名：hostname 字符串	ACI 多站点协调器主机的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`
VRF 字符串 / 必需	VRF 的名称。

备注 

注意

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

另请参阅 

另请参阅

cisco.mso.mso_schema_template_vrf: 管理架构模板中的 VRF。

示例 

- name: Add a contract to a VRF
  cisco.mso.mso_schema_template_vrf_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    vrf: VRF 1
    contract:
      name: Contract 1
      type: consumer
    state: present

- name: Remove a Contract
  cisco.mso.mso_schema_template_vrf_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    vrf: VRF 1
    contract:
      name: Contract 1
      type: consumer
    state: absent

- name: Query a specific Contract
  cisco.mso.mso_schema_template_vrf_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    vrf: VRF 1
    contract:
      name: Contract 1
      type: consumer
    state: query
  register: query_result

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

作者

Cindy Zhao (@cizhao)