Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_ldap_group — управление объектами ldap-group на Check Point через API веб-служб

Примечание

Этот модуль является частью коллекции check_point.mgmt (версия 6.9.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install check_point.mgmt.

Чтобы использовать её в плейбуке, укажите: check_point.mgmt.cp_mgmt_ldap_group.

Добавлено в check_point.mgmt 6.5.0

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

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

  • Управляет объектами ldap-group на устройствах Check Point, в том числе создаёт, обновляет и удаляет объекты.
  • Все операции выполняются через API веб-служб.
  • Доступен начиная с версии управления R82 JHF.

Параметры

Параметр

Комментарии

account_unit

string

Учетная единица LDAP группы. Идентифицируется по имени или UID.

account_unit_branch

string

Ветвь выбранной учетной единицы LDAP.

apply_filter_for_dynamic_group

boolean

Указывает, следует ли применять фильтр LDAP для динамической группы. <font color=”red”>Актуально только если</font> для параметра ‘scope’ задано значение, отличное от ‘only_group_in_branch’.

Варианты:

  • false
  • true

auto_publish_session

boolean

Опубликовать текущий сеанс, если после завершения задачи были внесены изменения.

Варианты:

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

color

string

Цвет объекта. Должен быть одним из существующих цветов.

Варианты:

  • "aquamarine"
  • "black"
  • "blue"
  • "crete blue"
  • "burlywood"
  • "cyan"
  • "dark green"
  • "khaki"
  • "orchid"
  • "dark orange"
  • "dark sea green"
  • "pink"
  • "turquoise"
  • "dark blue"
  • "firebrick"
  • "brown"
  • "forest green"
  • "gold"
  • "dark gold"
  • "gray"
  • "dark gray"
  • "light green"
  • "lemon chiffon"
  • "coral"
  • "sea green"
  • "sky blue"
  • "magenta"
  • "purple"
  • "slate blue"
  • "violet red"
  • "navy blue"
  • "olive"
  • "orange"
  • "red"
  • "sienna"
  • "yellow"

comments

string

Строка с комментариями.

details_level

string

Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного представления объекта.

Варианты:

  • "uid"
  • "standard"
  • "full"

domains_to_process

list / elements=string

Указывает, в каких доменах выполнять команды. Нельзя использовать с уровнем детализации full; команды необходимо запускать только из системного домена и с параметром ignore-warnings, равным true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

group_prefix

string

Имя группы в выбранной ветви. <font color=”red”>Обязателен только если</font> для параметра ‘scope’ задано значение ‘only_group_in_branch’. Должен соответствовать синтаксису DN.

ignore_errors

boolean

Применить изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться.

Варианты:

  • false
  • true

ignore_warnings

boolean

Применить изменения, игнорируя предупреждения.

Варианты:

  • false
  • true

ldap_filter

string

Фильтр LDAP для динамической группы. <font color=”red”>Актуально только если</font> для параметра ‘apply-filter-for-dynamic-group’ задано значение ‘true’.

name

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

Имя объекта.

scope

string

Область действия группы. Группу можно определить тремя способами на основе пользователей, заданных в учетной единице.

Варианты:

  • "all_account_unit_users"
  • "only_sub_tree"
  • "only_group_in_branch"

state

string

Состояние правила доступа (present или absent).

Варианты:

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

sub_tree_prefix

string

Префикс поддерева выбранной ветви. <font color=”red”>Актуально только если</font> для параметра ‘scope’ задано значение ‘only_sub_prefix’. Должен соответствовать синтаксису DN.

tags

list / elements=string

Список идентификаторов тегов.

version

string

Версия Check Point. Если не указана, используется последняя версия.

wait_for_task

boolean

Дождаться завершения задачи, например задачи публикации.

Варианты:

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

wait_for_task_timeout

integer

Количество минут ожидания до возникновения ошибки тайм-аута.

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

Примеры

- name: add-ldap-group
  cp_mgmt_ldap_group:
    account_unit: TestLdapAccountUnit
    account_unit_branch: OU=Test
    apply_filter_for_dynamic_group: true
    group_prefix: N=TestGroup
    ldap_filter: N=AnotherGroup
    name: TestLdapGroup
    scope: only_sub_tree
    state: present
    sub_tree_prefix: CA=AC

- name: set-ldap-group
  cp_mgmt_ldap_group:
    account_unit_branch: A=B
    group_prefix: N=TestGroup2
    ldap_filter: N=none
    name: TestLdapGroup
    state: present
    sub_tree_prefix: X=Y

- name: delete-ldap-group
  cp_mgmt_ldap_group:
    name: TestLdapGroup
    state: absent

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

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

Ключ

Описание

cp_mgmt_ldap_group

dictionary

Созданный или обновлённый объект Check Point.

Возвращается: всегда, кроме случаев удаления объекта.

Авторы

  • Dor Berenstein (@chkp-dorbe)

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

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

© 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/check_point/mgmt/cp_mgmt_ldap_group_module.html

Spec-Zone.ru

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