Модуль fortinet.fortios.fortios_switch_controller_snmp_user – глобальная настройка пользователей SNMP v3 FortiSwitch в 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_snmp_user.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Токен создается в графическом интерфейсе Fortigate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов несколько, они разделяются косой чертой. Параметр с пометкой member_path предназначен для выполнения операций с элементами.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
switch_controller_snmp_user словарь	Глобальная настройка пользователей SNMP v3 FortiSwitch.
auth_proto строка	Протокол аутентификации. Варианты: `"md5"` `"sha1"` `"sha224"` `"sha256"` `"sha384"` `"sha512"` `"sha"`
auth_pwd строка	Пароль для протокола аутентификации.
name строка / обязательный	Имя пользователя SNMP.
priv_proto строка	Протокол обеспечения конфиденциальности (шифрования). Варианты: `"aes128"` `"aes192"` `"aes192c"` `"aes256"` `"aes256c"` `"des"` `"aes"`
priv_pwd строка	Пароль для протокола обеспечения конфиденциальности (шифрования).
queries строка	Включить или отключить SNMP-запросы для этого пользователя. Варианты: `"disable"` `"enable"`
query_port целое число	Порт запросов SNMPv3.
security_level строка	Уровень безопасности для аутентификации и шифрования сообщений. Варианты: `"no-auth-no-priv"` `"auth-no-priv"` `"auth-priv"`
vdom строка	Виртуальный домен из ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure FortiSwitch SNMP v3 users globally.
  fortinet.fortios.fortios_switch_controller_snmp_user:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_snmp_user:
          auth_proto: "md5"
          auth_pwd: "<your_own_value>"
          name: "default_name_5"
          priv_proto: "aes128"
          priv_pwd: "<your_own_value>"
          queries: "disable"
          query_port: "161"
          security_level: "no-auth-no-priv"

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

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

Ключ	Описание
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_switch_controller_snmp_user_module.html