Модуль fortinet.fortimanager.fmgr_devprof_system_centralmanagement_serverlist — Дополнительные серверы, которые FortiGate может использовать для обновлений

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_devprof_system_centralmanagement_serverlist.

Новое в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательно	Параметр (devprof) в запрошенном URL.
devprof_system_centralmanagement_serverlist словарь	Установленные параметры верхнего уровня.
addr-type строка	Устарело, пожалуйста, переименуйте на addr_type. Указывает, использует ли FortiGate для связи с сервером-заменой I… Варианты: `"fqdn"` `"ipv4"` `"ipv6"`
fqdn строка	FQDN-адрес сервера-замены.
id целое число / обязательно	Идентификатор.
server-address строка	Устарело, пожалуйста, переименуйте на server_address. IPv4-адрес сервера-замены.
server-address6 строка	Устарело, пожалуйста, переименуйте на server_address6. IPv6-адрес сервера-замены.
server-type список / элементы=строка	Устарело, пожалуйста, переименуйте на server_type. Тип службы FortiGuard. Варианты: `"update"` `"rating"` `"iot-query"` `"iot-collect"` `"vpatch-query"`
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"`
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: Additional severs that the FortiGate can use for updates (for AV, IPS, updates) and ratings (for web filter and antispam ratings) servers.
      fortinet.fortimanager.fmgr_devprof_system_centralmanagement_serverlist:
        adom: ansible
        devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
        state: present
        devprof_system_centralmanagement_serverlist:
          addr-type: ipv4
          id: 1
          server-address: "222.222.211.111"
          server-type:
            - update
            - rating

- 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 servers under system template
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "devprof_system_centralmanagement_serverlist"
          params:
            adom: "ansible"
            devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
            server-list: "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_devprof_system_centralmanagement_serverlist_module.html