Модуль fortinet.fortios.fortios_system_external_resource — Настройка внешнего ресурса в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: fortinet.fortios.fortios_system_external_resource.
Добавлена в 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 строка / обязательно | Указывает, создавать или удалять объект. Варианты:
|
system_external_resource словарь | Настройка внешнего ресурса. |
|
category целое число |
Категория ресурса пользователя. |
|
comments строка |
Комментарий. |
|
interface строка |
Укажите исходящий интерфейс для подключения к серверу. Source system.interface.name. |
|
interface_select_method строка |
Укажите, как выбрать исходящий интерфейс для подключения к серверу. Варианты:
|
|
name строка / обязательно |
Имя внешнего ресурса. |
|
password строка |
Пароль HTTP базовой аутентификации. |
|
refresh_rate целое число |
Интервал времени для обновления внешнего ресурса (1-43200 мин). |
|
resource строка |
URL внешнего ресурса. |
|
server_identity_check строка |
Опция проверки сертификата сервера. Варианты:
|
|
source_ip строка |
Источник IPv4-адреса, используемого для связи с сервером. |
|
status строка |
Включить/выключить ресурс пользователя. Варианты:
|
|
type строка |
Тип ресурса пользователя. Варианты:
|
|
update_method строка |
Метод обновления внешнего ресурса. Варианты:
|
|
user_agent строка |
Заголовок HTTP User-Agent. |
|
username строка |
Имя пользователя HTTP базовой аутентификации. |
|
uuid string |
Универсально уникальный идентификатор (UUID; назначается автоматически, но может быть сброшен вручную). |
vdom string | Виртуальный домен, среди тех, которые были определены ранее. vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. Default: |
Примечания
Примечание
- Устаревший fortiosapi был объявлен устаревшим, httpapi — предпочтительный способ запуска playbook'ов
- Модуль поддерживает check_mode.
Примеры
- name: Configure external resource.
fortinet.fortios.fortios_system_external_resource:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_external_resource:
category: "0"
comments: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
name: "default_name_7"
password: "<your_own_value>"
refresh_rate: "5"
resource: "<your_own_value>"
server_identity_check: "none"
source_ip: "84.230.14.43"
status: "enable"
type: "category"
update_method: "feed"
user_agent: "<your_own_value>"
username: "<your_own_value>"
uuid: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method string | Последний метод, используемый для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при последней применённой операции Возвращается: всегда Пример: |
mkey string | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: |
name string | Название таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Указание результата операции Возвращается: всегда Пример: |
vdom string | Использованный виртуальный домен Возвращается: всегда Пример: |
version string | Версия 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_system_external_resource_module.html