Модуль fortinet.fortios.fortios_user_device_group — Настройка групп устройств в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля потребуются дополнительные требования, см. Требования для подробностей.
Чтобы использовать его в книге задач, укажите: fortinet.fortios.fortios_user_device_group.
Новая функция в fortinet.fortios 2.0.0
Описание
- Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять категорию функций пользователя и групп устройств. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерирована из графического интерфейса Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для работы. Разделяется символом косой черты, если атрибутов более одного. Параметр, помеченный member_path, является законным для выполнения операции члена. |
member_state строка | Добавить или удалить члена по указанному пути атрибута. Когда указан member_state, опция state игнорируется. Варианты:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Варианты:
|
user_device_group словарь | Настройка групп устройств. |
|
comment строка |
Комментарий. |
|
member список / элементы=словарь |
Член группы устройств. |
|
name строка / обязательно |
Имя устройства. Источник user.device.alias user.device-category.name. |
|
name строка / обязательно |
Имя группы устройств. |
|
tagging список / элементы=словарь |
Тегирование объекта конфигурации. |
|
category строка |
Категория тега. Источник system.object-tagging.category. |
|
name строка / обязательно |
Имя записи тегирования. |
|
tags список / элементы=словарь |
Теги. |
|
name строка / обязательно |
Имя тега. Источник system.object-tagging.tags.name. |
vdom строка | Виртуальная область, среди тех, которые определены ранее. VDOM — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельную единицу. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi устарел, httpapi — предпочтительный способ выполнения книг задач
- Модуль поддерживает режим проверки.
Примеры
- name: Configure device groups.
fortinet.fortios.fortios_user_device_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_device_group:
comment: "Comment."
member:
-
name: "default_name_5 (source user.device.alias user.device-category.name)"
name: "default_name_6"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_9"
tags:
-
name: "default_name_11 (source system.object-tagging.tags.name)"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, использованный для предоставления контента в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate после последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем запросе к FortiGate Возвращается: успешно Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_user_device_group_module.html