fortios_system_api_user – Настройка API-пользователей в FortiOS и FortiGate Fortinet

Новая версия 2.8.

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

Обзор

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

Требования

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

fortiosapi>=0.9.8

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
host - / обязательно				IP-адрес FortiOS или FortiGate.
https boolean			Варианты: no yes ←	Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password -			По умолчанию: ""	Пароль FortiOS или FortiGate.
system_api_user -			По умолчанию: null	Настройка API-пользователей.
	accprofile -			Профиль доступа администратора. Имя профиля доступа из системы.
	api-key -			Пароль администратора.
	comments -			Комментарий.
	cors-allow-origin -			Значение для Access-Control-Allow-Origin в ответах API. Избегайте использования '*' если возможно.
	name - / обязательно			Имя пользователя.
	peer-auth -		Варианты: enable disable	Включить/выключить проверку подлинности peer.
	peer-group -			Имя группы peer.
	schedule -			Имя расписания.
	state -		Варианты: present absent	Указывает, нужно ли создать или удалить объект
	trusthost -			Trusthost.
		id - / обязательно		Идентификатор таблицы.
		ipv4-trusthost -		Адрес доверенного узла IPv4.
		ipv6-trusthost -		Адрес доверенного узла IPv6.
		type -	Варианты: ipv4-trusthost ipv6-trusthost	Тип доверенного узла.
	vdom -			Виртуальные домены.
		name - / обязательно		Имя виртуального домена. Имя виртуального домена из системы.
username - / обязательно				Имя пользователя FortiOS или FortiGate.
vdom -			По умолчанию: "root"	Виртуальный домен, среди ранее определенных. ВД - это виртуальная инстанция FortiGate, которая может быть настроена и использоваться как отдельная единица.

Примечания

Примечание

Требуется библиотека fortiosapi, разработанная Fortinet
Выполняется как локальное действие в вашем плане

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure API users.
    fortios_system_api_user:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      system_api_user:
        state: "present"
        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: "<your_own_value>"
            ipv6-trusthost: "<your_own_value>"
            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 строка	всегда	Указание результата операции Пример: успех
vdom строка	всегда	Используемый виртуальный домен Пример: root
version строка	всегда	Версия FortiGate Пример: v5.6.3

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [предварительный просмотр]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_system_api_user_module.html