Модуль fortinet.fortimanager.fmgr_firewall_addrgrp6_dynamicmapping — Настройка групп адресов IPv6.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_addrgrp6_dynamicmapping.
Добавлен в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль способен настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить, используя источники данных, прежде чем использовать их.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
addrgrp6 строка / обязательно | Параметр (addrgrp6) в запрошенном URL. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжает выполняться без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_addrgrp6_dynamicmapping словарь | Установленные параметры верхнего уровня. |
|
_image-base64 строка |
Устарело, пожалуйста, переименуйте на _image_base64. Изображение base64. |
|
_scope список / элементы=словарь |
Область. |
|
name строка |
Имя. |
rc_failed список / элементы=целое число | Список кодов rc, при которых условия будут игнорироваться. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых условия будут выполняться. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure dynamic mappings of IPv6 address group
fortinet.fortimanager.fmgr_firewall_addrgrp6_dynamicmapping:
bypass_validation: false
adom: ansible
addrgrp6: "ansible-addrgrp6" # name
state: present
firewall_addrgrp6_dynamicmapping:
_scope:
- name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
color: 22
comment: "ansible-test-comment"
member: "ansible-test"
visibility: enable
- 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 dynamic mappings of IPv6 address group
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_addrgrp6_dynamicmapping"
params:
adom: "ansible"
addrgrp6: "ansible-addrgrp6" # name
dynamic_mapping: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
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_firewall_addrgrp6_dynamicmapping_module.html