Модуль fortinet.fortios.fortios_switch_controller_initial_config_template — настройка шаблона для автоматически создаваемых VLAN в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_switch_controller_initial_config_template.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции switch_controller_initial_config и категории шаблонов. В примерах приведены все параметры; перед использованием необходимо настроить значения в соответствии с источниками данных. Проверено на FOS v6.0.0
Требования
На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate. |
enable_log логическое значение | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр, отмеченный как member_path, можно использовать для выполнения операции над элементом. |
member_state строка | Добавить или удалить элемент по указанному пути атрибута. Если указан member_state, параметр state игнорируется. Варианты:
|
state строка / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
switch_controller_initial_config_template словарь | Настройка шаблона для автоматически создаваемых VLAN. |
|
allowaccess список / элементы=строка |
Разрешённые типы административного доступа к этому интерфейсу. Варианты:
|
|
auto_ip строка |
Автоматически назначать адрес интерфейса и блок подсети. Варианты:
|
|
dhcp_server строка |
Включить или отключить DHCP-сервер на этом интерфейсе. Варианты:
|
|
ip строка |
IPv4-адрес интерфейса и маска подсети. |
|
name строка / обязательный |
Имя шаблона начальной конфигурации. |
|
vlanid целое число |
Уникальный идентификатор VLAN. |
vdom строка | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Configure template for auto-generated VLANs.
fortinet.fortios.fortios_switch_controller_initial_config_template:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_initial_config_template:
allowaccess: "ping"
auto_ip: "enable"
dhcp_server: "enable"
ip: "<your_own_value>"
name: "default_name_7"
vlanid: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method строка | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: |
name строка | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Результат выполнения операции Возвращается: всегда Пример: |
vdom строка | Использованный виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_initial_config_template_module.html