модуль cisco.mso.mso_tenant — управление арендаторами

Примечание

Этот модуль входит в коллекцию cisco.mso (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.mso_tenant.

Краткое описание
Требования
Параметры
Примечания
Примеры

Краткое описание

Управление арендаторами в Cisco ACI Multi-Site.

Требования

Следующие требования должны быть выполнены на узле, на котором запускается этот модуль.

Multi Site Orchestrator версии 2.1 или новее

Параметры

Параметр	Комментарии
description string	Описание этого арендатора.
display_name string	Имя арендатора, отображаемое в веб-интерфейсе.
host псевдонимы: hostname string	IP-адрес или имя узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_HOST`.
login_domain string	Имя домена входа, используемого для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаризации `ansible_httpapi_login_domain`.
orchestrator_only string	Значение `no` используется для удаления арендатора из MSO и Sites/APIC. Значение `yes` используется для удаления арендатора только из MSO. Варианты: `"yes"` ← (по умолчанию) `"no"`
output_level string	Определяет состав выходных данных этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая сведения `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password string	Пароль, используемый для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_PORT`.
remote_users list / элементы=dictionary	Список связанных удалённых пользователей этого арендатора.
login_domain string / обязательный	Имя домена связанного удалённого пользователя этого арендатора.
name string / обязательный	Имя связанного удалённого пользователя этого арендатора.
sites list / элементы=string	Список связанных площадок этого арендатора. Использование этого свойства заменит все существующие связанные площадки.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
tenant псевдонимы: name string	Имя арендатора.
timeout integer	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_TIMEOUT`.
use_proxy boolean	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl boolean	Если `false`, вместо подключения HTTPS по умолчанию будет использоваться подключение HTTP. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаризации `ansible_httpapi_use_ssl`. Значение по умолчанию — `false` при использовании плагина подключения HTTPAPI (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`
username string	Имя пользователя, используемое для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
users list / элементы=string	Список связанных пользователей этого арендатора. Использование этого свойства заменит всех существующих связанных пользователей. Пользователь Admin всегда добавляется в список связанных пользователей независимо от того, используется ли этот параметр.
validate_certs boolean	Если `false`, SSL-сертификаты не будут проверяться. Устанавливайте значение `false` только при использовании на контролируемых вами площадках с самоподписанными сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Этот модуль разработан для поддержки Multi Site Orchestrator версии 2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

Примеры

- name: Add a new tenant
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    display_name: North European Datacenter
    description: This tenant manages the NEDC environment.
    state: present

- name: Remove a tenant from MSO and Site/APIC
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    orchestrator_only: 'no'
    state: absent

- name: Remove a tenant from MSO only
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    orchestrator_only: 'yes'
    state: absent

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

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

Авторы

Dag Wieers (@dagwieers)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/mso/mso_tenant_module.html