Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин входит в коллекцию junipernetworks.junos (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install junipernetworks.junos

Для использования в плейбуке укажите: junipernetworks.junos.junos_user

Новое в версии 1.0.0: of junipernetworks.junos

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

Описание

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

Примечание

У этого модуля есть соответствующий плагин действий.

Требования

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

  • ncclient (>=v0.5.2)

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
active
логический
    Варианты:
  • no
  • yes ←
Указывает, активна или деактивирована конфигурация
aggregate
список / элементы=словарь
Аргумент aggregate определяет список пользователей, которые должны быть настроены на удалённом устройстве. Список пользователей будет сравниваться с текущими пользователями, и только изменения будут добавляться или удаляться из конфигурации устройства. Этот аргумент взаимоисключающий с аргументом name.

псевдонимы: users, collection
active
логический
    Варианты:
  • no
  • yes
Указывает, активна или деактивирована конфигурация
encrypted_password
строка
Аргумент encrypted_password задаёт уже хешированный пароль для учётной записи пользователя на удалённой системе.
full_name
строка
Аргумент full_name предоставляет полное имя учётной записи пользователя, которое должно быть создано на удалённом устройстве. Этот аргумент принимает любое текстовое значение.
name
строка / обязательно
Аргумент name определяет имя пользователя, который должен быть создан в системе. Этот аргумент должен соответствовать соответствующим соглашениям об именовании пользователей для целевого устройства, работающего под управлением JUNOS. Этот аргумент взаимоисключающий с аргументом aggregate
purge
логический
    Варианты:
  • no ←
  • yes
Аргумент purge указывает модулю рассматривать определение пользователей как абсолютное. Он удалит всех ранее настроенных пользователей на устройстве, за исключением текущего набора агрегированных.
role
строка
    Варианты:
  • operator
  • read-only
  • super-user
  • unauthorized
Аргумент role определяет роль учётной записи пользователя на удалённой системе. Учётные записи пользователей могут иметь более одной роли.
sshkey
строка
Аргумент sshkey определяет открытый ключ SSH, который должен быть настроен для учётной записи пользователя на удалённой системе. Этот аргумент должен быть валидным ключом SSH.
state
строка
    Варианты:
  • present
  • absent
Аргумент state настраивает состояние определений пользователей в контексте операционной конфигурации устройства. При значении present пользователь должен быть настроен в активной конфигурации устройства, а при значении absent пользователь не должен быть в активной конфигурации устройства.
encrypted_password
строка
Аргумент encrypted_password задаёт уже хешированный пароль для учётной записи пользователя на удалённой системе.
full_name
строка
Аргумент full_name предоставляет полное имя учётной записи пользователя, которое должно быть создано на удалённом устройстве. Этот аргумент принимает любое текстовое значение.
name
строка
Аргумент name определяет имя пользователя, который должен быть создан в системе. Этот аргумент должен соответствовать соответствующим соглашениям об именовании пользователей для целевого устройства, работающего под управлением JUNOS. Этот аргумент взаимоисключающий с аргументом aggregate
provider
словарь
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli или connection: netconf
Для получения дополнительной информации см. руководство Junos OS Platform Options.
Объект словаря, содержащий данные подключения.
host
строка
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password
строка
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD
port
целое число
Указывает порт, который должен быть использован при создании подключения к удалённому устройству. Значение порта по умолчанию составляет 22 (для transport=cli) или 830 (для transport=netconf) устройства.
ssh_keyfile
путь
Указывает ключ SSH, который нужно использовать для аутентификации подключения к удалённому устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE
timeout
целое число
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
transport
строка
    Варианты:
  • cli
  • netconf ←
Настраивает транспортное подключение, которое нужно использовать при подключении к удалённому устройству.
username
строка
Указывает имя пользователя, которое нужно использовать для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME
purge
логический
    Варианты:
  • no ←
  • yes
Аргумент purge указывает модулю рассматривать определение пользователей как абсолютное. Он удалит всех ранее настроенных пользователей на устройстве, за исключением текущего набора агрегированных.
role
строка
    Варианты:
  • operator
  • read-only
  • super-user
  • unauthorized
Аргумент role определяет роль учётной записи пользователя на удалённой системе. Учётные записи пользователей могут иметь более одной роли.
sshkey
строка
Аргумент sshkey определяет открытый ключ SSH, который должен быть настроен для учётной записи пользователя на удалённой системе. Этот аргумент должен быть валидным ключом SSH.
state
строка
    Варианты:
  • present ←
  • absent
Аргумент state настраивает состояние определений пользователей в контексте операционной конфигурации устройства. При значении present пользователь должен быть настроен в активной конфигурации устройства, а при значении absent пользователь не должен быть в активной конфигурации устройства.

Примечания

Примечание

  • Для работы данного модуля требуется включенная на управляемом удалённом устройстве служба netconf.
  • Проверено на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.
  • Рекомендуемое подключение netconf. См. настройки платформы Junos OS.
  • Этот модуль также работает с local подключениями для устаревших playbooks.
  • Дополнительная информация о работе с CLI и netconf находится в руководстве по настройкам платформы Junos OS
  • Дополнительная информация о применении Ansible для управления сетевыми устройствами находится в Руководстве по Ansible для сетей
  • Для получения дополнительной информации о применении Ansible для управления устройствами Juniper см. https://www.ansible.com/ansible-juniper.

Примеры

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

- name: remove a user account
  junipernetworks.junos.junos_user:
    name: ansible
    state: absent

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

- name: set user password
  junipernetworks.junos.junos_user:
    name: ansible
    role: super-user
    encrypted_password: "{{ 'my-password' | password_hash('sha512') }}"
    state: present

- name: Create list of users
  junipernetworks.junos.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
  junipernetworks.junos.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; + }


Авторы

  • Peter Sprygada (@privateip)

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

Spec-Zone.ru

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