модуль fortinet.fortimanager.fmgr_system_docker — хост Docker.

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True, только если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
system_docker dictionary	Набор параметров верхнего уровня.
cpu integer	Процессор.
default_address_pool_base псевдонимы: default-address-pool_base string	Задать CIDR для default-address-pool.
default_address_pool_size псевдонимы: default-address-pool_size integer	Задать размер default-address-pool.
docker_user_login_max псевдонимы: docker-user-login-max integer	Максимальное число сеансов входа для пользователей Docker.
fortiaiops string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
fortiauthenticator string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
fortiportal string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
fortisigconverter string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
fortisoar string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
fortiwlm string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
fsmcollector string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
mem integer	Максимальное использование ОЗУ в процентах.
policyanalyzer string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
sdwancontroller string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
status string	Включить и задать реестр. disable — отключить службу хоста Docker. enable — включить производственный реестр. qa — включить тестовый реестр QA. dev — включить тестовый реестр QA Варианты: `"disable"` `"enable"` `"qa"` `"dev"`
universalconnector string	Включить или отключить контейнер. disable — отключить настройку. enable — включить настройку. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое имя, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: `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
  gather_facts: false
  tasks:
    - name: Docker host.
      fortinet.fortimanager.fmgr_system_docker:
        # workspace_locking_adom: <global or your adom name>
        system_docker:
          # fortiportal: <value in [disable, enable]>
          # fortiwlm: <value in [disable, enable]>
          # sdwancontroller: <value in [disable, enable]>
          # status: <value in [disable, enable, qa, ...]>
          # cpu: <integer>
          # default_address_pool_base: <string>
          # default_address_pool_size: <integer>
          # fortiauthenticator: <value in [disable, enable]>
          # fortisigconverter: <value in [disable, enable]>
          # mem: <integer>
          # docker_user_login_max: <integer>
          # fortisoar: <value in [disable, enable]>
          # fortiaiops: <value in [disable, enable]>
          # policyanalyzer: <value in [disable, enable]>
          # universalconnector: <value in [disable, enable]>
          # fsmcollector: <value in [disable, enable]>

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_docker_module.html