Spec-Zone.ru › Ansible

Модуль dellemc.enterprise_sonic.sonic_ldap — настройка глобальных параметров LDAP-сервера на SONiC.

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

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

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

Чтобы использовать её в плейбуке, укажите: dellemc.enterprise_sonic.sonic_ldap.

Добавлено в dellemc.enterprise_sonic 2.5.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль управляет конфигурацией глобальных параметров LDAP-сервера на устройствах под управлением SONiC.
  • Настройте экземпляр VRF перед настройкой VRF, который будет использоваться для подключения к LDAP-серверу.

Параметры

Параметр

Комментарии

config

list / elements=dictionary

Задает конфигурацию, связанную с LDAP-сервером.

base

string

Настраивает базовое уникальное имя (DN).

bind_timelimit

integer

Настраивает ограничение времени подключения (от 0 до 65535).

binddn

string

Настраивает уникальное имя для привязки.

bindpw

dictionary

Настраивает учетные данные для привязки.

encrypted

boolean

Указывает, является ли пароль зашифрованным текстом.

Варианты:

  • false
  • true

pwd

string / обязательный

Пароль аутентификации для привязки.

idle_timelimit

integer

Настраивает ограничение времени простоя NSS (от 0 до 65535).

Применяется только для global и nss.

map

dictionary

Настраивает карту LDAP-сервера.

Применяется только для global.

attribute

list / elements=dictionary

Настраивает карту атрибутов.

from и to необходимо задавать вместе.

from

string

Настраивает ключ карты атрибутов.

to

string

Настраивает значение карты атрибутов.

default_attribute

list / elements=dictionary

Настраивает карту атрибутов по умолчанию.

from и to необходимо задавать вместе.

from

string

Настраивает ключ карты атрибутов по умолчанию.

to

string

Настраивает значение карты атрибутов по умолчанию.

map_remote_groups_to_sonic_roles

list / elements=dictionary

Настраивает сопоставление удаленных групп с ролями SONiC.

remote_group и sonic_roles необходимо задавать вместе.

remote_group

string

Сопоставляет удаленные группы с ролями SONiC.

sonic_roles

list / elements=string

Настраивает роли SONiC.

Варианты:

  • "admin"
  • "operator"
  • "netadmin"
  • "secadmin"

objectclass

list / elements=dictionary

Настраивает карту классов объектов.

from и to необходимо задавать вместе.

from

string

Настраивает ключ карты классов объектов.

to

string

Настраивает значение карты классов объектов.

override_attribute

list / elements=dictionary

Настраивает карту переопределения атрибутов.

from и to необходимо задавать вместе.

from

string

Настраивает ключ карты переопределения атрибутов.

to

string

Настраивает значение карты переопределения атрибутов.

name

string / обязательный

Указывает тип LDAP.

Варианты:

  • "global"
  • "nss"
  • "pam"
  • "sudo"

nss_base_group

string

Настраивает базу поиска NSS для карты групп.

Применяется только для global и nss.

nss_base_netgroup

string

Настраивает базу поиска NSS для карты сетевых групп.

Применяется только для global и nss.

nss_base_passwd

string

Настраивает базу поиска NSS для карты паролей.

Применяется только для global, nss и pam.

nss_base_shadow

string

Настраивает базу поиска NSS для карты теневых паролей.

Применяется только для global и nss.

nss_base_sudoers

string

Настраивает базу поиска NSS для карты sudoers.

Применяется только для global и nss.

nss_initgroups_ignoreusers

string

Настраивает список пользователей, игнорируемых NSS при инициализации групп.

Применяется только для global и nss.

nss_skipmembers

boolean

Настраивает параметр skipmembers NSS.

Варианты:

  • false
  • true

pam_filter

string

Настраивает фильтр PAM.

Применяется только для global и pam.

pam_group_dn

string

Настраивает уникальное имя (DN) группы PAM.

Применяется только для global и pam.

pam_login_attribute

string

Настраивает атрибут входа PAM.

Применяется только для global и pam.

pam_member_attribute

string

Настраивает атрибут участника PAM.

Применяется только для global и pam.

port

integer

Настраивает порт сервера (от 1 до 65535).

retry

integer

Настраивает число повторных попыток передачи (от 0 до 10).

scope

string

Настраивает область поиска.

Применяется только для global, nss и pam.

Варианты:

  • "sub"
  • "one"
  • "base"

security_profile

string

Настраивает профиль безопасности для LDAP.

Применяется только для global.

servers

list / elements=dictionary

Настраивает имя хоста или IP-адрес LDAP-сервера.

Применяется только для global.

address

string / обязательный

Имя хоста или IP-адрес LDAP-сервера.

port

integer

Настраивает номер порта сервера (от 1 до 65535).

priority

integer

Настраивает приоритет (от 1 до 99).

retry

integer

Настраивает число повторных попыток передачи (от 0 до 10).

server_type

string

Настраивает тип сервера.

Варианты:

  • "all"
  • "nss"
  • "sudo"
  • "pam"
  • "nss_sudo"
  • "nss_pam"
  • "sudo_pam"

ssl

string

Настраивает параметры TLS.

Варианты:

  • "on"
  • "off"
  • "start_tls"

source_interface

string

Настраивает исходный интерфейс, используемый в качестве исходного IP-адреса для пакетов LDAP.

Применяется только для global.

Полное имя интерфейса уровня 3, например Eth1/1.

ssl

string

Настраивает параметры TLS.

Варианты:

  • "on"
  • "off"
  • "start_tls"

sudoers_base

string

Настраивает базовое уникальное имя sudo для запросов.

Применяется только для global и sudo.

sudoers_search_filter

string

Настраивает фильтр поиска sudo для запросов.

Применяется только для global и sudo.

timelimit

integer

Настраивает ограничение времени поиска (от 1 до 65535).

version

integer

Настраивает версию LDAP: 2 или 3.

Варианты:

  • 2
  • 3

vrf

string

Настраивает VRF для подключения к LDAP-серверу.

Применяется только для global.

state

string

Задает операцию, выполняемую над настроенным на устройстве LDAP-сервером.

При значении merged входная конфигурация объединяется с существующей конфигурацией LDAP-сервера на устройстве.

При значении deleted существующая конфигурация LDAP-сервера удаляется с устройства.

При значении overridden вся существующая конфигурация LDAP-сервера удаляется и устанавливается указанная входная конфигурация.

При значении replaced существующая конфигурация LDAP-сервера на устройстве заменяется конфигурацией из плейбука для каждой группы LDAP-серверов, настроенной в плейбуке.

Варианты:

  • "merged" ← (по умолчанию)
  • "deleted"
  • "replaced"
  • "overridden"

Примечания

Примечание

  • Поддерживается check_mode.

Примеры

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vrf Vrf_1
# !
# ip vrf Vrf_1
# sonic# show running-configuration | grep ldap
# ldap-server port 389
# ldap-server version 2
# ldap-server nss-base-passwd password
# ldap-server nss-initgroups-ignoreusers username1
# ldap-server nss scope sub
# ldap-server nss timelimit 15
# ldap-server nss idle-timelimit 25
# ldap-server nss nss-base-group group1
# ldap-server nss nss-base-sudoers sudo1
# ldap-server pam base admin
# ldap-server pam binddn CN=example.com
# ldap-server pam pam-login-attribute loginattrstring
# ldap-server sudo retry 10
# ldap-server sudo ssl start_tls
# ldap-server sudo bind-timelimit 15
# ldap-server vrf Vrf_1
# ldap-server host 10.10.10.1 port 1550 priority 5
# ldap-server host 20.20.20.10 retry 1
# ldap-server host example.com priority 10 ssl off
# ldap-server map default-attribute-value attr1 to attr2
# ldap-server map default-attribute-value attr3 to attr4
# ldap-server map objectclass attr1 to attr3
# sonic#

- name: Delete the LDAP server configurations
  sonic_ldap:
    config:
      - name: "global"
        servers:
          - address: "example.com"
        vrf: "Vrf_1"
      - name: "nss"
        idle_timelimit: 25
        scope: "sub"
      - name: "sudo"
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration | grep ldap
# ldap-server port 389
# ldap-server version 2
# ldap-server nss-base-passwd password
# ldap-server nss-initgroups-ignoreusers username1
# ldap-server nss timelimit 15
# ldap-server nss nss-base-group group1
# ldap-server nss nss-base-sudoers sudo1
# ldap-server pam base admin
# ldap-server pam binddn CN=example.com
# ldap-server pam pam-login-attribute loginattrstring
# ldap-server host 10.10.10.1 port 1550 priority 5
# ldap-server host 20.20.20.10 retry 1
# ldap-server map default-attribute-value attr1 to attr2
# ldap-server map default-attribute-value attr3 to attr4
# ldap-server map objectclass attr1 to attr3
# sonic#


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vrf Vrf_1
# !
# ip vrf Vrf_1
# !
# sonic# show running-configuration | grep ldap
# sonic#

- name: Add the LDAP server configurations
  sonic_ldap:
    config:
      - name: "global"
        servers:
          - address: "example.com"
            priority: 10
            ssl: "on"
          - address: "10.10.10.1"
            priority: 5
            port: 1550
        port: 389
        version: 2
        nss_base_passwd: password
      - name: "pam"
        base: "admin"
        binddn: "CN=example.com"
        pam_login_attribute: "loginattrstring"
      - name: "sudo"
        bind_timelimit: 20
        retry: 10
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration | grep ldap
# ldap-server port 389
# ldap-server version 2
# ldap-server nss-base-passwd password
# ldap-server pam base admin
# ldap-server pam binddn CN=example.com
# ldap-server pam pam-login-attribute loginattrstring
# ldap-server sudo retry 10
# ldap-server sudo bind-timelimit 20
# ldap-server host 10.10.10.1 port 1550 priority 5
# ldap-server host example.com priority 10 ssl on
# sonic#


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vrf Vrf_1
# !
# ip vrf Vrf_1
# !
# sonic# show running-configuration | grep ldap
# ldap-server port 389
# ldap-server version 2
# ldap-server nss-base-passwd password
# ldap-server pam base admin
# ldap-server pam binddn CN=example.com
# ldap-server pam pam-login-attribute loginattrstring
# ldap-server sudo retry 10
# ldap-server sudo bind-timelimit 20
# ldap-server host 10.10.10.1 port 1550 priority 5
# ldap-server host example.com priority 10 ssl on
# sonic#

- name: Add the LDAP server configurations
  sonic_ldap:
    config:
      - name: "global"
        servers:
          - address: "example.com"
            ssl: "off"
          - address: "20.20.20.10"
            retry: 1
        nss_base_passwd: password
        pam_login_attribute: "globallogin"
        nss_initgroups_ignoreusers: "username1"
        vrf: "Vrf_1"
        map:
          default_attribute:
            - from: "attr1"
              to: "attr2"
            - from: "attr3"
              to: "attr4"
          objectclass:
            - from: "attr1"
              to: "attr3"
          map_remote_groups_to_sonic_roles:
            - remote_group: "group1"
              sonic_roles:
                - admin
                - operator
      - name: "nss"
        nss_base_netgroup: "group1"
        idle_timelimit: 25
        timelimit: 15
        scope: "sub"
        nss_base_sudoers: "sudo1"
      - name: "sudo"
        bind_timelimit: 15
        ssl: "start_tls"
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration | grep ldap
# ldap-server port 389
# ldap-server version 2
# ldap-server nss-base-passwd password
# ldap-server pam-login-attribute globallogin
# ldap-server nss-initgroups-ignoreusers username1
# ldap-server nss scope sub
# ldap-server nss timelimit 15
# ldap-server nss idle-timelimit 25
# ldap-server nss nss-base-group group1
# ldap-server nss nss-base-sudoers sudo1
# ldap-server pam base admin
# ldap-server pam binddn CN=example.com
# ldap-server pam pam-login-attribute loginattrstring
# ldap-server sudo retry 10
# ldap-server sudo ssl start_tls
# ldap-server sudo bind-timelimit 15
# ldap-server vrf Vrf_1
# ldap-server host 10.10.10.1 port 1550 priority 5
# ldap-server host 20.20.20.10 retry 1
# ldap-server host example.com priority 10 ssl off
# ldap-server map default-attribute-value attr1 to attr2
# ldap-server map default-attribute-value attr3 to attr4
# ldap-server map objectclass attr1 to attr3
# ldap-server map remote-groups-override-to-sonic-roles group1 to admin,operator
# sonic#


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vrf Vrf_1
# !
# ip vrf Vrf_1
# sonic# show running-configuration | grep ldap
# ldap-server port 389
# ldap-server version 2
# ldap-server nss-base-passwd password
# ldap-server nss-initgroups-ignoreusers username1
# ldap-server nss idle-timelimit 25
# ldap-server nss nss-base-group group1
# ldap-server nss nss-base-sudoers sudo1
# ldap-server pam base admin
# ldap-server pam binddn CN=example.com
# ldap-server pam pam-login-attribute loginattrstring
# ldap-server host 10.10.10.1 port 1550 priority 5
# ldap-server host 20.20.20.10 retry 1
# ldap-server map default-attribute-value attr1 to attr2
# ldap-server map default-attribute-value attr3 to attr4
# ldap-server map objectclass attr1 to attr3
# sonic#

- name: Replace the LDAP server configurations
  sonic_ldap:
    config:
      - name: "nss"
        scope: "one"
        bindpw:
          pwd: "password"
      - name: "pam"
        version: 3
        port: 2000
        timelimit: 20
        pam_group_dn: "DNAME"
      - name: "sudo"
        sudoers_search_filter: "filter1"
        base: "base_name"
        version: 3
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration | grep ldap
# ldap-server port 389
# ldap-server version 2
# ldap-server nss scope one
# ldap-server nss bindpw U2FsdGVkX1+t8PR9IIi+qjZpYoNwjmd78D1WDBdkLxs= encrypted
# ldap-server pam version 3
# ldap-server pam port 2000
# ldap-server pam timelimit 20
# ldap-server pam pam-group-dn DNAME
# ldap-server sudo version 3
# ldap-server sudo base base_name
# ldap-server sudo sudoers-search-filter filter1
# ldap-server host 10.10.10.1 port 1550 priority 5
# ldap-server host 20.20.20.10 retry 1
# ldap-server map default-attribute-value attr1 to attr2
# ldap-server map default-attribute-value attr3 to attr4
# ldap-server map objectclass attr1 to attr3
# sonic#


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vrf Vrf_1
# !
# ip vrf Vrf_1
# sonic# show running-configuration | grep ldap
# ldap-server port 389
# ldap-server version 2
# ldap-server nss scope one
# ldap-server nss bindpw U2FsdGVkX1+t8PR9IIi+qjZpYoNwjmd78D1WDBdkLxs= encrypted
# ldap-server pam version 3
# ldap-server pam port 2000
# ldap-server pam timelimit 20
# ldap-server pam pam-group-dn DNAME
# ldap-server sudo version 3
# ldap-server sudo base base_name
# ldap-server sudo sudoers-search-filter filter1
# ldap-server host 10.10.10.1 port 1550 priority 5
# ldap-server host 20.20.20.10 retry 1
# ldap-server map default-attribute-value attr1 to attr2
# ldap-server map default-attribute-value attr3 to attr4
# ldap-server map objectclass attr1 to attr3
# sonic#

- name: Override the LDAP server configurations
  sonic_ldap:
    config:
      - name: "global"
        source_interface: "Eth1/1"
        security_profile: "default"
        vrf: "Vrf_1"
        servers:
          - address: "client.com"
          - address: "host.com"
            server_type: "sudo_pam"
        map:
          override_attribute:
            - from: "attr1"
              to: "attr2"
          map_remote_groups_to_sonic_roles:
            - remote_group: "group1"
              sonic_roles:
                - admin
                - operator
        idle_timelimit: 20
      - name: "pam"
        ssl: "off"
        scope: "base"
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration | grep ldap
# ldap-server idle-timelimit 20
# ldap-server pam ssl off
# ldap-server pam scope base
# ldap-server source-interface Eth1/1
# ldap-server security-profile default
# ldap-server vrf Vrf_1
# ldap-server host client.com
# ldap-server host host.com use-type sudo_pam
# ldap-server map override-attribute-value attr1 to attr2
# ldap-server map remote-groups-override-to-sonic-roles group1 to admin,operator
# sonic#

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

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

Ключ

Описание

after

list / elements=string

Конфигурация, полученная в результате вызова модуля.

Возвращается: при изменении

Пример: ["The configuration returned will always be in the same format\n as the parameters above.\n"]

after(generated)

list / elements=string

Сгенерированная конфигурация.

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

Пример: ["The configuration returned will always be in the same format\n as the parameters above.\n"]

before

list / elements=string

Конфигурация до вызова модуля.

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

Пример: ["The configuration returned will always be in the same format\n as the parameters above.\n"]

commands

list / elements=string

Набор команд, отправленных на удалённое устройство.

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

Пример: ["command 1", "command 2", "command 3"]

Авторы

  • Santhosh Kumar T(@santhosh-kt)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/dellemc/enterprise_sonic/sonic_ldap_module.html

Spec-Zone.ru

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