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

Примечание

Этот модуль является частью коллекции cisco.mso (версия 2.9.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 строка	Описание этого арендатора.
display_name строка	Имя арендатора, которое будет отображаться в веб-интерфейсе.
host псевдонимы: hostname строка	IP-адрес или имя хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, будет использовано значение переменной окружения `MSO_HOST`.
login_domain строка	Имя домена входа для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, будет использовано значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использовано значение переменной инвентаризации `ansible_httpapi_login_domain`.
orchestrator_only строка	Только Orchestrator `no` используется для удаления арендатора из MSO и Sites/APIC. `yes` используется для удаления арендатора только из MSO. Варианты: `"yes"` ← (по умолчанию) `"no"`
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`.
remote_users список / элементы=словарь	Список связанных удаленных пользователей для этого арендатора.
login_domain строка / обязательно	Имя домена связанного удаленного пользователя для этого арендатора.
name строка / обязательно	Имя связанного удаленного пользователя для этого арендатора.
sites список / элементы=строка	Список связанных сайтов для этого арендатора. Использование этого свойства заменит любые существующие связанные сайты.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
tenant псевдонимы: name строка	Имя арендатора.
timeout целое число	Таймаут уровня сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, будет использовано значение переменной окружения `MSO_TIMEOUT`.
use_proxy логический	Если `false`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `MSO_USE_PROXY`. По умолчанию `true`. Варианты: `false` `true`
use_ssl логический	Если `false`, вместо стандартного HTTPS-соединения будет использоваться HTTP-соединение. Если значение не указано в задаче, будет использовано значение переменной окружения `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использовано значение переменной инвентаризации `ansible_httpapi_use_ssl`. Значение по умолчанию — `false` при использовании плагина подключения HTTPAPI (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`
username строка	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных окружения `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.

users

список / элементы=строка

Список связанных пользователей для данного арендатора.

Использование этого свойства заменит всех существующих связанных пользователей.

Пользователь администратор всегда добавляется в список связанных пользователей независимо от использования этого параметра.

validate_certs

логический тип

Если false, сертификаты SSL не будут проверены.

Это следует устанавливать только в false случае использования на сайтах, контролируемых пользователем, с самоподписанными сертификатами.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_VALIDATE_CERTS.

По умолчанию true.

Варианты:

false
true

Примечания

Примечание

Этот модуль был написан для поддержки Multi Site Orchestrator v2.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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/mso_tenant_module.html