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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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	Настроить базовое выделенное имя.
bind_timelimit integer	Настроить ограничение времени подключения (от 0 до 65535).
binddn string	Настроить выделенное имя для привязки.
bindpw dictionary	Настроить учетные данные для привязки
encrypted boolean	Указывает, является ли пароль зашифрованным текстом. Варианты: `false` `true`
pwd string / required	Пароль аутентификации для привязки.
idle_timelimit integer	Настроить ограничение времени простоя NSS (от 0 до 65535). Применимо только для глобальных и nss.
map dictionary	Настроить LDAP-сервер для map. Применимо только для глобальных.
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	Настроить отображение Objectclass. from и to требуются вместе.
from string	Настроить ключ отображения Objectclass.
to string	Настроить значение отображения Objectclass.
override_attribute list / elements=dictionary	Настроить отображение переопределяемых атрибутов. from и to требуются вместе.
from string	Настроить ключ отображения переопределяемых атрибутов.
to string	Настроить значение отображения переопределяемых атрибутов.

name string / required	Задает тип LDAP. Choices: `"global"` `"nss"` `"pam"` `"sudo"`
nss_base_group string	Настроить базовую область поиска NSS для сопоставления групп. Применимо только для глобального и nss.
nss_base_netgroup string	Настроить базовую область поиска NSS для сопоставления netgroup. Применимо только для глобального и nss.
nss_base_passwd string	Настроить базовую область поиска NSS для сопоставления passwd. Применимо только для глобального, nss и pam.
nss_base_shadow string	Настроить базовую область поиска NSS для сопоставления shadow. Применимо только для глобального и nss.
nss_base_sudoers string	Настроить базовую область поиска NSS для сопоставления sudoers. Применимо только для глобального и nss.
nss_initgroups_ignoreusers string	Настроить игнорирование пользователей NSS init groups. Применимо только для глобального и nss.
nss_skipmembers boolean	Настроить NSS skipmembers Choices: `false` `true`
pam_filter string	Настроить фильтр PAM. Применимо только для глобального и pam.
pam_group_dn string	Настроить отличительное имя группы PAM. Применимо только для глобального и pam.
pam_login_attribute string	Настроить атрибут входа PAM. Применимо только для глобального и pam.
pam_member_attribute string	Настроить атрибут участника PAM. Применимо только для глобального и pam.
port integer	Настроить порт сервера (от 1 до 65535).
retry integer	Настроить попытки повторной передачи (от 0 до 10).
scope string	Настроить область поиска. Применимо только для глобального, nss и pam. Choices: `"sub"` `"one"` `"base"`
servers list / elements=dictionary	Настроить имя хоста или IP-адрес для LDAP-сервера. Применимо только для глобального.
address string / required	Имя хоста или IP-адрес LDAP-сервера.
port integer	Настроить номер порта сервера (от 1 до 65535).
priority integer	Настроить приоритет (от 1 до 99).
retry integer	Настроить попытки повторной передачи (от 0 до 10).
server_type string	Настроить тип сервера. Choices: `"all"` `"nss"` `"sudo"` `"pam"` `"nss_sudo"` `"nss_pam"` `"sudo_pam"`
ssl string	Настроить конфигурацию TLS. Choices: `"on"` `"off"` `"start_tls"`
source_interface string	Настроить исходный интерфейс, который будет использоваться в качестве исходного IP для пакетов LDAP. Применимо только для глобального. Полное имя интерфейса 3-го уровня, например, Eth1/1.

ssl string	Настроить TLS-конфигурацию. Выбор: `"on"` `"off"` `"start_tls"`
sudoers_base string	Настройка базового имени различения sudoers для запросов. Применимо только для глобального и sudo.
sudoers_search_filter string	Настройка фильтра поиска sudoers для запросов. Применимо только для глобального и sudo.
timelimit integer	Настройка лимита времени поиска (от 1 до 65535).
version integer	Настройка версии LDAP 2 или 3. Выбор: `2` `3`
vrf string	Настройка VRF для подключения к LDAP-серверу. Применимо только для глобального.
state string	Указывает операцию, которую необходимо выполнить с LDAP-сервером, настроенным на устройстве. В случае merged, входная конфигурация будет объединена с существующей конфигурацией LDAP-сервера на устройстве. В случае deleted, существующая конфигурация LDAP-сервера будет удалена с устройства. В случае overridden, вся существующая конфигурация LDAP-сервера будет удалена, и указанная входная конфигурация будет установлена. В случае replaced, существующая конфигурация LDAP-сервера на устройстве будет заменена конфигурацией в playbook для каждой группы LDAP-серверов, настроенной playbook. Выбор: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

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

Примеры

# Using deleted
#
# 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
#
# 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
#
# 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
#
# 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
#
# 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"
          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 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 список / элементы=строка	Вызов модуля конфигурации в результате. Возвращается: при изменении Пример: `["The configuration returned will always be in the same format\n as the parameters above.\n"]`
after(generated) список / элементы=строка	Вызов модуля сгенерированной конфигурации. Возвращается: когда `check_mode` Пример: `["The configuration returned will always be in the same format\n as the parameters above.\n"]`
before список / элементы=строка	Конфигурация до вызова модуля. Возвращается: всегда Пример: `["The configuration returned will always be in the same format\n as the parameters above.\n"]`
commands список / элементы=строка	Набор команд, отправленных на удалённое устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

Santhosh Kumar T(@santhosh-kt)

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

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