fortinet.fortimanager.fmgr_system_csf_trustedlist модуль — Предварительно авторизованные и заблокированные узлы Fabric безопасности.
Примечание
Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.0).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook укажите: fortinet.fortimanager.fmgr_system_csf_trustedlist.
Новая функция в fortinet.fortimanager 2.3.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, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
system_csf_trustedlist словарь | Настройки верхнего уровня. |
|
action строка |
Действие авторизации Security Fabric. accept - Принять запрос на авторизацию. deny - Отклонить запрос на авторизацию. Варианты:
|
|
authorization_type строка |
Устарело, пожалуйста, переименуйте на authorization_type. Тип авторизации. serial - Проверить по серийному номеру. certificate - Проверить по сертификату. Варианты:
|
|
certificate строка |
Сертификат. |
|
downstream_authorization строка |
Устарело, пожалуйста, переименуйте на downstream_authorization. Доверие к авторизациям администратора этого узла. disable - Отключить авторизацию по нисходящей. enable - Включить авторизацию по нисходящей. Варианты:
|
|
ha_members строка |
Устарело, пожалуйста, переименуйте на ha_members. Участники HA. |
|
index целое число |
Индекс нисходящего узла в дереве. |
|
name строка / обязательно |
Имя. |
|
serial строка |
Серийный номер. |
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 помогают в выполнении этой задачи.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код 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: Pre-authorized and blocked security fabric nodes.
fortinet.fortimanager.fmgr_system_csf_trustedlist:
# 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, ...]
state: present # <value in [present, absent]>
system_csf_trustedlist:
action: <value in [accept, deny]>
authorization_type: <value in [serial, certificate]>
certificate: <string>
downstream_authorization: <value in [disable, enable]>
ha_members: <string>
index: <integer>
name: <string>
serial: <string>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
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_system_csf_trustedlist_module.html
