cisco.mso.mso_site 模块 – 管理站点

注意

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

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

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

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

概要 

管理 Cisco ACI 多站点上的站点。

要求 

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

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

参数 

参数	注释
apic_login_domain 字符串	APIC 的用户名对应的 AAA 登录域。使用 ND 平台时，不支持 apic_login_domain 属性。有关完整的站点管理信息，请参阅 ND 集合。
apic_password 字符串	APIC 的密码。使用 ND 平台时，不支持 apic_password 属性。有关完整的站点管理信息，请参阅 ND 集合。
apic_site_id 字符串	APIC 的站点 ID。
apic_username 字符串	APIC 的用户名。使用 ND 平台时，不支持 apic_username 属性。有关完整的站点管理信息，请参阅 ND 集合。默认值： `"admin"`
host 别名：hostname 字符串	ACI 多站点编排器主机的 IP 地址或主机名。如果任务中未指定此值，则将使用环境变量 `MSO_HOST` 的值。
labels 列表 / 元素=字符串	此站点的标签。尚不存在的标签将自动创建。使用 ND 平台时，不支持 labels 属性。有关完整的站点管理信息，请参阅 ND 集合。
location 字典	站点的地理位置。使用 ND 平台时，不支持 location 属性。有关完整的站点管理信息，请参阅 ND 集合。
latitude 浮点数	站点位置的纬度。
longitude 浮点数	站点位置的经度。
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` 的值。
site 别名：name 字符串	站点的名称。
state 字符串	使用 `present` 或 `absent` 添加或移除。使用 `query` 列出对象或多个对象。选项 `"absent"` `"present"` ← (默认) `"query"`
timeout 整数	以秒为单位的套接字级别超时。默认值为 30 秒。如果任务中未指定此值，则将使用环境变量 `MSO_TIMEOUT` 的值。
urls 列表 / 元素=字符串	引用 APIC 的 URL 列表。使用 ND 平台时，不支持 urls 属性。有关完整的站点管理信息，请参阅 ND 集合。
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或更高版本。某些或所有功能可能在早期版本上无法正常工作。

示例 

- name: Add a new site
  cisco.mso.mso_site:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    site: north_europe
    description: North European Datacenter
    apic_username: mso_admin
    apic_password: AnotherSecretPassword
    apic_site_id: 12
    urls:
      - 10.2.3.4
      - 10.2.4.5
      - 10.3.5.6
    labels:
      - NEDC
      - Europe
      - Diegem
    location:
      latitude: 50.887318
      longitude: 4.447084
    state: present

- name: Remove a site
  cisco.mso.mso_site:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    site: north_europe
    state: absent

- name: Query a site
  cisco.mso.mso_site:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    site: north_europe
    state: query
  register: query_result

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

作者

Dag Wieers (@dagwieers)