Spec-Zone.ru › Ansible

модуль check_point.mgmt.cp_mgmt_external_trusted_ca — управление объектами external-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_external_trusted_ca.

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

  • Обзор
  • Параметры
  • Примеры
  • Возвращаемые значения

Обзор

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

Параметры

Параметр

Описание

allow_certificates_from_branches

boolean

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

Варианты:

  • false
  • true

auto_publish_session

boolean

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

Варианты:

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

base64_certificate

string

Файл сертификата, закодированный в base64.

branches

list / elements=string

Ветви, из которых разрешено использовать сертификаты. Требуется, только если для «allow-certificates-from-branches» задано значение «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; команды необходимо запускать только из системного домена и при значении 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

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-external-trusted-ca
  cp_mgmt_external_trusted_ca:
    base64_certificate:
      "MIICujCCAaKgAwIBAgIIP1+IHWHbl0EwDQYJKoZIhvcNAQELBQAwFDESMBAGA1UEAxMJd3d3LnouY29tMB4XDTIzMTEyOTEyMzAwMFoXDTI0MTEyMDE2MDAwMFowFDESMBAGA1UEAxMJd3d3LnouY29tMI
       BIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoBreRGuq8u43GBog+ZaAnaR8ZF8cT2ppvtd3JoFmzTOQivLIt9sNtFYqEgHCtnNkKn9TRrxN14YscHgKIxfDSVlC9Rh0rrBvWgFqcm715Whr99Ogx
       JbYFkusFWJarSejIFx4n6MM48MJxLdtCP6Hy1G2cj1BCiCHj4i3VIVaDE/aMkSqJbYEvf+vFqUWxY8/uEuKI/HGhI7mhUPW4NSGL0Oafz5eEFVsxqV5NA19/JJZ9NajSkyANnaNL5raxGV0oeqaE3JB3lS
       ZfWbH6mQsToUxxwIQfsZiIBozajDdTgP3Kn4SMY0b+I/WAWgfigMSDTAIR8J1sdzGXy2w2kqQIDAQABoxAwDjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQBUgrHztHwC1E0mU5c4reMrHg+
       +YRHrgJNHVIYQbL5I2TJHk9S3UZsynoMa1CO86rReOtR5xoGv4PCkyyOW+PNlWUtXF3tNgqWj/21+XzG4RBHPw89TaTxRCdo+MHX58fi07SIzKjmxfdkEi+7+HQEQluDZGViolrGBAw2rXq/SZ3q/11mNq
       b5ZyqyOa2u1sBF1ApvG5a/FBRTaO8gaiNelRf0PGYkuV+1HhF2XyP8Qk565d+uxUH5M7eHF2PNyVk/r/36T+x+UMql9y9iizA0ekuAjXLok1xYl3Vw4S5zXCXYtNZLOVrs+plJb7IrlElyTOAbDFuPugh0
       edz7uZ"
    name: external_ca
    state: present

- name: set-external-trusted-ca
  cp_mgmt_external_trusted_ca:
    base64_certificate:
      "MIICujCCAaKgAwIBAgIIFbLYzT2+3TMwDQYJKoZIhvcNAQELBQAwFDESMBAGA1UEAxMJd3d3LnouY29tMB4XDTI0MDIwMTEyMzEwMFoXDTI0MTIzMTE2MDAwMFowFDESMBAGA1UEAxMJd3d3LnouY29tMI
       BIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoBreRGuq8u43GBog+ZaAnaR8ZF8cT2ppvtd3JoFmzTOQivLIt9sNtFYqEgHCtnNkKn9TRrxN14YscHgKIxfDSVlC9Rh0rrBvWgFqcm715Whr99Ogx
       JbYFkusFWJarSejIFx4n6MM48MJxLdtCP6Hy1G2cj1BCiCHj4i3VIVaDE/aMkSqJbYEvf+vFqUWxY8/uEuKI/HGhI7mhUPW4NSGL0Oafz5eEFVsxqV5NA19/JJZ9NajSkyANnaNL5raxGV0oeqaE3JB3lS
       ZfWbH6mQsToUxxwIQfsZiIBozajDdTgP3Kn4SMY0b+I/WAWgfigMSDTAIR8J1sdzGXy2w2kqQIDAQABoxAwDjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQBxaE9O/LCjKfWeugPeDPvr3Ld
       i1mYsgNIyN+ES1iDoJHXrBQpVzZelJRr8leFgbghGUX7Fwdh1qZ2Jw6nmD1oe/Q7jkPzTngb6dIMI/kFK4eXcS4GJ3S7yGobLB7QUKK1vrYWZdNuAzR6jMRmFECS+lPF7zlTexnwwOkATMp6lzS7xEpEhk
       8eLpSQnYzvsM+rL9voU5q9MrdAJ2XaCZe4Crv75NdYU6ljD2eSYDrO148Tg480TlvT5wzBuyanKhI/Po2oLEVWU7h5tkensHKB5zvxigIr9ZkczdzVbbrRFi2jSQy+VxYWc0zCo/uO+yaKmmLfGDQEb8wZ
       Y1Ml27"
    crl_cache_method: expiration date
    name: external_ca
    retrieve_crl_from_http_servers: 'false'
    state: present

- name: delete-external-trusted-ca
  cp_mgmt_external_trusted_ca:
    name: external_ca
    state: absent

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

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

Ключ

Описание

cp_mgmt_external_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_external_trusted_ca_module.html

Spec-Zone.ru

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