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

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

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

Описание

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

Требования

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

fortiosapi>=0.9.8

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
host строка				IP-адрес FortiOS или FortiGate.
https логический			Варианты: no yes ←	Указывает, следует ли использовать протокол HTTPS при запросах к FortiGate.
password строка			Значение по умолчанию: ""	Пароль FortiOS или FortiGate.
ssl_verify логический добавлено в 2.9			Варианты: no yes ←	Обеспечивает проверку сертификата FortiGate надлежащим центром сертификации.
state строка добавлено в 2.9			Варианты: present absent	Указывает, необходимо ли создать или удалить объект. Этот атрибут уже был в предыдущей версии на более глубоком уровне. Он был перемещен на этот внешний уровень.
system_api_user словарь			Значение по умолчанию: null	Настройка API-пользователей.
	accprofile строка			Профиль доступа администратора. Имя из source system.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	Устарело Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' на верхнем уровне. Указывает, необходимо ли создать или удалить объект.
	trusthost список			Доверенный хост.
		id целое число / обязательно		Идентификатор таблицы.
		ipv4_trusthost строка		Адрес IPv4 доверенного хоста.
		ipv6_trusthost строка		Адрес IPv6 доверенного хоста.
		type строка	Варианты: ipv4-trusthost ipv6-trusthost	Тип доверенного хоста.
	vdom список			Виртуальные домены.
		name строка / обязательно		Имя виртуального домена. Имя из source system.vdom.
username строка				Имя пользователя FortiOS или FortiGate.
vdom строка			Значение по умолчанию: "root"	Виртуальный домен, среди тех, что определены ранее. Vdom — это виртуальная инстанция FortiGate, которая может быть настроена и использоваться как отдельное устройство.

Примечания

Примечание

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

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure API users.
    fortios_system_api_user:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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: "<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. [community]

Авторы

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.9/modules/fortios_system_api_user_module.html