Модуль cisco.mso.mso_user — управление пользователями

Примечание

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

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

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

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

Обзор
Требования
Параметры
Примечания
Примеры

Обзор

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

Требования

Перечисленные ниже компоненты необходимы на хосте, который выполняет этот модуль.

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

Параметры

Параметр	Комментарии
account_status string	Статус учётной записи пользователя. Варианты: `"active"` `"inactive"`
domain string	Домен, к которому относится пользователь. При создании новых пользователей по умолчанию используется `Local`.
email string	Адрес электронной почты пользователя. Этот параметр обязателен при создании новых пользователей.
first_name string	Имя пользователя. Этот параметр обязателен при создании новых пользователей.
host псевдонимы: hostname string	IP-адрес или имя хоста узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_HOST`.
last_name string	Фамилия пользователя. Этот параметр обязателен при создании новых пользователей.
login_domain string	Имя домена входа для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_login_domain`.
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`.
phone string	Номер телефона пользователя. Этот параметр обязателен при создании новых пользователей.
port integer	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_PORT`.
roles list / elements=string	Роли этого пользователя и типы доступа для них (чтение или запись). По умолчанию используется тип доступа `write`.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
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`
user псевдонимы: name string	Имя пользователя.
user_password string	Пароль пользователя.
username string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs boolean	Если `false`, SSL-сертификаты проверяться не будут. Устанавливайте значение `false` только на подконтрольных вам сайтах, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `MSO_VALIDATE_CERTS`. По умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

В стандартной установке ACI Multi-Site используется пароль администратора ‘we1come!’, который необходимо сменить при первом входе. Примеры смены пароля пользователя ‘admin’ с помощью Ansible см. ниже.
Этот модуль предназначен для Multi Site Orchestrator версии 2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

Примеры

- name: Update initial admin password
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: initialPassword
    validate_certs: false
    user: admin
    user_password: newPassword
    state: present

- name: Add a new user
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    user: dag
    user_password: userPassword
    first_name: Dag
    last_name: Wieers
    email: dag@wieers.com
    phone: +32 478 436 299
    roles:
      - name: siteManager
        access_type: write
      - name: schemaManager
        access_type: read
    state: present

- name: Add a new user
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    user: dag
    first_name: Dag
    last_name: Wieers
    email: dag@wieers.com
    phone: +32 478 436 299
    roles:
      - powerUser

- name: Remove a user
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    user: dag
    state: absent

- name: Query a user
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    user: dag
    state: query
  register: query_result

- name: Query all users
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    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_user_module.html