Spec-Zone.ru › Ansible

модуль check_point.mgmt.cp_mgmt_access_point_name — управление объектами имён точек доступа в 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_access_point_name.

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

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

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

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

Параметры

Параметр

Комментарии

apn

string

Имя APN.

auto_publish_session

boolean

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

Варианты:

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

block_traffic_other_end_user_domains

boolean

Блокировать трафик MS–MS между этим доменом конечных пользователей APN и другими такими доменами.

Варианты:

  • false
  • true

block_traffic_this_end_user_domain

boolean

Блокировать трафик MS–MS внутри этого домена конечных пользователей.

Варианты:

  • 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"

end_user_domain

string

Имя или UID домена конечных пользователей.

enforce_end_user_domain

boolean

Включить принудительное применение домена конечных пользователей.

Варианты:

  • false
  • true

groups

list / элементы=string

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

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

name

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

Имя объекта.

state

string

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

Варианты:

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

tags

list / элементы=string

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

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

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

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

Примеры

- name: add-access-point-name
  cp_mgmt_access_point_name:
    name: myaccesspointname
    apn: apnname
    end_user_domain: All_Internet
    enforce_end_user_domain: 'True'
    state: present

- name: set-access-point-name
  cp_mgmt_access_point_name:
    name: myaccesspointname
    block_traffic_other_end_user_domains: 'False'
    block_traffic_this_end_user_domain: 'False'
    enforce_end_user_domain: 'True'
    state: present

- name: delete-access-point-name
  cp_mgmt_access_point_name:
    name: myaccesspointname
    state: absent

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

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

Ключ

Описание

cp_mgmt_access_point_name

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

Spec-Zone.ru

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