Spec-Zone.ru › Ansible

Модуль cisco.intersight.intersight_ldap_policy – управление политиками LDAP для Cisco Intersight

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: cisco.intersight.intersight_ldap_policy.

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

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

  • Создание, обновление и удаление политик LDAP в Cisco Intersight.
  • Управление группами и поставщиками LDAP, связанными с политиками LDAP.
  • Политики LDAP обеспечивают аутентификацию пользователей Cisco IMC с помощью LDAP-сервера.
  • Дополнительную информацию см. в разделе Cisco Intersight.

Параметры

Параметр

Комментарии

api_key_id

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

Идентификатор открытого API-ключа, связанного с закрытым ключом.

Если параметр не задан, используется значение переменной среды INTERSIGHT_API_KEY_ID.

api_private_key

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

Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM, используемого для аутентификации в API Intersight.

Если используется строка, для шифрования строковых данных следует использовать Ansible Vault.

Например: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY-----

<your private key data>

-----END EC PRIVATE KEY-----’

Если параметр не задан, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY.

api_uri

string

URI для доступа к API Intersight.

Если параметр не задан, используется значение переменной среды INTERSIGHT_API_URI.

По умолчанию: "https://intersight.com/api/v1"

attribute

string

Сведения о роли и локали пользователя.

Обязателен, если state имеет значение present.

base_dn

string

Базовое различающееся имя (DN).

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

Обязателен, если state имеет значение present.

bind_dn

string

Различающееся имя (DN) пользователя, используемое для аутентификации на LDAP-серверах.

Обязателен, если для bind_method задано значение configuredcredentials.

bind_method

string

Метод аутентификации для доступа к LDAP-серверам.

logincredentials использует учетные данные пользователя, введенные при входе в систему.

anonymous не использует учетные данные для доступа к LDAP-серверу.

configuredcredentials использует набор учетных данных, настроенный для LDAP-сервера.

Варианты:

  • "logincredentials" ← (по умолчанию)
  • "anonymous"
  • "configuredcredentials"

description

псевдонимы: descr

string

Описание политики LDAP, заданное пользователем.

Описание может содержать буквы (a-z, A-Z), цифры (0-9), дефис (-), точку (.), двоеточие (:) или символ подчеркивания (_).

dns_source

string

Источник доменного имени, используемого для запроса DNS SRV.

extracted извлекает доменное имя из идентификатора входа, введенного пользователем.

configured использует настроенный домен поиска.

configuredextracted сначала использует настроенный домен поиска, а затем извлеченное значение.

Применяется только при значении true для enable_dns.

Варианты:

  • "extracted" ← (по умолчанию)
  • "configured"
  • "configuredextracted"

domain

string

Домен IPv4, к которому должны относиться все пользователи.

Обязателен, если state имеет значение present.

enable_dns

boolean

Включает использование DNS для доступа к LDAP-серверам.

Если параметр включен, поставщиков LDAP указывать нельзя (вместо этого используется обнаружение DNS).

Если параметр отключен, необходимо настроить как минимум одного поставщика LDAP.

Варианты:

  • false ← (по умолчанию)
  • true

enable_encryption

boolean

Если параметр включен, конечная точка шифрует всю информацию, отправляемую LDAP-серверу.

Варианты:

  • false ← (по умолчанию)
  • true

enable_ldap

boolean

Если параметр включен, LDAP-сервер выполняет аутентификацию.

Варианты:

  • false
  • true ← (по умолчанию)

filter

string

Критерии для идентификации записей в поисковых запросах.

Обязателен, если state имеет значение present.

group_attribute

string

Группы, к которым принадлежит запись LDAP.

Обязателен, если state имеет значение present.

group_authorization

boolean

Если параметр включен, авторизация пользователей LDAP, отсутствующих в локальной базе пользователей, также выполняется на уровне группы.

Варианты:

  • false ← (по умолчанию)
  • true

ldap_groups

list / elements=dictionary

Список групп LDAP, которые нужно создать и добавить в политику LDAP.

Каждая группа определяет сопоставление между группами LDAP-сервера и ролями Intersight.

domain

string

Домен LDAP-сервера, в котором находится группа.

group_dn

string

DN группы LDAP в базе данных LDAP-сервера.

Обязателен, если state имеет значение present.

name

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

Имя группы LDAP в базе данных LDAP-сервера.

role

string

Роль, назначаемая всем пользователям этой группы LDAP-сервера.

admin предоставляет полный административный доступ.

readonly предоставляет доступ только для чтения.

user предоставляет стандартный пользовательский доступ.

Для домена поддерживается только роль ‘admin’.

Обязателен, если state имеет значение present.

Варианты:

  • "admin" ← (по умолчанию)
  • "readonly"
  • "user"

state

string

Создать или обновить группу LDAP либо удалить ее.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

ldap_providers

list / elements=dictionary

Список поставщиков LDAP (серверов), которые нужно создать и добавить в политику LDAP.

Поставщики определяют LDAP-серверы, к которым необходимо подключиться.

Нельзя указывать при значении true для enable_dns (вместо этого используется обнаружение DNS).

Обязателен при значении false для enable_dns (необходимо указать как минимум одного поставщика).

port

integer

Номер порта, на котором прослушивает LDAP-сервер.

По умолчанию: 389

server

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

IP-адрес или имя узла LDAP-сервера.

Обязателен, если state имеет значение present.

state

string

Создать или обновить поставщика LDAP либо удалить его.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

vendor

string

Тип LDAP-сервера.

openldap для серверов OpenLDAP.

msad для Microsoft Active Directory.

Варианты:

  • "openldap" ← (по умолчанию)
  • "msad"

name

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

Имя, присвоенное политике LDAP.

Должно быть уникальным в пределах организации.

Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.

nested_group_search

boolean

Если параметр включен, расширенный поиск проходит по цепочке родительских групп вплоть до корневой.

Рекурсивно возвращает все группы и подгруппы, к которым принадлежит каждая из этих групп.

Варианты:

  • false ← (по умолчанию)
  • true

nested_group_search_depth

integer

Глубина поиска вложенной группы LDAP в карте групп LDAP.

Допустимый диапазон: 1–128.

Применяется только при значении true для nested_group_search.

По умолчанию: 128

organization

string

Имя организации, которой назначен этот ресурс.

Политики, созданные в пользовательской организации, применимы только к устройствам в этой же организации.

Для организации по умолчанию используйте ‘default’.

По умолчанию: "default"

password

string

Пароль пользователя для начального связывания.

Может содержать любые символы, кроме пробелов, табуляций и переводов строки.

Не может содержать более 254 символов.

Обязателен, если для bind_method задано значение configuredcredentials.

search_domain

string

Имя домена, используемое в качестве источника для DNS-запроса.

Обязателен, если для dns_source задано значение configured или configuredextracted.

search_forest

string

Имя леса, используемое в качестве источника для DNS-запроса.

Обязателен, если для dns_source задано значение configured или configuredextracted.

state

string

Если задано present, будет проверено наличие ресурса и при необходимости он будет создан.

Если задано absent, будет проверено отсутствие ресурса и при необходимости он будет удален.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

list / elements=dictionary

Список тегов в формате «Ключ:<ключ, заданный пользователем> Значение:<значение, заданное пользователем>».

timeout

integer

Длительность ожидания при аутентификации LDAP, в секундах.

Допустимый диапазон: 0–180.

По умолчанию: 0

use_proxy

boolean

Если задано no, прокси использоваться не будет, даже если он указан в переменной среды на целевых узлах.

Варианты:

  • false
  • true ← (по умолчанию)

user_search_precedence

string

Порядок поиска в локальной базе пользователей и базе пользователей LDAP.

localuserdb сначала выполняет поиск в локальной базе пользователей.

ldapuserdb сначала выполняет поиск в базе пользователей LDAP.

Варианты:

  • "localuserdb" ← (по умолчанию)
  • "ldapuserdb"

validate_certs

boolean

Логический параметр, управляющий проверкой TLS-сертификата api_uri.

Варианты:

  • false
  • true ← (по умолчанию)

Примеры

- name: Create LDAP Policy with DNS enabled
  cisco.intersight.intersight_ldap_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "ldap-dns-policy"
    description: "LDAP policy using DNS for server discovery"
    enable_ldap: true
    base_dn: "dc=example,dc=com"
    domain: "example.com"
    timeout: 30
    enable_encryption: true
    bind_method: "logincredentials"
    filter: "sAMAccountName"
    group_attribute: "memberOf"
    attribute: "CiscoAvPair"
    group_authorization: true
    nested_group_search: true
    nested_group_search_depth: 64
    enable_dns: true
    dns_source: "configured"
    search_domain: "example.com"
    search_forest: "example.com"
    user_search_precedence: "localuserdb"
    ldap_groups:
      - name: "admin-group"
        group_dn: "cn=admins,ou=groups,dc=example,dc=com"
        domain: "example.com"
        role: "admin"
      - name: "readonly-group"
        group_dn: "cn=readers,ou=groups,dc=example,dc=com"
        role: "readonly"
    tags:
      - Key: "Environment"
        Value: "Production"
    state: present

- name: Create LDAP Policy with providers
  cisco.intersight.intersight_ldap_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "ldap-provider-policy"
    description: "LDAP policy with specific servers"
    enable_ldap: true
    base_dn: "company"
    domain: "company.local"
    timeout: 0
    enable_encryption: false
    bind_method: "anonymous"
    filter: "sAMAccountName"
    group_attribute: "memberOf"
    attribute: "CiscoAvPair"
    group_authorization: false
    nested_group_search: false
    enable_dns: false
    user_search_precedence: "localuserdb"
    ldap_providers:
      - server: "10.10.10.10"
        port: 389
        vendor: "openldap"
      - server: "10.10.10.11"
        port: 389
        vendor: "openldap"
    ldap_groups:
      - name: "users-group"
        group_dn: "company"
        role: "user"
    state: present

- name: Create LDAP Policy with configured credentials
  cisco.intersight.intersight_ldap_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "ldap-configured-creds"
    description: "LDAP policy with configured bind credentials"
    enable_ldap: true
    base_dn: "dc=corp,dc=net"
    domain: "corp.net"
    timeout: 60
    enable_encryption: true
    bind_method: "configuredcredentials"
    bind_dn: "cn=admin,dc=corp,dc=net"
    password: "SecurePassword123"
    filter: "uid"
    group_attribute: "gidNumber"
    attribute: "description"
    group_authorization: true
    nested_group_search: true
    nested_group_search_depth: 128
    enable_dns: false
    user_search_precedence: "ldapuserdb"
    ldap_providers:
      - server: "ldap.corp.net"
        port: 636
        vendor: "msad"
    ldap_groups:
      - name: "administrators"
        group_dn: "cn=administrators,ou=groups,dc=corp,dc=net"
        domain: "corp.net"
        role: "admin"
    state: present

- name: Update LDAP Policy - manage group states
  cisco.intersight.intersight_ldap_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "ldap-dns-policy"
    description: "Updated LDAP policy"
    enable_ldap: true
    base_dn: "dc=example,dc=com"
    domain: "example.com"
    filter: "sAMAccountName"
    group_attribute: "memberOf"
    attribute: "CiscoAvPair"
    enable_dns: true
    ldap_groups:
      - name: "admin-group"
        group_dn: "cn=admins,ou=groups,dc=example,dc=com"
        role: "admin"
        state: present
      - name: "old-group"
        state: absent
      - name: "new-group"
        group_dn: "cn=new,ou=groups,dc=example,dc=com"
        role: "user"
        state: present
    state: present

- name: Delete LDAP Policy
  cisco.intersight.intersight_ldap_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "old-ldap-policy"
    state: absent

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

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

Ключ

Описание

api_response

dictionary

Выходные данные ответа API, возвращенные указанным ресурсом.

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

Пример: {"api_response": {"BaseProperties": {"Attribute": "CiscoAvPair", "BaseDn": "dc=example,dc=com", "BindMethod": "LoginCredentials", "Domain": "example.com", "EnableEncryption": true, "EnableGroupAuthorization": true, "EnableNestedGroupSearch": true, "Filter": "sAMAccountName", "GroupAttribute": "memberOf", "NestedGroupSearchDepth": 64, "Timeout": 30}, "DnsParameters": {"SearchDomain": "example.com", "SearchForest": "example.com", "Source": "Configured"}, "EnableDns": true, "Enabled": true, "Groups": [{"Domain": "example.com", "GroupDn": "cn=admins,ou=groups,dc=example,dc=com", "Name": "admin-group"}], "Name": "ldap-dns-policy", "ObjectType": "iam.LdapPolicy", "Providers": [], "UserSearchPrecedence": "LocalUserDb"}}

Авторы

  • Ron Gershburg (@rgershbu)

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

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

© 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/intersight/intersight_ldap_policy_module.html

Spec-Zone.ru

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