Spec-Zone.ru › Ansible 2.4

junos_user — Управление локальными учётными записями пользователей на устройствах Juniper JUNOS

Новое в версии 2.3.

  • Описание
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус
    • Информация о техническом обслуживании

Описание

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

Требования (к хосту, на котором выполняется модуль)

  • ncclient (>=v0.5.2)

Параметры

параметр обязательный значение по умолчанию допустимые значения комментарии
active
(добавлено в 2.4)
нет True
  • True
  • False
Указывает, активна или деактивирована конфигурация.
aggregate
(добавлено в 2.4)
нет
Аргумент aggregate определяет список пользователей, которые должны быть настроены на удалённом устройстве. Список пользователей будет сравниваться с текущими пользователями, и только изменения будут добавлены или удалены из конфигурации устройства. Этот параметр взаимоисключает параметр name. псевдоним users.
full_name
нет
Аргумент full_name предоставляет полное имя учётной записи пользователя, которая должна быть создана на удалённом устройстве. Этот параметр принимает любое текстовое значение.
name
нет
Аргумент name определяет имя пользователя, который должен быть создан в системе. Этот параметр должен соответствовать правилам именования пользователей для целевого устройства, работающего под управлением JUNOS. Этот параметр взаимоисключает параметр aggregate.
provider
нет
Объект словаря, содержащий данные подключения.
Объект словаря provider
параметр обязательный значение по умолчанию допустимые значения комментарии
username
нет
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_USERNAME.
host
да
Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение хоста используется в качестве целевого адреса для протокола.
ssh_keyfile
нет
Указывает ключ SSH для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
нет 10
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
password
нет
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт для подключения к удалённому устройству. Значение порта по умолчанию — 22 (стандартный SSH порт) (для transport=cli) или порт 830 (для transport=netconf) устройства.
purge
нет
Аргумент purge указывает модулю считать определение пользователей абсолютным. Он удалит любые ранее настроенные пользователи на устройстве, за исключением текущего набора агрегированных.
role
нет
  • operator
  • read-only
  • super-user
  • unauthorized
Аргумент role определяет роль учётной записи пользователя в удалённой системе. Учётные записи пользователей могут иметь несколько ролей.
sshkey
нет
Аргумент sshkey определяет открытый ключ SSH, который должен быть настроен для учётной записи пользователя в удалённой системе. Этот параметр должен быть корректным ключом SSH.
state
нет present
  • present
  • absent
Аргумент state настраивает состояние определения пользователя в отношении рабочей конфигурации устройства. При значении present пользователь должен быть настроен в активной конфигурации устройства, а при значении absent — нет.

Примеры

- name: create new user account
  junos_user:
    name: ansible
    role: super-user
    sshkey: "{{ lookup('file', '~/.ssh/ansible.pub') }}"
    state: present

- name: remove a user account
  junos_user:
    name: ansible
    state: absent

- name: remove all user accounts except ansible
  junos_user:
    aggregate:
    - name: ansible
    purge: yes

- name: Create list of users
  junos_user:
    aggregate:
      - {name: test_user1, full_name: test_user2, role: operator, state: present}
      - {name: test_user2, full_name: test_user2, role: read-only, state: present}

- name: Delete list of users
  junos_user:
    aggregate:
      - {name: test_user1, full_name: test_user2, role: operator, state: absent}
      - {name: test_user2, full_name: test_user2, role: read-only, state: absent}

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

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

название описание возвращается тип пример
diff.prepared
Разница в конфигурации до и после применения изменений.
при изменении конфигурации и включенном параметре diff. строка [edit system login] + user test-user { + uid 2005; + class read-only; + }

Примечания

Примечание

  • Для работы этого модуля на удалённом управляемом устройстве должна быть включена служба netconf.
  • Проверено на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.

Статус

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

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

Дополнительную информацию о поддержке этого модуля компанией 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/junos_user_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API