ios_user - Управление агрегатом локальных пользователей на устройстве Cisco IOS

Новая версия 2.4.

Описание
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус
- Информация о техническом обслуживании

Описание

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

Параметры

параметр	обязательно	по умолчанию	возможные значения	комментарии
aggregate	нет			Набор объектов имени пользователя, которые должны быть настроены на удалённом устройстве Cisco IOS. Элементы списка могут быть либо именем пользователя, либо хешем имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом `name`. псевдоним `users`.
configured_password	нет			Пароль, который должен быть настроен на устройстве Cisco IOS. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр не совпадает с `provider password`.
name	нет			Имя пользователя, которое должно быть настроено на устройстве Cisco IOS. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом `aggregate`. Обратите внимание, что этот параметр не совпадает с `provider username`.
nopassword	нет		да нет	Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без аутентификации паролем.
privilege	нет			Аргумент `privilege` настраивает уровень привилегий пользователя при входе в систему. Этот аргумент принимает целочисленные значения в диапазоне от 1 до 15.
purge	нет		да нет	Инструктирует модуль рассматривать определение ресурса как абсолютное. Он удалит любые ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin` (текущий определённый набор пользователей).
state	нет	present	present absent	Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При установке в значение present имена пользователя(ей) должны быть настроены в активной конфигурации устройства, а при установке в значение absent имена пользователя(ей) не должны быть в активной конфигурации устройства.
update_password	нет	всегда	при создании всегда	Поскольку пароли зашифрованы в рабочей конфигурации устройства, этот аргумент будет указывать, когда следует изменить пароль. При установке в значение `always`, пароль всегда будет обновлён на устройстве, а при установке в значение `on_create`, пароль будет обновлён только в случае создания имени пользователя.
view	нет			Настраивает представление для имени пользователя в рабочей конфигурации устройства. Аргумент принимает строковое значение, определяющее имя представления. Этот аргумент не проверяет, настроено ли представление на устройстве.

Примеры

- name: create a new user
  ios_user:
    name: ansible
    nopassword: True
    state: present

- name: remove all users except admin
  ios_user:
    purge: yes

- name: set multiple users to privilege level 15
  ios_user:
    aggregate:
      - name: netop
      - name: netend
    privilege: 15
    state: present

- name: set user view/role
  ios_user:
    name: netop
    view: network-operator
    state: present

- name: Change Password for User netop
  ios_user:
    name: netop
    configured_password: "{{ new_password }}"
    update_password: always
    state: present

- name: Aggregate of users
  ios_user:
    aggregate:
      - name: ansibletest2
      - name: ansibletest3
    view: network-admin

- name: Delete users with aggregate
  ios_user:
    aggregate:
      - name: ansibletest1
      - name: ansibletest2
      - name: ansibletest3
    state: absent

Возвращаемые значения

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

имя	описание	возвращается	тип	пример
команды	Список команд конфигурации режима для отправки на устройство	всегда	список	['username ansible secret password', 'username admin secret admin']

Примечания

Примечание

Проверено на IOS 15.6

Статус

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

Информация о техническом обслуживании

Для получения дополнительной информации о поддержке данного модуля компанией Red Hat, пожалуйста, обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей, если вы так решите, пожалуйста, прочтите Информация о сообществе и сотрудничестве, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ios_user_module.html