Модуль fortinet.fortimanager.fmgr_fsp_vlan_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_interface_secondaryip.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль предназначен для настройки устройства FortiManager.
- Примеры содержат все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
fsp_vlan_interface_secondaryip dictionary | Набор параметров верхнего уровня. |
|
allowaccess list / элементы=string |
Разрешённый доступ. Варианты:
|
|
detectprotocol list / элементы=string |
Протокол обнаружения. Варианты:
|
|
detectserver string |
Сервер обнаружения. |
|
gwdetect string |
Обнаружение шлюза. Варианты:
|
|
ha_priority псевдонимы: ha-priority integer |
Приоритет высокой доступности. |
|
id integer / обязательный |
Идентификатор. |
|
ip string |
IP-адрес. |
|
ping_serv_status псевдонимы: ping-serv-status integer |
Состояние службы ping. |
|
secip_relay_ip псевдонимы: secip-relay-ip string |
IP-адрес DHCP-ретранслятора. |
|
seq integer |
Порядковый номер. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
vlan string / обязательный | Параметр (vlan) в запрошенном URL. |
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие области, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания в секундах освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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_interface_secondaryip:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
vlan: <your own value>
state: present # <value in [present, absent]>
fsp_vlan_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", "icond", "scim"]
# 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 dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией 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_interface_secondaryip_module.html
