Модуль check_point.mgmt.cp_mgmt_identity_provider — управление объектами поставщиков удостоверений на Checkpoint через 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_identity_provider.

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

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

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

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

Параметры

Параметр	Комментарии
auto_publish_session логическое значение	Опубликовать текущий сеанс после выполнения задачи, если в ходе неё были внесены изменения. Варианты: `false` ← (по умолчанию) `true`
base64_certificate строка	Файл сертификата, закодированный в base64 на основе данных поставщика. <font color=”red”>Требуется только, если</font> параметр ‘data-receiving’ имеет значение ‘manually’.
base64_metadata_file строка	Файл метаданных, закодированный в base64 на основе данных поставщика. <font color=”red”>Требуется только, если</font> параметр ‘data-receiving’ имеет значение ‘metadata_file’.
color строка	Цвет объекта. Должен быть одним из существующих цветов. Варианты: `"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 строка	Строка комментария.
data_receiving строка	Способ получения данных от поставщика удостоверений SAML. Варианты: `"metadata_file"` `"manually"`
details_level строка	Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до его полного подробного представления. Варианты: `"uid"` `"standard"` `"full"`
domains_to_process список / элементы=строка	Указывает, в каких доменах выполнять команды. Нельзя использовать с полным уровнем детализации; команды должны запускаться только из системного домена и при значении ignore-warnings true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
gateway строка	Шлюз для использования поставщика удостоверений SAML. Идентифицируется по имени или UID. <font color=”red”>Требуется только, если</font> параметр ‘usage’ имеет значение ‘gateway_policy_and_logs’.
ignore_errors логическое значение	Применять изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings логическое значение	Применять изменения, игнорируя предупреждения. Варианты: `false` `true`
login_url строка	URL-адрес входа на основе данных поставщика. <font color=”red”>Требуется только, если</font> параметр ‘data-receiving’ имеет значение ‘manually’.
name строка / обязательный	Имя объекта.
received_identifier строка	Полученный идентификатор (ID сущности) на основе данных поставщика. <font color=”red”>Требуется только, если</font> параметр ‘data-receiving’ имеет значение ‘manually’.
service строка	Служба для выбранного шлюза. <font color=”red”>Требуется только, если</font> параметр ‘usage’ имеет значение ‘gateway_policy_and_logs’. Варианты: `"none"` `"identity awareness"` `"mobile access"` `"vpn"`
state строка	Состояние правила доступа (присутствует или отсутствует). Варианты: `"present"` ← (по умолчанию) `"absent"`
tags список / элементы=строка	Коллекция идентификаторов тегов.
usage строка	Назначение поставщика удостоверений. Варианты: `"managing_administrator_access"` `"gateway_policy_and_logs"`
version строка	Версия Checkpoint. Если версия не указана, используется последняя.
wait_for_task логическое значение	Ожидать завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout целое число	Время ожидания в минутах до возникновения ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: add-identity-provider
  cp_mgmt_identity_provider:
    base64_certificate: |
        LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUM4RENDQWRpZ0F3SUJBZ0lRUTBWZVpLdVBLb0pQUWhaNGhDaWRzREFOQmdrcWhraUc5dzBCQVFzRkFEQTBNVEl3TUFZRFZRUURFeWxOYVdOeWIzTn
        ablFnUVhwMWNtVWdSbVZrWlhKaGRHVmtJRk5UVHlCRFpYSjBhV1pwWTJGMFpUQWVGdzB4T0RBME1UVXhNVEl6TXpOYUZ3MHlNVEEwTVRVeE1USXpNek5hTURReE1qQXdCZ05WQkFNVEtVMXBZM0p2YzI5b
        RDQkJlblZ5WlNCR1pXUmxjbUYwWldRZ1UxTlBJRU5sY25ScFptbGpZWFJsTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUE0VXVqYUd0OFhaODl2dXZ5a3lRVzVYb24vOFIv
        VB0ejRhYjBNM3RNVXZHWHozVXh0V1pTRStUR1hydjN3VHRLMCs4RmtNeXVKYUhGSXBLLzRVREZpRk1yQmxzR0Z1dmtTc1p5VjIzZlNGN3paaXlUWTZUN0EwcCtnczUwNVhEOUdBYjlWYmR3R0cwK0tDVnl
        c1ZRZ1YySXdKZ2l5aHF3RUNvY3dCcmFuN251SytURU5EMmwyZjlZcng1b1JNRU56NzB3bHlIMzZPWkJtdDBrNTk4L1doMEhEWUxaZW8wZHlTV3JOd3dlWXZTeEU4L01kbTQzWEV1U3pialR6ZnNNMHZVUn
        GQlNyVUxFYURPMS9JUDJVcjdCc2dId1JJL3hmb3FJbUsxS2twVXEwQWxjVEFpM3YxdTl6Qy9xTGdQd0F5UUl2dzlVQ3NpcnJQQTBZMFlPaFFJREFRQUJNQTBHQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUURja
        9qZEd6L0FJQ2pqTTBaN21ZbGdQNXpic2FRNWRDMmNqZjRESnFta21zV3VmUnBDNHNic3VoODcwY0NCS2N1dmgrb0dpekJRSHJQbTRUaEl2ZklsS0w4WGpMQVhiRnVSUG9IQWcwOHNMWGR2UFRCVE52REYx
        WhvcU5zMmo2ZUZxL2ROdXF2ZUJIcjVENXRLblYyWEJHRUhFOVJFOVdUa1pRT2MwaEhtQ3dNbWNZb3JYRzhCa3l1OXFwNXhyMDZMQ0htMnJLcnI2ZENRVldBV0R0MzhiS2t5STRobTVSNTVCclR5UldSdzI
        RS9YaFEwVksva1FJYW9GZ0hvaWo0ekg5bmxlZnZMbmhaZDVPRzROL29OS2pBKy9LbkVqaTdPQXhKWVNaR1FmRjU0R1AwQTE4VnF1NVVGaFBKMUZFQXZ5YjR0QnZtTzM1NFFVUys5UTY2agotLS0tLUVORC
        DRVJUSUZJQ0FURS0tLS0t
    data_receiving: manually
    login_url: https://login.checkpointonline.com/621ac12d-4afb-479c-9c14-13e7b743cd07/saml2
    name: TestIdp2
    received_identifier: https://sts.checkpoint.net/621ac12d-4afb-479c-9c14-13e7b743cd07/
    state: present
    usage: managing_administrator_access

- name: set-identity-provider
  cp_mgmt_identity_provider:
    base64_certificate: |
        LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUM4RENDQWRpZ0F3SUJBZ0lRUTBWZVpLdVBLb0pQUWhaNGhDaWRzREFOQmdrcWhraUc5dzBCQVFzRkFEQTBNVEl3TUFZRFZRUURFeWxOYVdOeWIzTn
        ablFnUVhwMWNtVWdSbVZrWlhKaGRHVmtJRk5UVHlCRFpYSjBhV1pwWTJGMFpUQWVGdzB4T0RBME1UVXhNVEl6TXpOYUZ3MHlNVEEwTVRVeE1USXpNek5hTURReE1qQXdCZ05WQkFNVEtVMXBZM0p2YzI5b
        RDQkJlblZ5WlNCR1pXUmxjbUYwWldRZ1UxTlBJRU5sY25ScFptbGpZWFJsTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUE0VXVqYUd0OFhaODl2dXZ5a3lRVzVYb24vOFIv
        VB0ejRhYjBNM3RNVXZHWHozVXh0V1pTRStUR1hydjN3VHRLMCs4RmtNeXVKYUhGSXBLLzRVREZpRk1yQmxzR0Z1dmtTc1p5VjIzZlNGN3paaXlUWTZUN0EwcCtnczUwNVhEOUdBYjlWYmR3R0cwK0tDVnl
        c1ZRZ1YySXdKZ2l5aHF3RUNvY3dCcmFuN251SytURU5EMmwyZjlZcng1b1JNRU56NzB3bHlIMzZPWkJtdDBrNTk4L1doMEhEWUxaZW8wZHlTV3JOd3dlWXZTeEU4L01kbTQzWEV1U3pialR6ZnNNMHZVUn
        GQlNyVUxFYURPMS9JUDJVcjdCc2dId1JJL3hmb3FJbUsxS2twVXEwQWxjVEFpM3YxdTl6Qy9xTGdQd0F5UUl2dzlVQ3NpcnJQQTBZMFlPaFFJREFRQUJNQTBHQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUURja
        9qZEd6L0FJQ2pqTTBaN21ZbGdQNXpic2FRNWRDMmNqZjRESnFta21zV3VmUnBDNHNic3VoODcwY0NCS2N1dmgrb0dpekJRSHJQbTRUaEl2ZklsS0w4WGpMQVhiRnVSUG9IQWcwOHNMWGR2UFRCVE52REYx
        WhvcU5zMmo2ZUZxL2ROdXF2ZUJIcjVENXRLblYyWEJHRUhFOVJFOVdUa1pRT2MwaEhtQ3dNbWNZb3JYRzhCa3l1OXFwNXhyMDZMQ0htMnJLcnI2ZENRVldBV0R0MzhiS2t5STRobTVSNTVCclR5UldSdzI
        RS9YaFEwVksva1FJYW9GZ0hvaWo0ekg5bmxlZnZMbmhaZDVPRzROL29OS2pBKy9LbkVqaTdPQXhKWVNaR1FmRjU0R1AwQTE4VnF1NVVGaFBKMUZFQXZ5YjR0QnZtTzM1NFFVUys5UTY2agotLS0tLUVORC
        DRVJUSUZJQ0FURS0tLS0t
    data_receiving: manually
    login_url: https://login.checkpointonline.com/621ac12d-4afb-479c-9c14-13e7b743cd07/saml2
    name: TestIdp
    received_identifier: https://sts.checkpoint.net/621ac12d-4afb-479c-9c14-13e7b743cd07/
    state: present
    usage: managing_administrator_access

- name: delete-identity-provider
  cp_mgmt_identity_provider:
    name: TestIdp
    state: absent

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

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

Ключ	Описание
cp_mgmt_identity_provider словарь	Созданный или обновлённый объект Checkpoint. Возвращается: всегда, кроме случаев удаления объекта.

Авторы

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_identity_provider_module.html