fortinet.fortios.fortios_system_api_user модуль — Настройка API-пользователей в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

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

Новинка в fortinet.fortios 2.0.0

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

Описание

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

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается через графический интерфейс 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"`
system_api_user dictionary	Настроить пользователей API.
accprofile string	Профиль доступа администратора. Источник system.accprofile.name.
api_key string	Пароль администратора.
comments string	Комментарий.
cors_allow_origin string	Значение для Access-Control-Allow-Origin в ответах API. Избегайте использования “*”, если возможно.
name string / required	Имя пользователя.
peer_auth string	Включить/отключить проверку подлинности узла. Варианты: `"enable"` `"disable"`
peer_group string	Имя группы узлов.
schedule string	Имя расписания.
trusthost list / elements=dictionary	Доверенный узел.
id integer / required	ID. см. <a href=’#notes’>Примечания</a>.
ipv4_trusthost string	IPv4-адрес доверенного узла.
ipv6_trusthost string	IPv6-адрес доверенного узла.
type string	Тип доверенного узла. Варианты: `"ipv4-trusthost"` `"ipv6-trusthost"`
vdom list / elements=dictionary	Виртуальные домены.
name string / required	Имя виртуального домена. Источник system.vdom.name.
vdom string	Виртуальный домен, среди тех, которые были определены ранее. Vdom - это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure API users.
  fortinet.fortios.fortios_system_api_user:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_api_user:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          api_key: "<your_own_value>"
          comments: "<your_own_value>"
          cors_allow_origin: "<your_own_value>"
          name: "default_name_7"
          peer_auth: "enable"
          peer_group: "<your_own_value>"
          schedule: "<your_own_value>"
          trusthost:
              -
                  id: "12"
                  ipv4_trusthost: "myhostname"
                  ipv6_trusthost: "myhostname"
                  type: "ipv4-trusthost"
          vdom:
              -
                  name: "default_name_17 (source system.vdom.name)"

Значения возврата

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

Ключ	Описание
build строка	Номер сборки изображения fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, полученный от FortiGate после последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый в последнем запросе к FortiGate Возвращается: успешно Пример: `"id"`
name строка	Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер версии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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_system_api_user_module.html