Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_application_list_defaultnetworkservices — Записи по умолчанию для сетевых служб.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_application_list_defaultnetworkservices.

Новая функция в fortinet.fortimanager 2.1.0

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

Описание

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

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

строка / обязательно

Параметр (adom) в запрошенном URL.

application_list_defaultnetworkservices

словарь

Настройка параметров верхнего уровня.

id

целое число / обязательно

Идентификатор записи.

port

целое число

Номер порта.

services

список / элементы=строка

Сетевые протоколы.

Варианты:

  • "http"
  • "ssh"
  • "telnet"
  • "ftp"
  • "dns"
  • "smtp"
  • "pop3"
  • "imap"
  • "snmp"
  • "nntp"
  • "https"

violation_action

строка

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

Варианты:

  • "block"
  • "monitor"
  • "pass"

bypass_validation

логическое

Устанавливается в True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжает выполняться без проверки параметров.

Варианты:

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

enable_log

логическое

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

Варианты:

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

forticloud_access_token

строка

Аутентифицировать Ansible-клиент с токеном доступа к forticloud API.

list

строка / обязательно

Параметр (list) в запрошенном URL.

proposed_method

строка

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

список / элементы=целое число

Список кодов rc, при которых будет осуществлено переопределение условий для провала.

rc_succeeded

список / элементы=целое число

Список кодов rc, при которых будет осуществлено переопределение условий для успеха.

state

строка / обязательно

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

строка

ADOM для блокировки в режиме работы в рабочем пространстве FortiManager; значение может быть глобальным и другими, включая root.

workspace_locking_timeout

целое число

Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем.

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

Примечания

Примечание

  • Начиная с версии 2.4.0, все входные аргументы имеют имя в стиле нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
  • В этом модуле FortiManager поддерживается режим блокировки рабочей области. Параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться неудачно, если возвращается ненулевой код rc. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Default network service entries.
      fortinet.fortimanager.fmgr_application_list_defaultnetworkservices:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        list: <your own value>
        state: present # <value in [present, absent]>
        application_list_defaultnetworkservices:
          id: <integer>
          port: <integer>
          services:
            - http
            - ssh
            - telnet
            - ftp
            - dns
            - smtp
            - pop3
            - imap
            - snmp
            - nntp
            - https
          violation_action: <value in [block, monitor, pass]>

Значения возврата

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

Ключ

Описание

meta

словарь

Результат запроса.

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

request_url

строка

Полный запрашиваемый URL.

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

Пример: "/sys/login/user"

response_code

целое число

Статус запроса API.

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

Пример: 0

response_data

список / элементы=строка

Ответ API.

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

response_message

строка

Описание ответа API.

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

Пример: "OK."

system_information

словарь

Информация о целевой системе.

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

rc

целое число

Статус запроса.

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

Пример: 0

version_check_warning

список / элементы=строка

Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager.

Возвращается: сложное

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

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

  • Отслеживание ошибок
  • Главная страница
  • Репозиторий (источники)

© 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/fortinet/fortimanager/fmgr_application_list_defaultnetworkservices_module.html

Spec-Zone.ru

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