Модуль fortinet.fortimanager.fmgr_firewall_address6_subnetsegment – сегменты подсети IPv6.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook, укажите: fortinet.fortimanager.fmgr_firewall_address6_subnetsegment.
Новое в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
address6 string / required | Параметр (address6) в запрошенном URL. |
adom string / required | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
firewall_address6_subnetsegment dictionary | Набор параметров верхнего уровня. |
|
name string / required |
Имя. |
|
type string |
Тип сегмента подсети. Варианты:
|
|
value string |
Значение сегмента подсети. |
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, с которыми будут переопределены условия неудачи. |
rc_succeeded list / elements=integer | Список кодов rc, с которыми будут переопределены условия успеха. |
state string / required | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom string | ADOM для блокировки для FortiManager, работающего в режиме рабочей области; значение может быть global и другими, включая root. |
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 помогают в этом.
- Для создания или обновления объекта используйте директиву 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: IPv6 subnet segments.
fortinet.fortimanager.fmgr_firewall_address6_subnetsegment:
bypass_validation: false
adom: ansible
address6: "ansible-test" # name
state: present
firewall_address6_subnetsegment:
name: "ansible-test"
type: specific # <value in [any, specific]>
value: "ansible"
- 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 the subnet segments in the IPv6 address
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_address6_subnetsegment"
params:
adom: "ansible"
address6: "ansible-test" # name
subnet-segment: "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_address6_subnetsegment_module.html