модуль fortinet.fortios.fortios_switch_controller_location — настройка служб определения местоположения FortiSwitch в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_switch_controller_location.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры категорий switch_controller feature и location. В примерах представлены все параметры и значения, которые перед использованием необходимо настроить в соответствии с источниками данных. Проверено с FOS v6.0.0

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с атрибутом member_path можно использовать для выполнения операции с элементом.
member_state string	Добавить или удалить элемент по указанному пути атрибута. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
switch_controller_location dictionary	Настройка служб определения местоположения FortiSwitch.
address_civic dictionary	Настройка гражданского адреса местоположения.
additional string	Дополнительные сведения о местоположении.
additional_code string	Дополнительные сведения о коде местоположения.
block string	Сведения о квартале местоположения.
branch_road string	Сведения о боковой дороге местоположения.
building string	Сведения о здании местоположения.
city string	Сведения о городе местоположения.
city_division string	Сведения о районе города местоположения.
country string	Двухбуквенный код страны по ISO 3166 заглавными буквами ASCII, например US, CA, DK, DE.
country_subdivision string	Административно-территориальные единицы страны (штат, кантон, регион, провинция или префектура).
county string	Округ, приход, гун (Япония) или район (Индия).
direction string	Направление перед названием улицы.
floor string	Этаж.
landmark string	Ориентир или неофициальное название адреса.
language string	Язык.
name string	Имя (жителя или сотрудника офиса).
number string	Номер дома.
number_suffix string	Суффикс номера дома.
parent_key string	Имя родительского ключа.
place_type string	Тип места.
post_office_box string	Абонентский ящик.
postal_community string	Название почтового населенного пункта.
primary_road string	Название основной дороги.
road_section string	Участок дороги.
room string	Номер комнаты.
script string	Система письменности для представления сведений об адресе.
seat string	Номер места.
street string	Улица.
street_name_post_mod string	Модификатор после названия улицы.
street_name_pre_mod string	Модификатор перед названием улицы.
street_suffix string	Суффикс названия улицы.
sub_branch_road string	Название второстепенной боковой дороги.
trailing_str_suffix string	Конечный суффикс улицы.
unit string	Помещение (квартира, офис).
zip string	Почтовый индекс.
coordinates dictionary	Настройка GPS-координат местоположения.
altitude string	Положительное или отрицательное число с плавающей точкой. Например, 117.47.
altitude_unit string	Задайте единицу измерения высоты (m = метры, f = этажи здания). Варианты: `"m"` `"f"`
datum string	WGS84, NAD83, NAD83/MLLW. Варианты: `"WGS84"` `"NAD83"` `"NAD83/MLLW"`
latitude string	Число с плавающей точкой, начинающееся с +/- или оканчивающееся на N или S. Например, +/-16.67 или 16.67N.
longitude string	Число с плавающей точкой, начинающееся с +/- или оканчивающееся на N или S. Например, +/-26.789 или 26.789E.
parent_key string	Имя родительского ключа.
elin_number dictionary	Настройка номера ELIN местоположения.
elin_num string	Настройка номера ELIN для обратного вызова.
parent_key string	Имя родительского ключа.
name string / обязательный	Уникальное имя элемента местоположения.
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен устаревшим; предпочтительный способ запуска плейбуков — httpapi.
Модуль поддерживает check_mode.

Примеры

- name: Configure FortiSwitch location services.
  fortinet.fortios.fortios_switch_controller_location:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_location:
          address_civic:
              additional: "<your_own_value>"
              additional_code: "<your_own_value>"
              block: "<your_own_value>"
              branch_road: "<your_own_value>"
              building: "<your_own_value>"
              city: "<your_own_value>"
              city_division: "<your_own_value>"
              country: "<your_own_value>"
              country_subdivision: "<your_own_value>"
              county: "<your_own_value>"
              direction: "<your_own_value>"
              floor: "<your_own_value>"
              landmark: "<your_own_value>"
              language: "<your_own_value>"
              name: "default_name_18"
              number: "<your_own_value>"
              number_suffix: "<your_own_value>"
              parent_key: "<your_own_value>"
              place_type: "<your_own_value>"
              post_office_box: "<your_own_value>"
              postal_community: "<your_own_value>"
              primary_road: "<your_own_value>"
              road_section: "<your_own_value>"
              room: "<your_own_value>"
              script: "<your_own_value>"
              seat: "<your_own_value>"
              street: "<your_own_value>"
              street_name_post_mod: "<your_own_value>"
              street_name_pre_mod: "<your_own_value>"
              street_suffix: "<your_own_value>"
              sub_branch_road: "<your_own_value>"
              trailing_str_suffix: "<your_own_value>"
              unit: "<your_own_value>"
              zip: "<your_own_value>"
          coordinates:
              altitude: "<your_own_value>"
              altitude_unit: "m"
              datum: "WGS84"
              latitude: "<your_own_value>"
              longitude: "<your_own_value>"
              parent_key: "<your_own_value>"
          elin_number:
              elin_num: "<your_own_value>"
              parent_key: "<your_own_value>"
          name: "default_name_48"

Возвращаемые значения

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: always Пример: `"1547"`
http_method string	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: always Пример: `"PUT"`
http_status string	Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: always Пример: `"200"`
mkey string	Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: success Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: always Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: always Пример: `"webfilter"`
revision string	Внутренний номер ревизии Возвращается: always Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: always Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат выполнения операции Возвращается: always Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: always Пример: `"root"`
version string	Версия FortiGate Возвращается: always Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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/fortios/fortios_switch_controller_location_module.html