Модуль fortinet.fortimanager.fmgr_system_admin_user_metadata – Настройка метаданных.

Примечание

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

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

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

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

Добавлен в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль может настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить для источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое значение	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, по которым будет переопределено условие ошибки.
rc_succeeded список / элементы=целое число	Список rc-кодов, по которым будет переопределено условие успеха.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_admin_user_metadata словарь	Установленные параметры верхнего уровня.
fieldlength целое число	Длина поля.
fieldname строка / обязательно	Имя поля.
fieldvalue строка	Значение поля.
importance строка	Важность. необязательно - Это поле необязательно. обязательно - Это поле обязательно. Варианты: `"optional"` `"required"`
status строка	Статус. disabled - Это поле отключено. enabled - Это поле включено. Варианты: `"disabled"` `"enabled"`
user строка / обязательно	Параметр (user) в запрошенном URL.
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют имя с использованием подчёркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов всё ещё доступны, но вы будете получать предупреждения о устаревании. Вы можете игнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой код rc. Вы также можете переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure meta data.
      fortinet.fortimanager.fmgr_system_admin_user_metadata:
        bypass_validation: true
        user: ansible-test # userid
        state: present
        system_admin_user_metadata:
          fieldlength: 50
          fieldname: Contact Address
          fieldvalue: "ansible@fortinet.com"
          importance: optional # <value in [optional, required]>
          status: enabled # <value in [disabled, enabled]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the meta data of user
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_user_metadata"
          params:
            user: "ansible-test" # userid
            meta-data: "your_value"

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 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/fortimanager/fmgr_system_admin_user_metadata_module.html