cisco.mso.mso_schema 模块 – 管理模式

注意

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

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

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

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

概要 

管理 Cisco ACI Multi-Site 上的模式。

要求 

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

Multi Site Orchestrator v2.1 或更新版本

参数 

参数	注释
描述字符串	模式的描述。
host 别名：hostname 字符串	ACI Multi Site Orchestrator 主机的 IP 地址或主机名。如果未在任务中指定该值，则将使用环境变量 `MSO_HOST` 的值。
id 字符串	模式的 ID。当需要更新 `schema` 时，此参数是必需的。
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 别名：name 字符串	模式的名称。
状态字符串	使用 `absent` 进行删除。使用 `query` 列出一个或多个对象。使用 `present` 进行创建或更新。仅在 MSO 4.1 或更高版本上支持。选项 `"absent"` `"query"` ← (默认) `"present"`
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`

注意 

注意

由于 MSO REST API 的限制，此模块只能在 MSO 4.1 或更高版本上创建空模式（即没有模板的模式）。使用 cisco.mso.mso_schema_template 自动创建带有模板的模式。
此模块编写的目的是为了支持 Multi Site Orchestrator v2.1 或更高版本。某些或全部功能可能在早期版本上无法正常工作。

另请参阅 

另请参阅

cisco.mso.mso_schema_site: 管理模式中的站点。
cisco.mso.mso_schema_template: 管理模式中的模板。

示例 

- name: Create schema
  cisco.mso.mso_schema:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    state: present
  delegate_to: localhost

- name: Remove schemas
  cisco.mso.mso_schema:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    state: absent

- name: Query a schema
  cisco.mso.mso_schema:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    state: query
  register: query_result

- name: Query all schemas
  cisco.mso.mso_schema:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  register: query_result

作者

Dag Wieers (@dagwieers)
Akini Ross (@akinross)