fortinet.fortimanager.fmgr_securityconsole_package_clone модуль — Клонирование пакета политики внутри одного ADOM.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версии 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook укажите: fortinet.fortimanager.fmgr_securityconsole_package_clone.
Новая функция в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation логическое значение | Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager. Модуль продолжит выполнение без проверки параметров. Выборавз:
|
enable_log логическое значение | Включение/отключение ведения журнала для задачи. Выборавз:
|
forticloud_access_token строка | Авторизация Ansible-клиента с помощью токена доступа к API forticloud. |
rc_failed список / элементы=целое число | Список кодов rc, при которых выполнение будет завершено с ошибкой. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых выполнение будет завершено успешно. |
securityconsole_package_clone словарь | Установленные параметры верхнего уровня. |
|
adom строка |
Имя исходного ADOM. |
|
dst_name строка |
Имя нового пакета политики. |
|
dst_parent строка |
Путь к папке для целевого пакета. |
|
pkg строка |
Путь и имя исходного пакета. |
|
scope список / элементы=словарь |
Область действия. |
|
name строка |
Имя. |
|
vdom строка |
Vdom. |
workspace_locking_adom строка | ADOM для блокировки при работе FortiManager в режиме рабочего пространства. Значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Clone a policy package within the same ADOM.
fortinet.fortimanager.fmgr_securityconsole_package_clone:
# 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, ...]
securityconsole_package_clone:
adom: <string>
dst_name: <string>
dst_parent: <string>
pkg: <string>
scope:
-
name: <string>
vdom: <string>
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_securityconsole_package_clone_module.html