модуль fortinet.fortios.fortios_firewall_ssh_local_key – локальные ключи SSH-прокси в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_firewall_ssh_local_key.

Добавлено в fortinet.fortios 2.0.0

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

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции firewall_ssh и категории local_key. В примерах приведены все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием. Проверено с FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_ssh_local_key словарь	Локальные ключи SSH-прокси.
name строка / обязательный	Имя локального ключа SSH-прокси.
password строка	Пароль для закрытого ключа SSH.
private_key строка	Закрытый ключ SSH-прокси, зашифрованный паролем.
public_key строка	Открытый ключ SSH-прокси.
source строка	Тип источника локального ключа SSH-прокси. Варианты: `"built-in"` `"user"`
member_path строка	Путь к атрибуту элемента, для которого выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path предназначен для выполнения операций с элементами.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков предпочтительно использовать httpapi
Модуль поддерживает check_mode.

Примеры

- name: SSH proxy local keys.
  fortinet.fortios.fortios_firewall_ssh_local_key:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_ssh_local_key:
          name: "default_name_3"
          password: "<your_own_value>"
          private_key: "<your_own_value>"
          public_key: "<your_own_value>"
          source: "built-in"

Возвращаемые значения

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

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, возвращенный FortiGate для последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey строка	Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успехе Пример: `"id"`
name строка	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Результат операции Возвращается: всегда Пример: `"success"`
vdom строка	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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_firewall_ssh_local_key_module.html