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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 list / элементы=dictionary	Список объектов имён пользователей для настройки на удалённом устройстве Arista EOS. Элементы списка могут содержать имя пользователя или хеш с именем пользователя и свойствами. Этот аргумент нельзя использовать одновременно с аргументом `username`.
configured_password string	Пароль для настройки на удалённом устройстве Arista EOS. Пароль необходимо указать в открытом виде; на устройстве он будет зашифрован.
name string	Имя пользователя для настройки на удалённом устройстве Arista EOS. Этот аргумент принимает строковое значение и не может использоваться одновременно с аргументом `aggregate`.
nopassword boolean	Определяет имя пользователя без назначения пароля. Это позволит пользователю входить в систему без проверки пароля. Варианты: `false` `true`
privilege integer	Аргумент `privilege` задаёт уровень привилегий пользователя после входа в систему. Этот аргумент принимает целочисленные значения от 1 до 15.
role string	Настраивает роль имени пользователя в текущей конфигурации устройства. Аргумент принимает строковое значение с именем роли. Этот аргумент не проверяет, настроена ли роль на устройстве.
sshkey string	Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает допустимое значение ключа SSH.
state string	Настраивает состояние определения имени пользователя относительно рабочей конфигурации устройства. Если задано значение present, имя (имена) пользователя должны быть указаны в активной конфигурации устройства; если задано значение absent, имя (имена) пользователя не должны присутствовать в активной конфигурации устройства Варианты: `"present"` `"absent"`
update_password string	Так как пароли зашифрованы в текущей конфигурации устройства, этот аргумент указывает модулю, когда следует менять пароль. Если задано значение `always`, пароль будет обновляться на устройстве каждый раз; если задано значение `on_create`, пароль будет обновлён только при создании имени пользователя. Варианты: `"on_create"` `"always"`
configured_password string	Пароль для настройки на удалённом устройстве Arista EOS. Пароль необходимо указать в открытом виде; на устройстве он будет зашифрован.
name string	Имя пользователя для настройки на удалённом устройстве Arista EOS. Этот аргумент принимает строковое значение и не может использоваться одновременно с аргументом `aggregate`.
nopassword boolean	Определяет имя пользователя без назначения пароля. Это позволит пользователю входить в систему без проверки пароля. Варианты: `false` `true`
privilege integer	Аргумент `privilege` задаёт уровень привилегий пользователя после входа в систему. Этот аргумент принимает целочисленные значения от 1 до 15.
purge boolean	Указывает модулю считать определение ресурса исчерпывающим. Он удалит все ранее настроенные на устройстве имена пользователей, за исключением пользователя `admin`, которого нельзя удалить в соответствии с ограничениями EOS. Варианты: `false` ← (по умолчанию) `true`
role string	Настраивает роль имени пользователя в текущей конфигурации устройства. Аргумент принимает строковое значение с именем роли. Этот аргумент не проверяет, настроена ли роль на устройстве.
sshkey string	Указывает открытый ключ SSH для настройки для данного имени пользователя. Этот аргумент принимает допустимое значение ключа SSH.
state string	Настраивает состояние определения имени пользователя относительно рабочей конфигурации устройства. Если задано значение present, имя (имена) пользователя должны быть указаны в активной конфигурации устройства; если задано значение absent, имя (имена) пользователя не должны присутствовать в активной конфигурации устройства Варианты: `"present"` ← (по умолчанию) `"absent"`
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 list / элементы=string	Список команд режима конфигурации для отправки на устройство Возвращается: всегда Пример: `["name ansible secret password", "name admin secret admin"]`
session_name string	Имя сеанса конфигурации EOS, используемого для загрузки конфигурации Возвращается: если changed имеет значение True Пример: `"ansible_1479315771"`

Авторы

Peter Sprygada (@privateip)

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

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