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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 и категорию расположения. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось на FOS v6.0.0

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается в GUI Fortigate.
enable_log boolean	Включить/Отключить логирование для задачи. Варианты: `false` ← (default) `true`
member_path string	Путь к атрибуту элемента для выполнения операции. Разделяется символом слеша, если атрибутов более одного. Параметр, помеченный как member_path, является допустимым для выполнения операций с элементами.
member_state string	Добавить или удалить элемент под указанным путем к атрибуту. Когда указан member_state, опция state игнорируется. Варианты: `"present"` `"absent"`
state string / required	Указывает, следует ли создать или удалить объект. Варианты: `"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 прописными латинскими буквами, например, US, CA, DK, DE.
country_subdivision string	Административно-территориальные единицы (штат, кантон, регион, провинция или префектура).
county string	Графство, приход, район (JP) или округ (IN).
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 / required	Уникальное имя элемента местоположения.
vdom string	Виртуальный домен, среди ранее определенных. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. Default: `"root"`

Примечания

Примечание

Устаревший fortiosapi был объявлен устаревшим, httpapi является предпочтительным способом запуска playbooks
Модуль поддерживает 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 Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при последней примененной операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: успех Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom string	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_location_module.html