Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_hosts — управление ресурсом HOSTS

Примечание

Этот модуль входит в коллекцию 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_hosts.

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

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

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

  • Этот ресурсный модуль позволяет добавлять, удалять и изменять узлы CP MGMT.
  • Этот ресурсный модуль также собирает факты о конфигурации узлов.
  • Доступен начиная с версии R80 Management.

Примечание

Для этого модуля имеется соответствующий модуль действий.

Параметры

Параметр

Комментарии

config

dictionary

Словарь параметров HOSTS

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"

groups

list / elements=string

Коллекция идентификаторов групп.

host_servers

dictionary

Конфигурация серверов.

dns_server

boolean

Возвращает True, если этот сервер является DNS-сервером.

Варианты:

  • false
  • true

mail_server

boolean

Возвращает True, если этот сервер является почтовым сервером.

Варианты:

  • false
  • true

web_server

boolean

Возвращает True, если этот сервер является веб-сервером.

Варианты:

  • false
  • true

web_server_config

dictionary

Конфигурация веб-сервера.

additional_ports

list / elements=string

Дополнительные порты сервера.

application_engines

list / elements=string

Механизмы приложений этого веб-сервера.

listen_standard_port

boolean

Определяет, прослушивает ли сервер стандартный порт.

Варианты:

  • false
  • true

operating_system

string

Операционная система.

Варианты:

  • "sparc linux"
  • "windows"
  • "other"
  • "x86 linux"
  • "sparc solaris"

protected_by

string

Сетевой объект, защищающий этот сервер; указывается по имени или UID.

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

interfaces

list / elements=dictionary

Интерфейсы узла.

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"

ignore_errors

boolean

Применить изменения, игнорируя ошибки. Такие изменения нельзя будет опубликовать.

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

mask_length

integer

Длина маски сети IPv4 или IPv6. Если требуются обе маски, явно используйте поля mask-length4 и mask-length6.

Вместо длины маски IPv4 можно указать саму маску IPv4 в поле subnet-mask.

mask_length4

integer

Длина маски сети IPv4.

mask_length6

integer

Длина маски сети IPv6.

name

string

Имя интерфейса.

subnet

string

Сетевой адрес IPv4 или IPv6.

Если требуются оба адреса, явно используйте поля subnet4 и subnet6.

subnet4

string

Сетевой адрес IPv4.

subnet6

string

Сетевой адрес IPv6.

subnet_mask

string

Маска сети IPv4.

ip_address

string

Адрес IPv4 или IPv6. Если требуются оба адреса, явно используйте поля ipv4-address и ipv6-address.

ipv4_address

string

Адрес IPv4.

ipv6_address

string

Адрес IPv4.

limit

integer

Максимальное количество возвращаемых результатов.

ПРИМЕЧАНИЕ. Этот параметр действителен только для состояния GATHERED; для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не применяется.

name

string

Имя объекта. Должно быть уникальным в домене.

nat_settings

dictionary

Параметры NAT.

auto_rule

boolean

Следует ли добавлять автоматические правила трансляции адресов.

Варианты:

  • false
  • true

hide_behind

string

Метод скрытия адреса. Этот параметр не требуется, если параметр «method» имеет значение «static».

Варианты:

  • "gateway"
  • "ip-address"

install_on

string

Шлюз, который должен применять трансляцию NAT.

ip_address

string

Адрес IPv4 или IPv6. Если требуются оба адреса, явно используйте поля ipv4-address и ipv6-address.

Этот параметр не требуется, если параметр «method» имеет значение «hide», а параметр «hide-behind» — «gateway».

ipv4_address

string

Адрес IPv4.

ipv6_address

string

Адрес IPv6.

method

string

Метод трансляции NAT.

Варианты:

  • "hide"
  • "static"

offset

integer

Количество результатов, которые нужно пропустить в начале.

ПРИМЕЧАНИЕ. Этот параметр действителен только для состояния GATHERED; для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не применяется.

order

list / elements=dictionary

Сортирует результаты по указанному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применим только при получении нескольких объектов.

ПРИМЕЧАНИЕ. Этот параметр действителен только для состояния GATHERED; для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не применяется.

ASC

string

Сортирует результаты по указанному полю в порядке возрастания.

DESC

string

Сортирует результаты по указанному полю в порядке убывания.

round_trip

boolean

Если установлено значение True, round trip отфильтрует параметры модуля из параметра ответа, что позволит пользователю отправить запрос конфигурации, используя структурированные собранные данные.

ПРИМЕЧАНИЕ. Этот параметр применим только к состоянию GATHERED, поскольку для состояний конфигурации, таких как MERGED, REPLACED и DELETED, он не вносит изменений в конфигурацию: это не параметр конфигурации модуля.

Варианты:

  • false
  • true

tags

list / elements=string

Коллекция идентификаторов тегов.

version

string

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

state

string

Состояние, в котором должна остаться конфигурация

Состояние gathered получает конфигурацию API модуля с устройства и преобразует ее в структурированные данные в формате, соответствующем argspec модуля; значение возвращается в ключе gathered в составе результата.

Варианты:

  • "merged"
  • "replaced"
  • "gathered"
  • "deleted"

Примеры

# Using MERGED state
# -------------------

- name: Merge MGMT Hosts config
  cp_mgmt_hosts:
    state: merged
    config:
      color: cyan
      ip_address: 192.0.2.1
      name: New Host 1
      auto_publish_session: true
      tags:
        - New Host
      round_trip: true

# RUN output:
# -----------

# mgmt_hosts:
#   after:
#     color: cyan
#     comments: ''
#     groups: []
#     icon: Objects/host
#     interfaces: []
#     ipv4-address: 192.0.2.1
#     name: New Host 1
#     nat_settings: {}
#     tags:
#     - New Host
#   before: {}

# Using REPLACED state
# --------------------

- name: Replace MGMT Host config
  cp_mgmt_hosts:
    state: replaced
    config:
      name: New Host 1
      tags:
        - New Replaced Host
      color: aquamarine
      ip_address: 198.51.110.0
      comments: REPLACED description
      ignore_warnings: true
      ignore_errors: false
      auto_publish_session: true
      round_trip: true

# RUN output:
# -----------

# mgmt_hosts:
#   after:
#     color: aquamarine
#     comments: REPLACED description
#     groups: []
#     icon: Objects/host
#     interfaces: []
#     ipv4-address: 198.51.110.0
#     name: New Host 1
#     nat_settings: {}
#     tags:
#     - New Replaced Host
#   before:
#     color: cyan
#     comments: ''
#     groups: []
#     icon: Objects/host
#     interfaces: []
#     ipv4-address: 192.0.2.1
#     name: New Host 1
#     nat_settings: {}
#     tags:
#     - New Host

# Using GATHERED state
# --------------------

# 1. With Round Trip set to True

- name: Gather MGMT Host config by Name
  cp_mgmt_hosts:
    state: gathered
    config:
      name: New Host 1

# RUN output:
# -----------

# gathered:
#   color: cyan
#   comments: REPLACED description
#   domain: SMC User
#   groups: []
#   icon: Objects/host
#   interfaces: []
#   ipv4-address: 192.0.2.1
#   name: New Host 1
#   nat_settings: {}
#   read-only: false
#   tags:
#   - New Host
#   uid: 63b868bb-d300-47f4-b97a-c465a56fe9c7

# 2. With Round Trip set to False which is the default behaviour

- name: Gather MGMT Host config by Name
  cp_mgmt_hosts:
    state: gathered
    config:
      name: New Host 1

# RUN output:
# -----------

# gathered:
#   color: cyan
#   comments: ''
#   domain:
#     domain-type: domain
#     name: SMC User
#     uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#   groups: []
#   icon: Objects/host
#   interfaces: []
#   ipv4-address: 192.0.2.1
#   meta-info:
#     creation-time:
#       iso-8601: 2022-11-21T08:31+0000
#       posix: 1669019480328
#     creator: admin
#     last-modifier: admin
#     last-modify-time:
#       iso-8601: 2022-11-21T08:31+0000
#       posix: 1669019480328
#     lock: unlocked
#     validation-state: ok
#   name: New Host 1
#   nat_settings: {}
#   read-only: false
#   tags:
#   - domain:
#       domain-type: domain
#       name: SMC User
#       uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#     name: New Host
#     type: tag
#     uid: 94d53896-3cee-4e1f-a83b-3abac80bf512
#   type: host
#   uid: 8f23a44b-d9d2-4242-8a9e-2a4cbb6723ff

# 3. Gather ALL threat-layer config with DESC order filter

- name: Gather All hosts on the MGMT instance
  cp_mgmt_hosts:
    config:
      details_level: full
    state: gathered

# RUN output:
# -----------

# gathered:
#   - domain:
#       domain-type: domain
#       name: SMC User
#       uid: 41e821a0-3720-11e3-aa6e-0800200c9fde
#     ipv4-address: 192.0.2.1
#     name: New Host 1
#     type: host
#     uid: 8f23a44b-d9d2-4242-8a9e-2a4cbb6723ff

# Using DELETED state
# -------------------

- name: Delete MGMT Host config by Name
  cp_mgmt_hosts:
    state: deleted
    config:
      name: New Host 1
      round_trip: true

# RUN output:
# -----------

# mgmt_hosts:
#   after: {}
#   before:
#     color: cyan
#     comments: REPLACED description
#     groups: []
#     icon: Objects/host
#     interfaces: []
#     ipv4-address: 192.0.2.1
#     name: New Host 1
#     nat_settings: {}
#     tags:
#     - New Host

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

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

Ключ

Описание

after

dictionary

Итоговая конфигурация после выполнения модуля.

Возвращается: при наличии изменений

Пример: "This output will always be in the same format as the module argspec.\n"

before

dictionary

Конфигурация до выполнения модуля.

Возвращается: если состояние — merged, replaced, deleted

Пример: "This output will always be in the same format as the module argspec.\n"

gathered

dictionary

Сведения о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных.

Возвращается: если состояние — gathered

Пример: "This output will always be in the same format as the module argspec.\n"

Авторы

  • Команда Ansible Security Automation (@justjais) <https://github.com/ansible-security>-

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

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

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

Spec-Zone.ru

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