Spec-Zone.ru › Ansible

check_point.mgmt.cp_mgmt_hosts модуль — Управляет ресурсом HOSTS

Примечание

Этот модуль входит в коллекцию check_point.mgmt (версия 5.2.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install check_point.mgmt.

Чтобы использовать её в playbook, укажите: check_point.mgmt.cp_mgmt_hosts.

Новое в check_point.mgmt 5.0.0

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

Описание

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр

Комментарии

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, цикл с возвратом отфильтрует параметры модуля из параметра ответа, что позволит пользователю отправить запрос конфигурации, используя структурированные собранные данные.

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

Варианты:

  • false
  • true

tags

list / elements=string

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

version

string

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

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_hosts_module.html

Spec-Zone.ru

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