Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_monitor — модуль Ansible для API мониторинга FortiOS

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.5.1).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_monitor.

Добавлено в fortinet.fortios 2.0.0

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

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

  • Запрашивает у устройств FortiOS выполнение определенных действий или процедур. Этот модуль содержит все API мониторинга FortiOS.

Требования

На хосте, где выполняется этот модуль, необходимы следующие компоненты.

  • Установленная коллекция Galaxy fortinet.fortios версии >= 2.0.0.

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

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

params

dictionary

параметр для каждого селектора; определения см. в списке выше.

selector

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

селектор получаемых фактов FortiManager

Варианты:

  • "check.endpoint-control.registration-password"
  • "quarantine.endpoint-control.registration"
  • "unquarantine.endpoint-control.registration"
  • "block.endpoint-control.registration"
  • "unblock.endpoint-control.registration"
  • "deregister.endpoint-control.registration"
  • "clear_counters.firewall.acl"
  • "clear_counters.firewall.acl6"
  • "reset.firewall.policy"
  • "clear_counters.firewall.policy"
  • "reset.firewall.policy6"
  • "clear_counters.firewall.policy6"
  • "clear_counters.firewall.proxy-policy"
  • "clear_all.firewall.session"
  • "close.firewall.session"
  • "reset.firewall.shaper"
  • "reset.firewall.per-ip-shaper"
  • "cancel.fortiview.session"
  • "upgrade.license.database"
  • "reset.log.stats"
  • "login.registration.forticloud"
  • "create.registration.forticloud"
  • "logout.registration.forticloud"
  • "login.registration.forticare"
  • "create.registration.forticare"
  • "add-license.registration.forticare"
  • "add-license.registration.vdom"
  • "toggle-vdom-mode.system.admin"
  • "generate-key.system.api-user"
  • "update-comments.system.config-revision"
  • "delete.system.config-revision"
  • "save.system.config-revision"
  • "system.disconnect-admins"
  • "set.system.time"
  • "reboot.system.os"
  • "shutdown.system.os"
  • "revoke.system.dhcp"
  • "revoke.system.dhcp6"
  • "upgrade.system.firmware"
  • "start.system.fsck"
  • "system.change-password"
  • "system.password-policy-conform"
  • "reset.system.modem"
  • "connect.system.modem"
  • "disconnect.system.modem"
  • "update.system.modem"
  • "restart.system.sniffer"
  • "start.system.sniffer"
  • "stop.system.sniffer"
  • "test.system.automation-stitch"
  • "update.switch-controller.managed-switch"
  • "restart.switch-controller.managed-switch"
  • "poe-reset.switch-controller.managed-switch"
  • "factory-reset.switch-controller.managed-switch"
  • "download.switch-controller.fsw-firmware"
  • "push.switch-controller.fsw-firmware"
  • "upload.switch-controller.fsw-firmware"
  • "dhcp-renew.system.interface"
  • "start.system.usb-log"
  • "stop.system.usb-log"
  • "eject.system.usb-device"
  • "update.system.fortiguard"
  • "clear-statistics.system.fortiguard"
  • "test-availability.system.fortiguard"
  • "config.system.fortimanager"
  • "backup-action.system.fortimanager"
  • "dump.system.com-log"
  • "update.system.ha-peer"
  • "disconnect.system.ha-peer"
  • "run.system.compliance"
  • "restore.system.config"
  • "upload.system.vmlicense"
  • "trigger.system.security-rating"
  • "reset.extender-controller.extender"
  • "validate-gcp-key.system.sdn-connector"
  • "deauth.user.firewall"
  • "clear_users.user.banned"
  • "add_users.user.banned"
  • "clear_all.user.banned"
  • "activate.user.fortitoken"
  • "refresh.user.fortitoken"
  • "provision.user.fortitoken"
  • "send-activation.user.fortitoken"
  • "import-trial.user.fortitoken"
  • "import-mobile.user.fortitoken"
  • "import-seed.user.fortitoken"
  • "refresh-server.user.fsso"
  • "test-connect.user.radius"
  • "test.user.tacacs-plus"
  • "delete.webfilter.override"
  • "reset.webfilter.category-quota"
  • "tunnel_up.vpn.ipsec"
  • "tunnel_down.vpn.ipsec"
  • "tunnel_reset_stats.vpn.ipsec"
  • "clear_tunnel.vpn.ssl"
  • "delete.vpn.ssl"
  • "import.vpn-certificate.ca"
  • "import.vpn-certificate.crl"
  • "import.vpn-certificate.local"
  • "import.vpn-certificate.remote"
  • "generate.vpn-certificate.csr"
  • "reset.wanopt.history"
  • "reset.wanopt.webcache"
  • "reset.wanopt.peer_stats"
  • "reset.webcache.stats"
  • "set_status.wifi.managed_ap"
  • "download.wifi.firmware"
  • "push.wifi.firmware"
  • "upload.wifi.firmware"
  • "restart.wifi.managed_ap"
  • "reset.wifi.euclid"
  • "clear_all.wifi.rogue_ap"
  • "set_status.wifi.rogue_ap"
  • "reset.firewall.consolidated-policy"
  • "clear_counters.firewall.consolidated-policy"
  • "clear_counters.firewall.security-policy"
  • "add.firewall.clearpass-address"
  • "delete.firewall.clearpass-address"
  • "delete.log.local-report"
  • "migrate.registration.forticloud"
  • "change-vdom-mode.system.admin"
  • "delete.system.config-script"
  • "run.system.config-script"
  • "upload.system.config-script"
  • "diagnose.extender-controller.extender"
  • "upgrade.extender-controller.extender"
  • "add.nsx.service"
  • "update.system.sdn-connector"
  • "import.web-ui.language"
  • "create.web-ui.custom-language"
  • "update.web-ui.custom-language"
  • "email.user.guest"
  • "sms.user.guest"
  • "utm.rating-lookup"
  • "connect.wifi.network"
  • "scan.wifi.network"
  • "upload.wifi.region-image"
  • "refresh.azure.application-list"
  • "verify-cert.endpoint-control.ems"
  • "geoip.geoip-query"
  • "transfer.registration.forticare"
  • "register-device.registration.forticloud"
  • "register-appliance.system.csf"
  • "clear.system.sniffer"
  • "webhook.system.automation-stitch"
  • "format.system.logdisk"
  • "speed-test-trigger.system.interface"
  • "read-info.system.certificate"
  • "provision-user.vpn.ssl"
  • "upload.webproxy.pacfile"
  • "disassociate.wifi.client"
  • "start.wifi.spectrum"
  • "keep-alive.wifi.spectrum"
  • "stop.wifi.spectrum"
  • "start.wifi.vlan-probe"
  • "stop.wifi.vlan-probe"
  • "generate-keys.wifi.ssid"
  • "save.system.config"
  • "led-blink.wifi.managed_ap"
  • "auth.user.firewall"
  • "remove.user.device"
  • "clear.vpn.ike"
  • "reset.firewall.multicast-policy"
  • "reset.firewall.multicast-policy6"
  • "clear_counters.firewall.multicast-policy"
  • "clear_counters.firewall.multicast-policy6"
  • "clear-soft-in.router.bgp"
  • "clear-soft-out.router.bgp"
  • "enable-app-bandwidth-tracking.system.traffic-history"
  • "refresh.system.external-resource"
  • "reset.firewall.central-snat-map"
  • "clear-counters.firewall.central-snat-map"
  • "reset.firewall.dnat"
  • "clear-counters.firewall.dnat"
  • "close-multiple.firewall.session"
  • "close-multiple.firewall.session6"
  • "close-all.firewall.session"
  • "clear.system.crash-log"
  • "backup.system.config"
  • "abort.user.query"
  • "create.vpn-certificate.local"
  • "flush.firewall.gtp"
  • "kill.system.process"
  • "upload.system.hscalefw-license"
  • "download.system.vmlicense"
  • "start.network.debug-flow"
  • "stop.network.debug-flow"
  • "upload.system.lte-modem"
  • "upgrade.system.lte-modem"
  • "port-stats-reset.switch-controller.managed-switch"
  • "bounce-port.switch-controller.managed-switch"
  • "set-tier1.switch-controller.mclag-icl"
  • "wake-on-lan.system.interface"
  • "manual-update.system.fortiguard"
  • "purdue-level.user.device"
  • "deregister-device.registration.forticare"
  • "soft-reset-neighbor.router.bgp"
  • "download-eval.system.vmlicense"
  • "dynamic.system.external-resource"
  • "pse-config.switch-controller.recommendation"
  • "update.switch-controller.isl-lockdown"
  • "clear-counters.firewall.ztna-firewall-policy"
  • "update.forticonverter.eligibility"
  • "create.forticonverter.ticket"
  • "update.forticonverter.sn-list"
  • "upload.forticonverter.config"
  • "update.forticonverter.intf-list"
  • "forticonverter.set-source-sn"
  • "submit.forticonverter.intf-mapping"
  • "submit.forticonverter.mgmt-intf"
  • "submit.forticonverter.notes"
  • "submit.forticonverter.ticket"
  • "update.forticonverter.submitted-info"
  • "start.forticonverter.download"
  • "trial.user.fortitoken-cloud"
  • "unverify-cert.endpoint-control.ems"
  • "update-global-label.firewall.policy"
  • "update-global-label.firewall.security-policy"
  • "set-tier-plus.switch-controller.mclag-icl"
  • "user.password-policy-conform"
  • "change-password.user.local"
  • "report.sdwan.link-monitor-metrics"
  • "generic-address.system.external-resource"
  • "set.system.private-data-encryption"
  • "create-default.wifi.ap-profile"

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Для разных селекторов могут использоваться разные параметры; пользователям следует ознакомиться с параметрами конкретного селектора.
  • Для некоторых селекторов объекты являются глобальными, поэтому параметры указывать нельзя.
  • Для селектора не обязательно указывать все параметры.
  • Этот модуль предназначен исключительно для API мониторинга FortiOS.
  • Результат запроса API сохраняется в results.

Примеры

- name: Activate FortiToken
  fortinet.fortios.fortios_monitor:
      vdom: "root"
      access_token: "your_own_value"
      selector: 'activate.user.fortitoken'
      params:
          tokens: '<token string>'

- name: Reboot This Device
  fortinet.fortios.fortios_monitor:
      vdom: "root"
      access_token: "you_own_value"
      selector: 'reboot.system.os'
      params:
          event_log_message: 'Reboot Request From Ansible'

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи данных в FortiGate

Возвращается: всегда

Пример: "GET"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "firmware"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "system"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Использованный виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@fshen01)

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

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

© 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/fortinet/fortios/fortios_monitor_module.html

Spec-Zone.ru

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