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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.iosxr.iosxr_user.

Добавлено в cisco.iosxr 1.0.0

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

Обзор

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

Примечание

Этому модулю соответствует плагин действий.

Псевдонимы: 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 list / elements=dictionary	Набор объектов пользователей, которые нужно настроить на удаленном устройстве Cisco IOS XR. Элементы списка могут представлять собой имя пользователя или хеш с именем пользователя и свойствами. Этот аргумент несовместим с аргументом `name`.
admin boolean	Переходит в режим конфигурации администратора для внесения изменений в конфигурацию устройства. Применяется только при использовании транспорта network_cli Варианты: `false` `true`
configured_password string	Пароль, который нужно настроить на устройстве Cisco IOS XR. Пароль необходимо указывать в открытом виде. При использовании cli пароль шифруется на устройстве, а при использовании netconf — Ansible с помощью того же алгоритма хеширования MD5 и соли размером 3. Обратите внимание, что этот параметр отличается от `provider password`.
group псевдоним: role string	Настраивает группу для имени пользователя в текущей конфигурации устройства. Аргумент принимает строковое значение с именем группы. Этот аргумент не проверяет, настроена ли группа на устройстве.
groups list / elements=string	Настраивает группы для имени пользователя в текущей конфигурации устройства. Аргумент принимает список имен групп. Этот аргумент не проверяет, настроена ли группа на устройстве. Он аналогичен команде aggregate для пользователей, но позволяет настроить для пользователя (или пользователей) несколько групп.
name string / обязательный	Имя пользователя, которое нужно настроить на устройстве Cisco IOS XR. Аргумент принимает строковое значение и несовместим с аргументом `aggregate`. Обратите внимание, что этот параметр отличается от `provider username`.
public_key string	Задает содержимое файла открытого ключа для загрузки на узел IOS-XR. Это позволяет пользователям входить в систему с помощью соответствующего закрытого ключа. IOS-XR принимает только файлы, декодированные из base64, поэтому файл будет декодирован и загружен на узел. Обратите внимание: требуется файл открытого ключа OpenSSL; файлы, созданные PuTTy, не подойдут! Несовместим с public_key_contents. Если используется с несколькими пользователями в aggregate, для всех пользователей применяется один и тот же файл ключа.
public_key_contents string	Задает содержимое файла открытого ключа для загрузки на узел IOS-XR. Это позволяет пользователям входить в систему с помощью соответствующего закрытого ключа. IOS-XR принимает только файлы, декодированные из base64, поэтому файл будет декодирован и загружен на узел. Обратите внимание: требуется файл открытого ключа OpenSSL; файлы, созданные PuTTy, не подойдут! Несовместим с public_key. Если используется с несколькими пользователями в aggregate, для всех пользователей применяется один и тот же файл ключа.
state string	Настраивает состояние определения пользователя относительно рабочей конфигурации устройства. Если задано значение present, пользователь (или пользователи) должен быть настроен в активной конфигурации устройства; если задано значение absent, пользователь (или пользователи) не должен присутствовать в активной конфигурации устройства. Варианты: `"present"` `"absent"`
update_password string	Поскольку пароли в текущей конфигурации устройства зашифрованы, этот аргумент указывает модулю, когда менять пароль. Если задано значение `always`, пароль будет обновляться на устройстве всегда; если задано значение `on_create`, пароль будет обновлен только при создании пользователя. Варианты: `"on_create"` `"always"`
configured_password string	Пароль, который нужно настроить на устройстве Cisco IOS XR. Пароль необходимо указывать в открытом виде. При использовании cli пароль шифруется на устройстве, а при использовании netconf — Ansible с помощью того же алгоритма хеширования MD5 и соли размером 3. Обратите внимание, что этот параметр отличается от `provider password`.
group псевдоним: role string	Настраивает группу для имени пользователя в текущей конфигурации устройства. Аргумент принимает строковое значение с именем группы. Этот аргумент не проверяет, настроена ли группа на устройстве.
groups list / elements=string	Настраивает группы для имени пользователя в текущей конфигурации устройства. Аргумент принимает список имен групп. Этот аргумент не проверяет, настроена ли группа на устройстве. Он аналогичен команде aggregate для пользователей, но позволяет настроить для пользователя (или пользователей) несколько групп.
name string	Имя пользователя, которое нужно настроить на устройстве Cisco IOS XR. Аргумент принимает строковое значение и несовместим с аргументом `aggregate`. Обратите внимание, что этот параметр отличается от `provider username`.
public_key string	Задает содержимое файла открытого ключа для загрузки на узел IOS-XR. Это позволяет пользователям входить в систему с помощью соответствующего закрытого ключа. IOS-XR принимает только файлы, декодированные из base64, поэтому файл будет декодирован и загружен на узел. Обратите внимание: требуется файл открытого ключа OpenSSL; файлы, созданные PuTTy, не подойдут! Несовместим с public_key_contents. Если используется с несколькими пользователями в aggregate, для всех пользователей применяется один и тот же файл ключа.
public_key_contents string	Задает содержимое файла открытого ключа для загрузки на узел IOS-XR. Это позволяет пользователям входить в систему с помощью соответствующего закрытого ключа. IOS-XR принимает только файлы, декодированные из base64, поэтому файл будет декодирован и загружен на узел. Обратите внимание: требуется файл открытого ключа OpenSSL; файлы, созданные PuTTy, не подойдут! Несовместим с public_key. Если используется с несколькими пользователями в aggregate, для всех пользователей применяется один и тот же файл ключа.
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 для управления сетевыми устройствами см. в :ref:`руководстве по сетям Ansible <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 list / elements=string	Список команд режима конфигурации для отправки устройству Возвращается: всегда Пример: `["username ansible secret password group sysadmin", "username admin secret admin"]`
xml list / elements=string	XML-запрос NetConf rpc, отправленный устройству с транспортом `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

list / elements=string

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

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

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

xml

list / elements=string

XML-запрос NetConf rpc, отправленный устройству с транспортом 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/iosxr/iosxr_user_module.html