cisco.iosxr.iosxr_user модуль — Модуль для управления группами локальных пользователей.

Примечание

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

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

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

Для использования в книге задач укажите: cisco.iosxr.iosxr_user.

Новый в cisco.iosxr 1.0.0

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

Обзор

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

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

Требования

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

ncclient >= 0.5.3 при использовании netconf
lxml >= 4.1.1 при использовании netconf
base64 при использовании public_key_contents или public_key

Параметры

Параметр	Комментарии
admin boolean	Переходит в режим конфигурации администрирования для внесения изменений в конфигурацию устройства. Применимо только при использовании транспорта network_cli. Варианты: `false` ← (по умолчанию) `true`
aggregate алиасы: users, collection список / элементы=словарь	Набор объектов имен пользователей, которые должны быть настроены на удаленном устройстве Cisco IOS XR. Элементы списка могут быть либо именем пользователя, либо хэшем из имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом `name`.
admin boolean	Переходит в режим конфигурации администрирования для внесения изменений в конфигурацию устройства. Применимо только при использовании транспорта network_cli Варианты: `false` `true`
configured_password строка	Пароль, который должен быть настроен на устройстве Cisco IOS XR. Пароль должен быть предоставлен в открытом виде. Пароль шифруется на устройстве при использовании cli и Ansible при использовании netconf, используя ту же технику хеширования MD5 с размером соли 3. Обратите внимание, что этот параметр не эквивалентен `provider password`.
group алиасы: роль строка	Настраивает группу для имени пользователя в рабочей конфигурации устройства. Аргумент принимает строковое значение, определяющее имя группы. Этот аргумент не проверяет, настроена ли группа на устройстве.
groups список / элементы=строка	Настраивает группы для имени пользователя в рабочей конфигурации устройства. Аргумент принимает список имен групп. Этот аргумент не проверяет, настроена ли группа на устройстве. Он похож на команду aggregate для имен пользователей, но позволяет настраивать несколько групп для пользователя(ей).
name строка / обязательно	Имя пользователя, которое должно быть настроено на устройстве Cisco IOS XR. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом `aggregate` . Обратите внимание, что этот параметр не эквивалентен `provider username`.
public_key строка	Настраивает содержимое файла открытого ключа для загрузки на узел IOS-XR. Это позволяет пользователям входить в систему с помощью соответствующего закрытого ключа. IOS-XR принимает только файлы, декодированные в формате base64, поэтому они будут декодированы и загружены на узел. Обратите внимание, что для этого требуется файл открытого ключа OpenSSL, файлы, сгенерированные PuTTy, не будут работать! Взаимоисключающий с public_key_contents. Если используется с несколькими пользователями в агрегатах, то для всех пользователей используется один и тот же файл ключа.
public_key_contents строка	Настраивает содержимое файла открытого ключа для загрузки на узел IOS-XR. Это позволяет пользователям входить в систему с помощью соответствующего закрытого ключа. IOS-XR принимает только файлы, декодированные в формате base64, поэтому они будут декодированы и загружены на узел. Обратите внимание, что для этого требуется файл открытого ключа OpenSSL, файлы, сгенерированные PuTTy, не будут работать! Взаимоисключающий с public_key. Если используется с несколькими пользователями в агрегатах, то для всех пользователей используется один и тот же файл ключа.
state строка	Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При установке в present имя пользователя(ей) должно быть настроено в активной конфигурации устройства, а при установке в absent имя пользователя(ей) не должно быть в активной конфигурации устройства Варианты: `"present"` `"absent"`
update_password строка	Поскольку пароли зашифрованы в рабочей конфигурации устройства, этот аргумент укажет модулю, когда необходимо изменить пароль. При установке в `always`, пароль всегда будет обновляться на устройстве, а при установке в `on_create`, пароль будет обновляться только в случае создания имени пользователя. Варианты: `"on_create"` `"always"`
configured_password строка	Пароль, который должен быть настроен на устройстве Cisco IOS XR. Пароль должен быть предоставлен в открытом виде. Пароль шифруется на устройстве при использовании cli и Ansible при использовании netconf, используя ту же технику хеширования MD5 с размером соли 3. Обратите внимание, что этот параметр не эквивалентен `provider password`.
group алиасы: роль строка	Настраивает группу для имени пользователя в рабочей конфигурации устройства. Аргумент принимает строковое значение, определяющее имя группы. Этот аргумент не проверяет, настроена ли группа на устройстве.
groups список / элементы=строка	Настраивает группы для имени пользователя в рабочей конфигурации устройства. Аргумент принимает список имен групп. Этот аргумент не проверяет, настроена ли группа на устройстве. Он похож на команду aggregate для имен пользователей, но позволяет настраивать несколько групп для пользователя(ей).

END_OF_DOCUMENT_MARKER

name string	Имя пользователя, которое необходимо настроить на устройстве Cisco IOS XR. Этот аргумент принимает строковое значение и взаимоисключающее с аргументом `aggregate`. Обратите внимание, что этот параметр не такой же, как `provider username`.
public_key string	Настраивает содержимое файла с открытым ключом для загрузки на узел IOS-XR. Это позволяет пользователям входить в систему с помощью соответствующего закрытого ключа. IOS-XR принимает только файлы, декодированные в base64, поэтому они будут декодированы и загружены на узел. Обратите внимание, что это требует файла открытого ключа OpenSSL, сгенерированные файлы PuTTy не подойдут! Взаимоисключающее с public_key_contents. Если используется с несколькими пользователями в агрегатах, то один и тот же файл ключа используется для всех пользователей.
public_key_contents string	Настраивает содержимое файла с открытым ключом для загрузки на узел IOS-XR. Это позволяет пользователям входить в систему с помощью соответствующего закрытого ключа. IOS-XR принимает только файлы, декодированные в base64, поэтому они будут декодированы и загружены на узел. Обратите внимание, что это требует файла открытого ключа OpenSSL, сгенерированные файлы PuTTy не подойдут! Взаимоисключающее с public_key. Если используется с несколькими пользователями в агрегатах, то один и тот же файл ключа используется для всех пользователей.
purge boolean	Указывает модулю рассматривать определение ресурса как абсолютное. Он удалит всех ранее настроенных имен пользователей на устройстве, за исключением пользователя `admin` и текущего набора определённых пользователей. Выборы: `false` ← (по умолчанию) `true`
state string	Настраивает состояние определения имени пользователя по отношению к операционной конфигурации устройства. При установке в present имя(на) пользователя должны быть настроены в активной конфигурации устройства, а при установке в absent имена пользователя(ей) не должны быть в активной конфигурации устройства. Выборы: `"present"` ← (по умолчанию) `"absent"`
update_password string	Так как пароли шифруются в конфигурации устройства, этот аргумент укажет модулю, когда необходимо изменить пароль. При установке в `always`, пароль всегда будет обновлён в устройстве, а при установке в `on_create`, пароль будет обновлён только в том случае, если пользователь создан. Выборы: `"on_create"` `"always"` ← (по умолчанию)

Примечания

Примечание

Этот модуль работает с подключением network_cli и netconf. См. параметры платформы IOS-XR.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible по сетям: :ref:`Ansible Network Guide <network_guide>`
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco `<https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

- name: create a new user
  cisco.iosxr.iosxr_user:
    name: ansible
    configured_password: mypassword
    state: present
- name: create a new user in admin configuration mode
  cisco.iosxr.iosxr_user:
    name: ansible
    configured_password: mypassword
    admin: true
    state: present
- name: remove all users except admin
  cisco.iosxr.iosxr_user:
    purge: true
- name: set multiple users to group sys-admin
  cisco.iosxr.iosxr_user:
    aggregate:
      - name: netop
      - name: netend
    group: sysadmin
    state: present
- name: set multiple users to multiple groups
  cisco.iosxr.iosxr_user:
    aggregate:
      - name: netop
      - name: netend
    groups:
      - sysadmin
      - root-system
    state: present
- name: Change Password for User netop
  cisco.iosxr.iosxr_user:
    name: netop
    configured_password: '{{ new_password }}'
    update_password: always
    state: present
- name: Add private key authentication for user netop
  cisco.iosxr.iosxr_user:
    name: netop
    state: present
    public_key_contents: "{{ lookup('file', '/home/netop/.ssh/id_rsa.pub' }}"

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

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

Ключ	Описание
commands список / элементы=строка	Список команд режима конфигурации для отправки на устройство Возвращается: всегда Пример: `["username ansible secret password group sysadmin", "username admin secret admin"]`
xml список / элементы=строка	NetConf rpc xml отправлен на устройство с транспортом `netconf` Возвращается: всегда (пустой список, когда нет xml rpc для отправки) Пример: `["<config xmlns:xc=\"urn:ietf:params:xml:ns:netconf:base:1.0\"> <aaa xmlns=\"http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-lib-cfg\"> <usernames xmlns=\"http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-locald-cfg\"> <username xc:operation=\"merge\"> <name>test7</name> <usergroup-under-usernames> <usergroup-under-username> <name>sysadmin</name> </usergroup-under-username> </usergroup-under-usernames> <secret>$1$ZsXC$zZ50wqhDC543ZWQkkAHLW0</secret> </username> </usernames> </aaa> </config>"]`

Ключ

Описание

commands

список / элементы=строка

Список команд режима конфигурации для отправки на устройство

Возвращается: всегда

Пример: ["username ansible secret password group sysadmin", "username admin secret admin"]

xml

список / элементы=строка

NetConf rpc xml отправлен на устройство с транспортом netconf

Возвращается: всегда (пустой список, когда нет xml rpc для отправки)

Пример: ["<config xmlns:xc=\"urn:ietf:params:xml:ns:netconf:base:1.0\"> <aaa xmlns=\"http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-lib-cfg\"> <usernames xmlns=\"http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-locald-cfg\"> <username xc:operation=\"merge\"> <name>test7</name> <usergroup-under-usernames> <usergroup-under-username> <name>sysadmin</name> </usergroup-under-username> </usergroup-under-usernames> <secret>$1$ZsXC$zZ50wqhDC543ZWQkkAHLW0</secret> </username> </usernames> </aaa> </config>"]

Авторы

Trishna Guha (@trishnaguha)
Sebastiaan van Doesselaar (@sebasdoes)
Kedar Kekan (@kedarX)

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

© 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/iosxr/iosxr_user_module.html