Модуль fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface_secondaryip — второй IP-адрес интерфейса.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface_secondaryip.
Добавлено в fortinet.fortimanager 2.1.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
dynamic_mapping строка / обязательный | Параметр (dynamic_mapping) в запрошенном URL. |
enable_log логическое значение | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
fsp_vlan_dynamicmapping_interface_secondaryip словарь | Набор параметров верхнего уровня. |
|
allowaccess список / элементы=строка |
Разрешённый доступ. Варианты:
|
|
detectprotocol список / элементы=строка |
Определение протокола. Варианты:
|
|
detectserver строка |
Сервер обнаружения. |
|
gwdetect строка |
Обнаружение шлюза. Варианты:
|
|
ha_priority псевдонимы: ha-priority целое число |
Приоритет HA. |
|
id целое число / обязательный |
Идентификатор. |
|
ip строка |
IP-адрес. |
|
ping_serv_status псевдонимы: ping-serv-status целое число |
Состояние службы ping. |
|
secip_relay_ip псевдонимы: secip-relay-ip строка |
IP-адрес ретранслятора DHCP. |
|
seq целое число |
Порядковый номер. |
proposed_method строка | Метод, переопределяющий метод базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, переопределяющий условия неудачного выполнения. |
rc_succeeded список / элементы=целое число | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note строка | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state строка / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
vlan строка / обязательный | Параметр (vlan) в запрошенном URL. |
workspace_locking_adom строка | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global и другие области, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, имена всех входных аргументов задаются в формате с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но будут выдаваться предупреждения об устаревании. Чтобы игнорировать эти предупреждения, установите deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout позволяют управлять этим режимом.
- Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Second IP address of interface.
fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface_secondaryip:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
vlan: <your own value>
dynamic_mapping: <your own value>
state: present # <value in [present, absent]>
fsp_vlan_dynamicmapping_interface_secondaryip:
id: 0 # Required variable, integer
# allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm", "auto-ipsec",
# "radius-acct", "probe-response", "capwap", "dnp", "ftm", "fabric",
# "speed-test"]
# detectprotocol: ["ping", "tcp-echo", "udp-echo"]
# detectserver: <string>
# gwdetect: <value in [disable, enable]>
# ha_priority: <integer>
# ip: <string>
# ping_serv_status: <integer>
# seq: <integer>
# secip_relay_ip: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь | Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_fsp_vlan_dynamicmapping_interface_secondaryip_module.html
