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

Примечание

Этот модуль является частью коллекции cisco.mso (версия 2.9.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 или новее

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
account_status string	Статус учетной записи пользователя. Варианты: `"active"` `"inactive"`
domain string	Домен, к которому принадлежит этот пользователь. При создании новых пользователей это значение по умолчанию равно `Local`.
email string	Адрес электронной почты пользователя. Этот параметр обязателен при создании новых пользователей.
first_name string	Имя пользователя. Этот параметр обязателен при создании новых пользователей.
host aliases: 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` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dict `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`, будет использоваться HTTP-соединение вместо соединения HTTPS по умолчанию. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_SSL`. При использовании подключаемого модуля HTTPAPI переменная инвентаризации `ansible_httpapi_use_ssl` будет использоваться, если этот атрибут не указан. Значение по умолчанию - `false` при использовании подключаемого модуля HTTPAPI (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`
user aliases: name string	Имя пользователя.
user_password string	Пароль пользователя.

логин

строка

Имя пользователя для аутентификации.

Если значение не указано в задаче, будет использовано значение переменных среды MSO_USERNAME или ANSIBLE_NET_USERNAME.

validate_certs

логический

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

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

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

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

Варианты:

false
true

Примечания

Примечание

В стандартной установке ACI Multi-Site пароль администратора — ‘we1come!’, который необходимо сменить при первом входе. Ознакомьтесь с примерами изменения пароля администратора с помощью 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/mso_user_module.html