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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_devprof_system_snmp_user.

Новое в fortinet.fortimanager 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательно	Параметр (devprof) в запрошенном URL.
devprof_system_snmp_user словарь	Установленные параметры верхнего уровня.
auth_proto строка	Устарело, пожалуйста, переименуйте на auth_proto. Протокол аутентификации. Варианты: `"md5"` `"sha"` `"sha224"` `"sha256"` `"sha384"` `"sha512"`
auth_pwd любой тип	(список) Устарело, пожалуйста, переименуйте на auth_pwd. Пароль для протокола аутентификации.
events список / элементы=строка	SNMP уведомления Варианты: `"cpu-high"` `"mem-low"` `"log-full"` `"intf-ip"` `"vpn-tun-up"` `"vpn-tun-down"` `"ha-switch"` `"fm-conf-change"` `"ips-signature"` `"ips-anomaly"` `"temperature-high"` `"voltage-alert"` `"av-virus"` `"av-oversize"` `"av-pattern"` `"av-fragmented"` `"ha-hb-failure"` `"fan-failure"` `"ha-member-up"` `"ha-member-down"` `"ent-conf-change"` `"av-conserve"` `"av-bypass"` `"av-oversize-passed"` `"av-oversize-blocked"` `"ips-pkg-update"` `"fm-if-change"` `"power-supply-failure"` `"amc-bypass"` `"faz-disconnect"` `"bgp-established"` `"bgp-backward-transition"` `"wc-ap-up"` `"wc-ap-down"` `"fswctl-session-up"` `"fswctl-session-down"` `"ips-fail-open"` `"load-balance-real-server-down"` `"device-new"` `"enter-intf-bypass"` `"exit-intf-bypass"` `"per-cpu-high"` `"power-blade-down"` `"confsync_failure"` `"dhcp"` `"pool-usage"` `"power-redundancy-degrade"` `"power-redundancy-failure"` `"ospf-nbr-state-change"` `"ospf-virtnbr-state-change"` `"disk-failure"` `"disk-overload"` `"faz-main-failover"` `"faz-alt-failover"` `"slbc"` `"faz"` `"power-supply"` `"ippool"` `"interface"`
ha_direct строка	Устарело, пожалуйста, переименуйте на ha_direct. Включение/выключение прямого управления участниками кластера HA. Варианты: `"disable"` `"enable"`
interface любой тип	(список) Укажите исходящий интерфейс для достижения сервера.
interface_select_method строка	Устарело, пожалуйста, переименуйте на interface_select_method. Укажите способ выбора исходящего интерфейса для достижения сервера. Варианты: `"auto"` `"sdwan"` `"specify"`
mib_view строка	Устарело, пожалуйста, переименуйте на mib_view. Просмотр MIB для контроля доступа SNMP.
name строка / обязательно	Имя пользователя SNMP.
notify_hosts любой тип	(список) Устарело, пожалуйста, переименуйте на notify_hosts. SNMP менеджеры для отправки уведомлений
notify_hosts6 строка	Устарело, пожалуйста, переименуйте на notify_hosts6. IPv6 SNMP менеджеры для отправки уведомлений
priv_proto строка	Устарело, пожалуйста, переименуйте на priv_proto. Конфиденциальность Варианты: `"aes"` `"des"` `"aes256"` `"aes256cisco"`
priv_pwd любой тип	(список) Устарело, пожалуйста, переименуйте на priv_pwd. Пароль для конфиденциальности

END_OF_DOCUMENT_MARKER

queries string	Включить/выключить запросы SNMP для этого пользователя. Варианты: `"disable"` `"enable"`
query-port integer	Устарело, пожалуйста, переименуйте его на query_port. Порт запросов SNMPv3
security-level string	Устарело, пожалуйста, переименуйте его на security_level. Уровень безопасности для аутентификации и шифрования сообщений. Варианты: `"no-auth-no-priv"` `"auth-no-priv"` `"auth-priv"`
source-ip string	Устарело, пожалуйста, переименуйте его на source_ip. Истоковый IP-адрес для SNMP-ловушки.
source-ipv6 string	Устарело, пожалуйста, переименуйте его на source_ipv6. Истоковый IPv6-адрес для SNMP-ловушки.
status string	Включить/выключить этого пользователя SNMP. Варианты: `"disable"` `"enable"`
trap-lport integer	Устарело, пожалуйста, переименуйте его на trap_lport. Локальный порт SNMPv3 ловушки
trap-rport integer	Устарело, пожалуйста, переименуйте его на trap_rport. Удаленный порт SNMPv3 ловушки
trap-status string	Устарело, пожалуйста, переименуйте его на trap_status. Включить/выключить ловушки для этого пользователя SNMP. Варианты: `"disable"` `"enable"`
vdoms any	(список) VDOMы контроля доступа SNMP.
enable_log boolean	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентифицировать Ansible-клиент с токеном доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список rc-кодов, при которых условия будут считаться как условие сбоя.
rc_succeeded list / elements=integer	Список rc-кодов, при которых условия будут считаться как условие успеха.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки, используемый FortiManager в режиме рабочей области. Значение может быть глобальным и другими, включая корневой.
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_devprof_system_snmp_user:
        bypass_validation: false
        adom: ansible
        devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
        state: present
        devprof_system_snmp_user:
          auth-proto: md5
          auth-pwd: "fortinet"
          events:
            - cpu-high
            - mem-low
            - log-full
            - intf-ip
            - vpn-tun-up
            - vpn-tun-down
            - ha-switch
            - fm-conf-change
            - ips-signature
            - ips-anomaly
            - temperature-high
            - voltage-alert
            - av-virus
            - av-oversize
            - av-pattern
            - av-fragmented
            - ha-hb-failure
            - fan-failure
            - ha-member-up
            - ha-member-down
            - ent-conf-change
            - av-conserve
            - av-bypass
            - av-oversize-passed
            - av-oversize-blocked
            - ips-pkg-update
            - fm-if-change
            - power-supply-failure
            - amc-bypass
            - faz-disconnect
            - bgp-established
            - bgp-backward-transition
            - wc-ap-up
            - wc-ap-down
            - fswctl-session-up
            - fswctl-session-down
            - ips-fail-open
            - load-balance-real-server-down
            - device-new
            - enter-intf-bypass
            - exit-intf-bypass
            - per-cpu-high
            - power-blade-down
            - confsync_failure
          ha-direct: disable
          name: "ansible-test"

- 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 scripts
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "devprof_system_snmp_user"
          params:
            adom: "ansible"
            devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
            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_devprof_system_snmp_user_module.html