arista.eos.eos_user модуль — Управление коллекцией локальных пользователей на устройствах EOS

Примечание

Этот модуль входит в коллекцию arista.eos (версия 9.0.0).

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

Для её установки используйте: ansible-galaxy collection install arista.eos.

Для использования в книге задач укажите: arista.eos.eos_user.

Добавлен в arista.eos 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

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

Этот модуль обеспечивает декларативное управление локальными именами пользователей, настроенными на устройствах Arista EOS. Он позволяет задачам управления как отдельными именами пользователей, так и коллекцией имен пользователей в текущей конфигурации. Он также поддерживает очистку имен пользователей из конфигурации, которые не определены явно.

Псевдонимы: user

Параметры

Параметр	Комментарии
aggregate псевдонимы: users, collection список / элементы=словарь	Набор объектов имен пользователей, которые должны быть настроены на удаленном устройстве Arista EOS. Элементы списка могут быть именем пользователя или хешем имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом `username`.
configured_password строка	Пароль, который должен быть настроен на удаленном устройстве Arista EOS. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве.
name строка	Имя пользователя, которое должно быть настроено на удаленном устройстве Arista EOS. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом `aggregate`.
nopassword булево	Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без аутентификации паролем. Варианты: `false` `true`
privilege целое число	Аргумент `privilege` настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15.
role строка	Настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве.
sshkey строка	Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает допустимое значение ключа SSH.
state строка	Настраивает состояние определения имени пользователя по отношению к операционной конфигурации устройства. При установке в present имя(на) пользователя должно быть настроено в активной конфигурации устройства, а при установке в absent имя(на) пользователя не должно быть в активной конфигурации устройства Варианты: `"present"` `"absent"`
update_password строка	Так как пароли шифруются в конфигурации устройства, этот аргумент укажет модулю, когда следует изменить пароль. При установке в `always`, пароль всегда будет обновлен на устройстве, а при установке в `on_create`, пароль будет обновлен только в случае создания имени пользователя. Варианты: `"on_create"` `"always"`
configured_password строка	Пароль, который должен быть настроен на удаленном устройстве Arista EOS. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве.
name строка	Имя пользователя, которое должно быть настроено на удаленном устройстве Arista EOS. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом `aggregate`.
nopassword булево	Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без аутентификации паролем. Варианты: `false` `true`
privilege целое число	Аргумент `privilege` настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15.
purge булево	Указывает модулю рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin`, который не может быть удален из-за ограничений EOS. Варианты: `false` ← (по умолчанию) `true`
role строка	Настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроена ли роль на устройстве.
sshkey строка	Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает допустимое значение ключа SSH.
state строка	Настраивает состояние определения имени пользователя по отношению к операционной конфигурации устройства. При установке в present имя(на) пользователя должно быть настроено в активной конфигурации устройства, а при установке в absent имя(на) пользователя не должно быть в активной конфигурации устройства Варианты: `"present"` ← (по умолчанию) `"absent"`

END_OF_DOCUMENT_MARKER

update_password

string

Поскольку пароли зашифрованы в конфигурации устройства, этот аргумент укажет модулю, когда следует изменить пароль. При значении always, пароль всегда будет обновлен на устройстве, а при значении on_create, пароль будет обновлен только в случае создания имени пользователя.

Выбираемые значения:

"on_create"
"always" ← (по умолчанию)

Примечания

Примечание

Проверено на Arista EOS 4.24.6F

Примеры

- name: create a new user
  arista.eos.eos_user:
    name: ansible
    sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
    state: present

- name: remove all users except admin
  arista.eos.eos_user:
    purge: true

- name: set multiple users to privilege level 15
  arista.eos.eos_user:
    aggregate:
      - name: netop
      - name: netend
    privilege: 15
    state: present

- name: Change Password for User netop
  arista.eos.eos_user:
    username: netop
    configured_password: '{{ new_password }}'
    update_password: always
    state: present

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
commands список / элементы=строка	Список команд режима конфигурации для отправки на устройство Возвращается: всегда Пример: `["name ansible secret password", "name admin secret admin"]`
session_name строка	Имя сеанса конфигурации EOS, используемого для загрузки конфигурации Возвращается: когда changed равно True Пример: `"ansible_1479315771"`

Авторы

Peter Sprygada (@privateip)

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

© 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/arista/eos/eos_user_module.html