Модуль fortinet.fortimanager.fmgr_system_docker — Docker хост.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation логическое | Устанавливается в значение True только в случае расхождений схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список rc-кодов, по которым будет переопределён условие завершения с ошибкой. |
rc_succeeded список / элементы=целое число | Список rc-кодов, по которым будет переопределён условие завершения успешно. |
system_docker словарь | Параметры верхнего уровня. |
|
cpu целое число |
CPU. |
|
default_address_pool_base строка |
Устарело, переименуйте на default_address_pool_base. Установка CIDR для базового пула адресов. |
|
default_address_pool_size целое число |
Устарело, переименуйте на default_address_pool_size. Установка размера базового пула адресов. |
|
docker_user_login_max целое число |
Устарело, переименуйте на docker_user_login_max. Максимальное количество сеансов входа для пользователей Docker. |
|
fortiaiops строка |
Включить/выключить контейнер. disable - Выключить. enable - Включить. Варианты:
|
|
fortiauthenticator строка |
Включить/выключить контейнер. disable - Выключить. enable - Включить. Варианты:
|
|
fortiportal строка |
Включить/выключить контейнер. disable - Выключить. enable - Включить. Варианты:
|
|
fortisigconverter строка |
Включить/выключить контейнер. disable - Выключить. enable - Включить. Варианты:
|
|
fortisoar строка |
Включить/выключить контейнер. disable - Выключить. enable - Включить. Варианты:
|
|
fortiwlm строка |
Включить/выключить контейнер. disable - Выключить. enable - Включить. Варианты:
|
|
fsmcollector строка |
Включить/выключить контейнер. disable - Выключить. enable - Включить. Варианты:
|
|
mem целое число |
Максимальное использование оперативной памяти (%). |
|
policyanalyzer string |
Включить/отключить контейнер. disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
sdwancontroller string |
Включить/отключить контейнер. disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
status string |
Включить и настроить репозиторий. disable - Отключить службу docker хоста. enable - Включить репозиторий производства. qa - Включить репозиторий QA тестирования. dev - Включить репозиторий QA тестирования Варианты:
|
|
universalconnector string |
Включить/отключить контейнер. disable - Отключить настройку. enable - Включить настройку. Варианты:
|
workspace_locking_adom string | ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Docker host.
fortinet.fortimanager.fmgr_system_docker:
# 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, ...]
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 словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный запрашиваемый URL. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на коллекции
© 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_docker_module.html
