Модуль fortinet.fortimanager.fmgr_dvmdb_metafields_adom — Метаданные базы данных менеджера устройств adom

Примечание

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

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

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

Для использования в playbook, укажите: fortinet.fortimanager.fmgr_dvmdb_metafields_adom.

Новая функция в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation булево	Устанавливается в значение True только при несовпадении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dvmdb_metafields_adom словарь	Настройка параметров верхнего уровня.
importance строка	Важность. Варианты: `"optional"` `"required"`
length целое число	Длина.
name строка	Имя.
status строка	Статус. Варианты: `"disable"` `"enable"`
enable_log булево	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с токеном доступа к forticloud API.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых выполнение будет прервано.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых выполнение будет завершено успешно.
workspace_locking_adom строка	Adom для блокировки в режиме работы FortiManager в пространстве работы. Значение может быть глобальным или другим, включая корневой.
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 помогают в этом.
Обычно выполнение модуля может завершиться ошибкой при возвращении ненулевого значения rc. Вы также можете переопределить условия для ошибки или успешного завершения с параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Device manager database meta fields adom
      fortinet.fortimanager.fmgr_dvmdb_metafields_adom:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        dvmdb_metafields_adom:
          importance: <value in [optional, required]>
          length: <integer>
          name: <string>
          status: <value in [disable, enable]>

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

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_dvmdb_metafields_adom_module.html