Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

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

bypass_validation

boolean

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

Варианты:

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

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"

system_interface

dictionary

Набор параметров верхнего уровня.

aggregate

string

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

alias

string

Псевдоним.

allowaccess

list / elements=string

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

ping — доступ по PING.

https — доступ по HTTPS.

ssh — доступ по SSH.

snmp — доступ по SNMP.

http — доступ по HTTP.

webservice — доступ к веб-службе.

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

Варианты:

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

defaultgw

string

Включить/отключить шлюз по умолчанию.

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

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

Варианты:

  • "disable"
  • "enable"

description

string

Описание.

dhcp_client_identifier

псевдонимы: dhcp-client-identifier

string

Идентификатор DHCP-клиента.

dns_server_override

псевдонимы: dns-server-override

string

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

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

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

Варианты:

  • "disable"
  • "enable"

interface

string

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

ip

string

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

ipv6

dictionary

IPv6.

ip6_address

псевдонимы: ip6-address

string

IPv6-адрес/префикс интерфейса.

ip6_allowaccess

псевдонимы: ip6-allowaccess

list / elements=string

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

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

псевдонимы: ip6-autoconf

string

Включить/отключить автоматическую настройку адреса.

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

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

Варианты:

  • "disable"
  • "enable"

lacp_mode

псевдонимы: lacp-mode

string

Режим LACP.

active — активно использовать LACP для согласования параметров 802.

Варианты:

  • "active"

lacp_speed

псевдонимы: lacp-speed

string

Частота отправки интерфейсом сообщений LACP.

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

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

Варианты:

  • "slow"
  • "fast"

link_up_delay

псевдонимы: link-up-delay

integer

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

lldp

string

Включить/отключить LLDP.

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

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

Варианты:

  • "disable"
  • "enable"

member

list / elements=dictionary

Участник.

interface_name

псевдонимы: interface-name

string

Имя физического интерфейса.

min_links

псевдонимы: min-links

integer

Минимальное количество активных агрегированных портов.

min_links_down

псевдонимы: min-links-down

string

Действие при снижении количества активных каналов ниже настроенного минимума.

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

administrative — административно отключить агрегат.

Варианты:

  • "operational"
  • "administrative"

mode

string

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

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

dhcp — режим внешнего DHCP-клиента.

Варианты:

  • "static"
  • "dhcp"

mtu

integer

Максимальный размер блока передачи.

mtu_override

псевдонимы: mtu-override

string

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

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

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

Варианты:

  • "disable"
  • "enable"

name

string / обязательный

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

rating_service_ip

псевдонимы: rating-service-ip

string

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

serviceaccess

list / elements=string

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

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

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

webfilter-antispam — доступ к веб-фильтрации и защите от спама.

Варианты:

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

speed

string

Скорость.

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"

status

string

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

down — интерфейс отключён.

up — интерфейс включён.

Варианты:

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

type

string

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

vlan — интерфейс VLAN.

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

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

Варианты:

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

update_service_ip

псевдонимы: update-service-ip

string

IP-адрес службы обновлений fgt/fct; он должен находиться в той же подсети, что и IP-адрес интерфейса.

vlan_protocol

псевдонимы: vlan-protocol

string

Протокол Ethernet для VLAN.

8021q — IEEE 802.

8021ad — IEEE 802.

Варианты:

  • "8021q"
  • "8021ad"

vlanid

integer

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

workspace_locking_adom

string

ADOM для блокировки при работе FortiManager в режиме рабочей области; значением может быть global или другой ADOM, включая 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 позволяют управлять этим режимом.
  • Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  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

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_interface_module.html

Spec-Zone.ru

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