Модуль fortinet.fortimanager.fmgr_application_list_entries_parameters — Параметры приложений.

Примечание

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

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

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

Чтобы использовать в книге задач, укажите: fortinet.fortimanager.fmgr_application_list_entries_parameters.

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
application_list_entries_parameters словарь	Параметры верхнего уровня.
id целое число / обязательно	Идентификатор параметра.
members список / элементы=словарь	Члены.
id целое число	Параметр.
name строка	Имя параметра.
value строка	Значение параметра.
value строка	Значение параметра.
bypass_validation логическое значение	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
entries строка / обязательно	Параметр (entries) в запрошенном URL.
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
list строка / обязательно	Параметр (list) в запрошенном URL.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия завершения задачи с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия успешного выполнения задачи.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_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 помогают в этом.
Для создания или обновления объекта используйте директиву 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: Application parameters.
      fortinet.fortimanager.fmgr_application_list_entries_parameters:
        adom: ansible
        list: "ansible-test" # name
        entries: "1" # id
        state: present
        application_list_entries_parameters:
          id: 1
          value: "ansible-test-parameter2"

- 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 parameters in the application list entry
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "application_list_entries_parameters"
          params:
            adom: "ansible"
            list: "ansible-test" # name
            entries: "1" # id
            parameters: "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_application_list_entries_parameters_module.html