fortinet.fortimanager.fmgr_dynamic_interface модуль — Динамичный интерфейс

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_dynamic_interface.

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (default) `true`
dynamic_interface dictionary	Набор параметров верхнего уровня.
color integer	Цвет.
default-mapping string	Устарело, переименуйте в default_mapping. Карта по умолчанию. Варианты: `"disable"` `"enable"`
defmap-intf string	Устарело, переименуйте в defmap_intf. Defmap intf.
defmap-intrazone-deny string	Устарело, переименуйте в defmap_intrazone_deny. Defmap intrazone deny. Варианты: `"disable"` `"enable"`
defmap-zonemember any	(list) Устарело, переименуйте в defmap_zonemember. Defmap zonemember.
description string	Описание.
dynamic_mapping list / elements=dictionary	Динамическое отображение.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	Vdom.
egress-shaping-profile any	(list or str) Устарело, переименуйте в egress_shaping_profile. Профайл формирования исходящего трафика.
ingress-shaping-profile any	(list or str) Устарело, переименуйте в ingress_shaping_profile. Профайл формирования входящего трафика.
intrazone-deny string	Устарело, переименуйте в intrazone_deny. Запрет внутри зоны. Варианты: `"disable"` `"enable"`
local-intf any	(list) Устарело, переименуйте в local_intf. Локальный интерфейс.
egress-shaping-profile any	(list or str) Устарело, переименуйте в egress_shaping_profile. Профайл формирования исходящего трафика.
ingress-shaping-profile any	(list or str) Устарело, переименуйте в ingress_shaping_profile. Профайл формирования входящего трафика.
name string / required	Имя.
platform_mapping list / elements=dictionary	Отображение платформы.
egress-shaping-profile any	(list or str) Устарело, переименуйте в egress_shaping_profile. Профайл формирования исходящего трафика.

ingress-shaping-profile any	(list or str) Устарело, пожалуйста, переименуйте на ingress_shaping_profile. Профиль формирования трафика входящего канала.
intf-zone string	Устарело, пожалуйста, переименуйте на intf_zone. Зона интерфейса.
intrazone-deny string	Устарело, пожалуйста, переименуйте на intrazone_deny. Запрет внутризоны. Варианты: `"disable"` `"enable"`
name string	Имя.
single-intf string	Устарело, пожалуйста, переименуйте на single_intf. Единственный интерфейс. Варианты: `"disable"` `"enable"`
wildcard string	Подстановка. Варианты: `"disable"` `"enable"`
wildcard-intf string	Устарело, пожалуйста, переименуйте на wildcard_intf. Интерфейс подстановки.
zone-only string	Устарело, пожалуйста, переименуйте на zone_only. Только зона. Варианты: `"disable"` `"enable"`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Авторизовать клиента Ansible с токеном доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список rc кодов, при которых условия будут считаться ошибочными.
rc_succeeded list / elements=integer	Список rc кодов, при которых условия будут считаться успешными.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки при работе в режиме рабочего пространства FortiManager, значение может быть global и другими, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `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: Dynamic interface
      fortinet.fortimanager.fmgr_dynamic_interface:
        # 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>
        state: present # <value in [present, absent]>
        dynamic_interface:
          color: <integer>
          default_mapping: <value in [disable, enable]>
          defmap_intf: <string>
          defmap_intrazone_deny: <value in [disable, enable]>
          defmap_zonemember: <list or string>
          description: <string>
          dynamic_mapping:
            -
              _scope:
                -
                  name: <string>
                  vdom: <string>
              egress_shaping_profile: <list or string>
              intrazone_deny: <value in [disable, enable]>
              local_intf: <list or string>
              ingress_shaping_profile: <list or string>
          egress_shaping_profile: <list or string>
          name: <string>
          single_intf: <value in [disable, enable]>
          ingress_shaping_profile: <list or string>
          platform_mapping:
            -
              egress_shaping_profile: <list or string>
              ingress_shaping_profile: <list or string>
              intf_zone: <string>
              intrazone_deny: <value in [disable, enable]>
              name: <string>
          wildcard: <value in [disable, enable]>
          wildcard_intf: <string>
          zone_only: <value in [disable, enable]>

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

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

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