Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_firewall_internetservicecustom_disableentry_iprange модуль — Диапазоны IP-адресов в записи запрета.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_internetservicecustom_disableentry_iprange.

Новое в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

строка

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

adom

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

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

bypass_validation

логическое

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

Варианты:

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

disable-entry

строка

Устаревшее, используйте «disable_entry»

disable_entry

строка

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

enable_log

логическое

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

Варианты:

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

firewall_internetservicecustom_disableentry_iprange

словарь

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

end_ip

строка

Конечный IP-адрес.

id

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

ID диапазона запрещенных записей.

start_ip

строка

Начальный IP-адрес.

forticloud_access_token

строка

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

internet_service_custom

строка

Устаревшее, используйте «internet_service_custom»

internet_service_custom

строка

Параметр (internet-service-custom) в запрошенном URL.

proposed_method

строка

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

Варианты:

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

rc_failed

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

Список кодов rc, по которым будет переопределено условие отказа.

rc_succeeded

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

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

state

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

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

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

строка

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

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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: IP ranges in the disable entry.
      fortinet.fortimanager.fmgr_firewall_internetservicecustom_disableentry_iprange:
        bypass_validation: false
        adom: ansible
        internet-service-custom: "ansible-test" # name
        disable-entry: "1" # id
        state: present
        firewall_internetservicecustom_disableentry_iprange:
          end-ip: "0.0.0.20"
          id: 1
          start-ip: "0.0.0.0"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the ipranges in the disabled entry
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_internetservicecustom_disableentry_iprange"
          params:
            adom: "ansible"
            internet-service-custom: "ansible-test" # name
            disable-entry: "1" # id
            ip-range: "your_value"
END_OF_DOCUMENT_MARKER

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

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

Ключ

Описание

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

Spec-Zone.ru

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