Spec-Zone.ru › Ansible

модуль check_point.mgmt.cp_mgmt_opsec_trusted_ca — управление объектами opsec-trusted-ca на 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_opsec_trusted_ca.

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

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

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

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

Параметры

Параметр

Комментарии

allow_certificates_from_branches

boolean

Разрешать сертификаты только из указанных ветвей.

Варианты:

  • false
  • true

auto_publish_session

boolean

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

Варианты:

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

automatic_enrollment

dictionary

Автоматическая регистрация сертификата.

automatically_enroll_certificate

boolean

Определяет, следует ли автоматически регистрировать сертификат.

Варианты:

  • false
  • true

cmpv1_settings

dictionary

Параметры протокола Cmpv1. Доступно, только если для «protocol» задано значение «cmpv1».

direct_tcp_settings

dictionary

Параметры транспортного уровня Direct TCP.

ip_address

string

IP-адрес центра сертификации.

port

integer

Номер порта.

cmpv2_settings

dictionary

Параметры протокола Cmpv2. Доступно, только если для «protocol» задано значение «cmpv1».

direct_tcp_settings

dictionary

Параметры транспортного уровня Direct TCP.

ip_address

string

IP-адрес центра сертификации.

port

integer

Номер порта.

http_settings

dictionary

Параметры транспортного уровня HTTP.

url

string

URL центра сертификации.

transport_layer

string

Транспортный уровень.

Варианты:

  • "http"
  • "direct-tcp"

protocol

string

Протокол для связи с центром сертификации. Доступно, только если параметру «automatically-enroll-certificate» присвоено значение true.

Варианты:

  • "scep"
  • "cmpv2"
  • "cmpv1"

scep_settings

dictionary

Параметры протокола Scep. Доступно, только если для «protocol» задано значение «scep».

ca_identifier

string

Идентификатор центра сертификации.

url

string

URL центра сертификации.

base64_certificate

string

Файл сертификата в кодировке Base64.

branches

list / elements=string

Ветви, из которых разрешено принимать сертификаты. Обязателен, только если для «allow-certificates-from-branches» задано значение «true».

cache_crl

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

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

crl_cache_method

string

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

Варианты:

  • "timeout"
  • "expiration date"

crl_cache_timeout

integer

Время до получения нового списка отозванных сертификатов (в минутах).

details_level

string

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

Варианты:

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

domains_to_process

list / elements=string

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

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

name

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

Имя объекта.

retrieve_crl_from_http_servers

boolean

Определяет, следует ли получать список отозванных сертификатов с HTTP-серверов.

Варианты:

  • false
  • true

retrieve_crl_from_ldap_servers

boolean

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

Варианты:

  • false
  • true

state

string

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

Варианты:

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

tags

list / elements=string

Набор идентификаторов тегов.

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

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

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

Примеры

- name: add-opsec-trusted-ca
  cp_mgmt_opsec_trusted_ca:
    base64_certificate:
      "MIICwjCCAaqgAwIBAgIILdexblpVEMIwDQYJKoZIhvcNAQELBQAwGDEWMBQGA1UEAxMNd3d3Lm9wc2VjLmNvbTAeFw0yMzA2MjUwOTE3MDBaFw0yNTAzMzExNjAwMDBaMBgxFjAUBgNVBAMTDXd3dy5vcH
       lYy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCjpqCxDaVg+I1b+wqnmjjYtL3v7Tlu/YpMbsKnv+M1gRz6QFUOoSVnxKLo0A7Y4kCqa1OPcHO/LtXuok43F1YZPVKm3xWpY8FmqGqf5
       uGmSwm1HPObcMjwGOyFgwpwEDF5e0UMZ7xtJF8BZ5KKBh3ZfQ1FbmbVqSUPcmOi+NE4JspPlHxX+m6es/yeSGR1A2ezKY7KePTlwVtDe8hiLrYyKG92nka5rkD1QyEIVJ0W5wrnU4nGEDIHeOfT09zroQx
       NLkb51sl4Tog/qw+EraVGIBe/iFnSJoDF37i2mLJqI/t8bel+aGDAxgMx1pO85OClgjPSWL0UIXGI2xrR+JAgMBAAGjEDAOMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHTs1AutAmSLHF2
       RLJtrRNkso0lMyA7XI7k1TNpTk7TCZLNY0VbUliGbcl+POH4EG8ARUrftnwRDCTBd2BdJTqG2CyNADi+bw8aLvbxok7KH0GlQvGjyfq+sHK12wTl4ULNyYoAPZ01GhXOvkobROdSyjxvBVhxdVo90kj7mH
       v3N83huNhfstDFUBcQCmMkbLuzDUZrl2a1OtqlOdNC6mNvb7Jq9W9vRxGA514e7jqyoM+PwHu5fILx/jmGT8suOUnvbtcDdFhjqixAPer6uSPR0CSbiJvuDy72DPH5mjZK5dQKewNYOZ/BQEsRIBe+Q6eG
       oJqi+cD63cwlw0DCc="
    name: opsec_ca
    state: present

- name: set-opsec-trusted-ca
  cp_mgmt_opsec_trusted_ca:
    name: opsec_ca
    automatic_enrollment:
      automatically_enroll_certificate: true
      protocol: "cmpv1"
      cmpv1_settings:
        direct_tcp_settings:
          ip_address: "1.1.1.1"
    state: present

- name: delete-opsec-trusted-ca
  cp_mgmt_opsec_trusted_ca:
    name: opsec_ca
    state: absent

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

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

Ключ

Описание

cp_mgmt_opsec_trusted_ca

dictionary

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

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

Авторы

  • Eden Brillant (@chkp-edenbr)

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

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

© 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_opsec_trusted_ca_module.html

Spec-Zone.ru

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