Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_system_interface модуль – Настройка интерфейса.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 1.0.0

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

Описание

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

Параметры

Параметр

Комментарии

access_token

строка

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

bypass_validation

логическое значение

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

Выбоpы:

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

enable_log

логическое значение

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

Выбоpы:

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

forticloud_access_token

строка

Авторизация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

строка

Переопределённый метод для базового запроса Json RPC.

Выбоpы:

  • "update"
  • "set"
  • "add"

rc_failed

список / элементы=целое число

Список кодов rc, с помощью которых будут переопределены условия для отказа.

rc_succeeded

список / элементы=целое число

Список кодов rc, с помощью которых будут переопределены условия для успеха.

state

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

Директива для создания, обновления или удаления объекта.

Выбоpы:

  • "present"
  • "absent"

system_interface

словарь

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

aggregate

строка

Сетевой агрегированный интерфейс.

alias

строка

Псевдоним.

allowaccess

список / элементы=строка

Разрешение доступа к интерфейсу для управления.

ping - доступ по протоколу PING.

https - доступ по протоколу HTTPS.

ssh - доступ по протоколу SSH.

snmp - доступ по протоколу SNMP.

http - доступ по протоколу HTTP.

webservice - доступ по протоколу веб-сервисов.

https-logging - доступ для ведения журналов по протоколу HTTPS.

Выбоpы:

  • "ping"
  • "https"
  • "ssh"
  • "snmp"
  • "http"
  • "webservice"
  • "https-logging"
  • "soc-fabric"
  • "fabric"

defaultgw

строка

Включение/выключение шлюза по умолчанию.

disable - Выключение параметра.

enable - Включение параметра.

Выбоpы:

  • "disable"
  • "enable"

description

строка

Описание.

dhcp-client-identifier

строка

Устарело, переименуйте на dhcp_client_identifier. Идентификатор клиента DHCP.

dns-server-override

строка

Устарело, переименуйте на dns_server_override.

Включение/выключение использования DNS, полученного по DHCP или PPPoE.

disable - Выключение параметра.

enable - Включение параметра.

Выбоpы:

  • "disable"
  • "enable"

interface

строка

Наименование базового интерфейса.

ip

строка

IP-адрес интерфейса.

ipv6

словарь

IPv6.

ip6-address

строка

Устарело, переименуйте на ip6_address. IPv6-адрес/префикс интерфейса.
END_OF_DOCUMENT_MARKER

ip6-allowaccess

list / elements=string

Устарело, переименуйте в ip6_allowaccess.

Разрешить доступ к управлению интерфейсом.

ping - Доступ PING.

https - Доступ HTTPS.

ssh - Доступ SSH.

snmp - Доступ SNMP.

http - Доступ HTTP.

webservice - Доступ к веб-сервису.

https-logging - Ведение журнала через HTTPS доступ.

Варианты:

  • "ping"
  • "https"
  • "ssh"
  • "snmp"
  • "http"
  • "webservice"
  • "https-logging"
  • "fabric"

ip6-autoconf

string

Устарело, переименуйте в ip6_autoconf.

Включить/выключить автоматическую конфигурацию адреса

disable - Отключить настройку.

enable - Включить настройку.

Варианты:

  • "disable"
  • "enable"

lacp-mode

string

Устарело, переименуйте в lacp_mode.

Режим LACP.

active - Активно использовать LACP для согласования 802.

Варианты:

  • "active"

lacp-speed

string

Устарело, переименуйте в lacp_speed.

Как часто интерфейс отправляет сообщения LACP.

slow - Отправлять сообщение LACP каждые 30 секунд.

fast - Отправлять сообщение LACP каждую секунду.

Варианты:

  • "slow"
  • "fast"

link-up-delay

integer

Устарело, переименуйте в link_up_delay. Количество миллисекунд ожидания перед тем, как считать связь установленной.

lldp

string

Включить/выключить LLDP

disable - Отключить настройку.

enable - Включить настройку.

Варианты:

  • "disable"
  • "enable"

member

list / elements=dictionary

Участник.

interface-name

string

Устарело, переименуйте в interface_name. Имя физического интерфейса.

min-links

integer

Устарело, переименуйте в min_links. Минимальное количество агрегированных портов, которые должны быть активны.

min-links-down

string

Устарело, переименуйте в min_links_down.

Действие, которое необходимо выполнить, когда активное количество каналов меньше настроенного минимального значения.

operational - Установить агрегат в оперативно нерабочее состояние.

administrative - Установить агрегат в административно нерабочее состояние.

Варианты:

  • "operational"
  • "administrative"

mode

string

Режим адресации

static - Статическая настройка.

dhcp - Внешний режим клиента DHCP.

Варианты:

  • "static"
  • "dhcp"

mtu

integer

Максимальный транспортный блок

mtu-override

string

Устарело, переименуйте в mtu_override.

Включить/выключить использование MTU, полученного от DHCP или PPPoE.

disable - Отключить настройку.

enable - Включить настройку.

Варианты:

  • "disable"
  • "enable"

name

string / required

Имя интерфейса.

rating-service-ip

string

Устарело, переименуйте в rating_service_ip. IP-адрес для службы рейтингов fgt, должен быть в той же подсети, что и IP-адрес интерфейса.

serviceaccess

list / elements=string

Разрешить доступ к сервисам на интерфейсе.

fgtupdates - Доступ к обновлениям FortiGate.

fclupdates - Доступ к обновлениям FortiClient.

webfilter-antispam - Доступ к веб-фильтрации и антиспаму.

Варианты:

  • "fgtupdates"
  • "fclupdates"
  • "webfilter-antispam"

скорость

строка

Скорость.

auto - Автоматическая настройка скорости.

10full - 10 Мбит/с с полным дуплексом.

10half - 10 Мбит/с с полудуплексом.

100full - 100 Мбит/с с полным дуплексом.

100half - 100 Мбит/с с полудуплексом.

1000full - 1000 Мбит/с с полным дуплексом.

10000full - 10000 Мбит/с с полным дуплексом.

Варианты:

  • "auto"
  • "10full"
  • "10half"
  • "100full"
  • "100half"
  • "1000full"
  • "10000full"
  • "1g/full"
  • "2.5g/full"
  • "5g/full"
  • "10g/full"
  • "14g/full"
  • "20g/full"
  • "25g/full"
  • "40g/full"
  • "50g/full"
  • "56g/full"
  • "100g/full"
  • "1g/half"
  • "200g/full"
  • "400g/full"

состояние

строка

Состояние интерфейса.

down - Интерфейс неактивен.

up - Интерфейс активен.

Варианты:

  • "down"
  • "up"
  • "disable"
  • "enable"

тип

строка

Тип интерфейса.

vlan - Интерфейс VLAN.

physical - Физический интерфейс.

aggregate - Агрегированный интерфейс.

Варианты:

  • "vlan"
  • "physical"
  • "aggregate"

update-service-ip

строка

Устарело, пожалуйста, переименуйте на update_service_ip. IP-адрес службы обновления fgt/fct, должен быть в одной подсети с интер…

vlan-протокол

строка

Устарело, пожалуйста, переименуйте на vlan_protocol.

Протокол Ethernet VLAN.

8021q - IEEE 802.

8021ad - IEEE 802.

Варианты:

  • "8021q"
  • "8021ad"

vlanid

целое число

Идентификатор VLAN

workspace_locking_adom

строка

Область (adom) для блокировки FortiManager в режиме рабочего пространства. Значение может быть глобальным и другими, включая root.

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: Interface configuration.
      fortinet.fortimanager.fmgr_system_interface:
        bypass_validation: false
        state: present
        system_interface:
          allowaccess:
            - ping
          ip: "222.222.22.2/24"
          mtu: 1500
          name: port4
          serviceaccess:
            - fgtupdates
          speed: auto # <value in [auto, 10full, 10half, ...]>
          status: up

- 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 interfaces
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_interface"
          params:
            interface: "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_system_interface_module.html

Spec-Zone.ru

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