Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry_portrange – Диапазоны портов в пользовательской записи.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр

Комментарии

access_token

строка

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

adom

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

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

bypass_validation

булево

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

Выбор:

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

enable_log

булево

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

Выбор:

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

entry

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

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

firewall_internetservicecustom_entry_portrange

словарь

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

end_port

целое число

Устарело, используйте end_port. Целое число, обозначающее конечный порт TCP/UDP/SCTP в диапазоне.

id

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

Идентификатор диапазона портов пользовательской записи.

start_port

целое число

Устарело, используйте start_port. Целое число, обозначающее начальный порт TCP/UDP/SCTP в диапазоне.

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: Port ranges in the custom entry.
      fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry_portrange:
        bypass_validation: false
        adom: ansible
        internet-service-custom: "ansible-test" # name
        entry: "1" # id
        state: present
        firewall_internetservicecustom_entry_portrange:
          end-port: 6
          id: 1
          start-port: 1

- 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 port ranges in the entry
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_internetservicecustom_entry_portrange"
          params:
            adom: "ansible"
            internet-service-custom: "ansible-test" # name
            entry: "1" # id
            port-range: "your_value"

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

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

Ключ

Описание

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

Spec-Zone.ru

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