f5networks.f5_modules.bigip_snmp_community модуль — Управление сообществами SNMP на BIG-IP.

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

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

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

Чтобы использовать её в книге задач, укажите: f5networks.f5_modules.bigip_snmp_community.

Добавлена в f5networks.f5_modules 1.0.0

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

Обзор

Помогает управлять сообществами Simple Network Management Protocol (SNMP) на системе BIG-IP. Данный модуль поддерживает различные версии SNMP. Обратите внимание на разные параметры, предлагаемые этим модулем, так как различные параметры работают для различных версий SNMP. Это важно, если вы смешиваете версии v2c и 3.

Параметры

Параметр	Комментарии
access строка	Указывает уровень доступа пользователя к MIB. При создании новой общности, если этот параметр не указан, значение по умолчанию — `ro`. Если значение `ro`, то пользователь может просматривать MIB, но не может её изменять. Если значение `rw`, то пользователь может просматривать и изменять MIB. Варианты: `"ro"` `"rw"` `"read-only"` `"read-write"`
community строка	Указывает строку сообщества (пароль) для доступа к MIB. Этот параметр актуален только тогда, когда `version` имеет значение `v1` или `v2c`. Если `version` другое, этот параметр игнорируется.
ip_version строка	Указывает, к адресам какой версии IP относится запись (IPv4 или IPv6). При создании новой общности, если значение не указано, используется значение по умолчанию `4`. Этот параметр актуален только тогда, когда `version` имеет значение `v1` или `v2c`. Если `version` другое, этот параметр игнорируется. Варианты: `"4"` `"6"`
name строка	Имя, идентифицирующее SNMP-сообщество. Если `version` имеет значение `v1` или `v2c`, этот параметр обязателен. Имя `public` зарезервировано на BIG-IP. Этот модуль обрабатывает это имя иначе, чем другие. Функционально, различий вы не заметите.
oid строка	Указывает идентификатор объекта (OID) для записи. Если `version` имеет значение `v3`, этот параметр обязателен. Если `version` имеет значение `v1` или `v2c`, если это значение указано, то `source` не должно быть установлено в `all`.
partition строка	Раздел устройства для управления ресурсами. Значение по умолчанию: `"Common"`
port целое число	Указывает порт для назначения ловушки. Этот параметр актуален только тогда, когда `version` имеет значение `v1` или `v2c`. Если `version` другое, этот параметр игнорируется.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр фактически используется при работе с устройствами BIG-IQ.
no_f5_teem логическое	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как её название вызывало путаницу. Варианты: `false` ← (значение по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учетной записи пользователя для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server строка / обязательный	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. Значение по умолчанию: `443`
timeout целое число	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
transport строка	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (значение по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен обладать административными привилегиями на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.

validate_certs boolean	Если `no`, сертификаты SSL не будут проверены. Используйте этот параметр только на сайтах, контролируемых вами, которые используют самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
snmp_auth_password string	Указывает пароль для пользователя. При создании новой SNMP `v3` сообщества этот параметр обязателен. Это значение должно быть не менее 8 символов.
snmp_auth_protocol string	Указывает метод аутентификации для пользователя. Когда `md5`, указывает, что система использует алгоритм MD5 для аутентификации пользователя. Когда `sha`, указывает использование алгоритма безопасного хеширования (SHA) для аутентификации пользователя. Когда `none`, указывает, что аутентификация не требуется. При создании новой SNMP `v3` сообщества, если этот параметр не указан, значение по умолчанию — `sha`. Варианты: `"md5"` `"sha"` `"none"`
snmp_privacy_password string	Указывает пароль для пользователя. При создании новой SNMP `v3` сообщества этот параметр обязателен. Это значение должно быть не менее 8 символов.
snmp_privacy_protocol string	Указывает протокол шифрования. Когда `aes`, система шифрует информацию пользователя с помощью AES (Advanced Encryption Standard). Когда `des`, система шифрует информацию пользователя с помощью DES (Data Encryption Standard). Когда `none`, система не шифрует информацию пользователя. При создании новой SNMP `v3` сообщества, если этот параметр не указан, значение по умолчанию — `aes`. Варианты: `"aes"` `"des"` `"none"`
snmp_username string	Указывает имя пользователя, которому нужно предоставить доступ к SNMP v3 MIB. Этот параметр актуален только когда `version` имеет значение `v3`. Если `version` другое, этот параметр игнорируется. При создании новой SNMP `v3` сообщества этот параметр обязателен. Этот параметр нельзя изменить после его установки.
source string	Указывает исходный адрес для доступа к MIB. Этот параметр может принимать значение `all`. Если этот параметр не указан, значение по умолчанию — `all`. Этот параметр актуален только когда `version` имеет значение `v1` или `v2c`. Если `version` другое, этот параметр игнорируется. Если `source` установлено в `all`, нельзя указать `oid`. Это вызовет ошибку. Вы должны указать этот параметр, когда `state` равно `absent`, чтобы корректно удалить сообщество. Для удаления `public` SNMP-сообщества, которое поставляется с BIG-IP, этот параметр должен быть `default`.
state string	При значении `present`, гарантирует существование списка и записей адресов. При значении `absent`, гарантирует удаление списка адресов. Варианты: `"present"` ← (по умолчанию) `"absent"`
update_password string	`always` позволяет пользователям обновлять пароли. `on_create` только устанавливает пароль для вновь созданных ресурсов. Варианты: `"always"` ← (по умолчанию) `"on_create"`
version string	Указывает SNMP-версию, к которой относится трафик назначения. Варианты: `"v1"` `"v2c"` ← (по умолчанию) `"v3"`

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы гарантировать сохранение специфичной для BIG-IP конфигурации в диске, убедитесь, что включен хотя бы один этап, использующий модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create an SMNP v2c read-only community
  bigip_snmp_community:
    name: foo
    version: v2c
    source: all
    oid: .1
    access: ro
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create an SMNP v3 read-write community
  bigip_snmp_community:
    name: foo
    version: v3
    snmp_username: foo
    snmp_auth_protocol: sha
    snmp_auth_password: secret
    snmp_privacy_protocol: aes
    snmp_privacy_password: secret
    oid: .1
    access: rw
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove the default 'public' SNMP community
  bigip_snmp_community:
    name: public
    source: default
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Значения возврата

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

Ключ	Описание
access строка	Новый уровень доступа к MIB. Возвращается: changed Пример: `"ro"`
community строка	Новое значение сообщества. Возвращается: changed Пример: `"community1"`
ip_version строка	Новое значение версии IP. Возвращается: changed Пример: `"0.1"`
oid строка	Новое значение OID. Возвращается: changed Пример: `"0.1"`
snmp_auth_password строка	Новый пароль для данного snmp_username. Возвращается: changed Пример: `"secret1"`
snmp_auth_protocol строка	Новый протокол SNMP аутентификации. Возвращается: changed Пример: `"sha"`
snmp_privacy_password строка	Новый пароль для данного snmp_username. Возвращается: changed Пример: `"secret2"`
snmp_privacy_protocol строка	Новый протокол конфиденциальности SNMP. Возвращается: changed Пример: `"aes"`
snmp_username строка	Новое имя пользователя SNMP. Возвращается: changed Пример: `"user1"`
source строка	Новый адрес источника для доступа к MIB. Возвращается: changed Пример: `"1.1.1.1"`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

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

© 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/f5networks/f5_modules/bigip_snmp_community_module.html