Модуль fortinet.fortimanager.fmgr_firewall_schedule_group – Настройка группы расписаний.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_schedule_group.

Впервые в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_schedule_group словарь	Устанавливаются параметры верхнего уровня.
color целое число	Цвет значка на графическом интерфейсе.
fabric_object строка	Устарело, пожалуйста, переименуйте на fabric_object. Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
global_object целое число	Устарело, пожалуйста, переименуйте на global_object. Глобальный объект.
member любой тип	(список или строка) Расписания, добавленные в группу расписаний.
name строка / обязательно	Имя группы расписаний.
uuid строка	Универсальный уникальный идентификатор
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	Область, которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным или другим, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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: Schedule group configuration.
      fortinet.fortimanager.fmgr_firewall_schedule_group:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_schedule_group:
          color: 1
          member: "none"
          name: "ansible-test"

- 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 schedule groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_schedule_group"
          params:
            adom: "ansible"
            group: "your_value"

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_firewall_schedule_group_module.html