Модуль fortinet.fortimanager.fmgr_dynamic_interface_platformmapping — Картирование платформ динамических интерфейсов

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.1.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dynamic_interface_platformmapping словарь	Настройка верхнего уровня.
egress_shaping_profile любой	(список или строка) Устарело, пожалуйста, переименуйте на egress_shaping_profile. Профиль управления форматированием выхода.
ingress_shaping_profile любой	(список или строка) Устарело, пожалуйста, переименуйте на ingress_shaping_profile. Профиль управления форматированием входа.
intf_zone строка	Устарело, пожалуйста, переименуйте на intf_zone. Зона интерфейса.
intrazon_deny строка	Устарело, пожалуйста, переименуйте на intrazone_deny. Запрет внутри зоны. Варианты: `"disable"` `"enable"`
name строка / обязательно	Имя.
enable_log булево	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
interface строка / обязательно	Параметр (interface) в запрошенном 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_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: Dynamic interface platform mapping
      fortinet.fortimanager.fmgr_dynamic_interface_platformmapping:
        # 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>
        interface: <your own value>
        state: present # <value in [present, absent]>
        dynamic_interface_platformmapping:
          egress_shaping_profile: <list or string>
          ingress_shaping_profile: <list or string>
          intf_zone: <string>
          intrazone_deny: <value in [disable, enable]>
          name: <string>

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

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

Ключ	Описание
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_dynamic_interface_platformmapping_module.html