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

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

Для использования в книге задач укажите: fortinet.fortios.fortios_system_api_user.

Новое в версии 2.8: модуля fortinet.fortios

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

Описание

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

Требования

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

ansible>=2.9.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
access_token строка				Аутентификация на основе токенов. Сгенерировано из графического интерфейса Fortigate.
state строка добавлено в 2.9 модуля fortinet.fortios			Варианты: present absent	Указывает, нужно ли создать или удалить объект. Этот атрибут уже был присутствует в предыдущей версии на более глубоком уровне. Он был перенесен на этот внешний уровень.
system_api_user словарь				Настройка API-пользователей.
	accprofile строка			Профиль доступа администратора. Имя из системного 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 список / элементы=строка			Trusthost.
		id целое число / обязательно		Идентификатор таблицы.
		ipv4_trusthost строка		Адрес IPv4 доверенного хоста.
		ipv6_trusthost строка		Адрес IPv6 доверенного хоста.
		type строка	Варианты: ipv4-trusthost ipv6-trusthost	Тип Trusthost.
	vdom список / элементы=строка			Виртуальные домены.
		name строка / обязательно		Имя виртуального домена. Имя из системного vdom.
vdom строка			Значение по умолчанию: "root"	Виртуальный домен среди тех, которые были определены ранее. Vdom — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство.

Примечания

Примечание

Устаревший fortiosapi устарел, httpapi — предпочтительный способ запуска playbook'ов

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure API users.
    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: "<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

Авторы

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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_api_user_module.html