fortinet.fortimanager.fmgr_system_snmp_user модуль — Настройка пользователя SNMP.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_system_snmp_user.

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

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

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое значение	Устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для завершения с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успешного завершения.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_snmp_user словарь	Настройка верхнего уровня параметров.
auth-proto строка	Устарело, пожалуйста, переименуйте на auth_proto. Протокол аутентификации. md5 - протокол аутентификации HMAC-MD5-96. sha - протокол аутентификации HMAC-SHA-96. Варианты: `"md5"` `"sha"` `"sha224"` `"sha256"` `"sha384"` `"sha512"`
auth-pwd любой тип	(список) Устарело, пожалуйста, переименуйте на auth_pwd. Пароль для протокола аутентификации.
events список / элементы=строка	SNMP уведомления disk_low - Слишком высокое использование диска. ha_switch - Переключение HA. intf_ip_chg - Изменен IP-адрес интерфейса. sys_reboot - Перезагрузка системы. cpu_high - Слишком высокое использование процессора. mem_low - Низкий объем доступной памяти. log-alert - Сообщение об оповещении журнала. log-rate - Обнаружена высокая скорость входящих журналов. log-data-rate - Обнаружена высокая скорость входящих данных журналов. lic-gbday - Обнаружено высокое количество лицензионных журналов ГБ/день. lic-dev-quota - Обнаружено высокое количество лицензионных квот устройств. cpu-high-exclude-nice - Использование ЦП за исключением порога NICE. Варианты: `"disk_low"` `"ha_switch"` `"intf_ip_chg"` `"sys_reboot"` `"cpu_high"` `"mem_low"` `"log-alert"` `"log-rate"` `"log-data-rate"` `"lic-gbday"` `"lic-dev-quota"` `"cpu-high-exclude-nice"`
name строка / обязательно	Имя пользователя SNMP.
notify-hosts строка	Устарело, пожалуйста, переименуйте на notify_hosts. Хосты для отправки уведомлений
notify-hosts6 строка	Устарело, пожалуйста, переименуйте на notify_hosts6. IPv6 хосты для отправки уведомлений
priv-proto строка	Устарело, пожалуйста, переименуйте на priv_proto. Конфиденциальность aes - симметричный протокол шифрования CFB128-AES-128. des - симметричный протокол шифрования CBC-DES. Варианты: `"aes"` `"des"` `"aes256"` `"aes256cisco"`
priv-pwd любой тип	(список) Устарело, пожалуйста, переименуйте на priv_pwd. Пароль для конфиденциальности
queries строка	Включить/выключить запросы для этого пользователя. disable - Выключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`

query-port integer	Устаревшее, пожалуйста, переименуйте на query_port. Порт запроса SNMPv3.
security-level string	Устаревшее, пожалуйста, переименуйте на security_level. Уровень безопасности для проверки подлинности и шифрования сообщений. no-auth-no-priv - Сообщение без проверки подлинности и без конфиденциальности auth-no-priv - Сообщение с проверкой подлинности, но без конфиденциальности auth-priv - Сообщение с проверкой подлинности и конфиденциальностью Варианты: `"no-auth-no-priv"` `"auth-no-priv"` `"auth-priv"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют именование с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы будете получать предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнить эту работу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачей, когда возвращается ненулевой rc. Вы также можете переопределить условия для завершения неудачей или успехом с параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP user configuration.
      fortinet.fortimanager.fmgr_system_snmp_user:
        bypass_validation: false
        state: present
        system_snmp_user:
          auth-proto: md5 # <value in [md5, sha]>
          auth-pwd: fortinet
          events:
            - disk_low
            - ha_switch
            - intf_ip_chg
            - sys_reboot
            - cpu_high
            - mem_low
            - log-alert
            - log-rate
            - log-data-rate
            - lic-gbday
            - lic-dev-quota
            - cpu-high-exclude-nice
          name: ansible-test-snmpuser
          queries: disable
          security-level: no-auth-no-priv # <value in [no-auth-no-priv, auth-no-priv, auth-priv]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the SNMP users
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_snmp_user"
          params:
            user: "your_value"

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 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/fortimanager/fmgr_system_snmp_user_module.html