Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_system_snmp_community — настройка сообщества SNMP.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_system_snmp_community.

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

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

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"

system_snmp_community

dictionary

Параметры верхнего уровня.

events

list / elements=string

События SNMP trap.

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"

hosts

list / elements=dictionary

Узлы.

id

integer

Идентификатор записи узла.

interface

string

Разрешенное имя интерфейса.

ip

string

Разрешенный IP-адрес узла.

hosts6

list / elements=dictionary

Узлы IPv6.

id

integer

Идентификатор записи узла.

interface

string

Разрешенное имя интерфейса.

ip

string

Разрешенный IP-адрес узла.

id

integer / обязательный

Идентификатор сообщества.

name

string

Имя сообщества.

query_v1_port

integer

Порт запросов SNMP v1.

query_v1_status

string

Включить или отключить запросы SNMP v1.

disable — отключить настройку.

enable — включить настройку.

Варианты:

  • "disable"
  • "enable"

query_v2c_port

integer

Порт запросов SNMP v2c.

query_v2c_status

string

Включить или отключить запросы SNMP v2c.

disable — отключить настройку.

enable — включить настройку.

Варианты:

  • "disable"
  • "enable"

status

string

Включить или отключить сообщество.

disable — отключить настройку.

enable — включить настройку.

Варианты:

  • "disable"
  • "enable"

trap_v1_rport

integer

Удаленный порт trap SNMP v1.

trap_v1_status

string

Включить или отключить trap SNMP v1.

disable — отключить настройку.

enable — включить настройку.

Варианты:

  • "disable"
  • "enable"

trap_v2c_rport

integer

Удаленный порт trap SNMP v2c.

trap_v2c_status

string

Включить или отключить trap SNMP v2c.

disable — отключить настройку.

enable — включить настройку.

Варианты:

  • "disable"
  • "enable"

workspace_locking_adom

string

ADOM для блокировки в FortiManager, работающем в режиме рабочей области. Значением может быть global или другой ADOM, включая 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.
  • Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия, при которых выполнение считается неудачным или успешным, можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP community configuration.
      fortinet.fortimanager.fmgr_system_snmp_community:
        bypass_validation: false
        state: present
        system_snmp_community:
          id: 1
          name: ansible-test-snmp
          status: disable

- 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 communities
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_snmp_community"
          params:
            community: "your_value"

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_snmp_community_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API