f5networks.f5_modules.bigip_snmp_community – Управляет сообществами SNMP на BIG-IP.

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_snmp_community.

Новое в версии 1.0.0: модуля f5networks.f5_modules

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access строка		Варианты: ro rw только для чтения для чтения и записи	Устанавливает уровень доступа пользователя к MIB. При создании новой общности, если этот параметр не указан, значение по умолчанию — `ro`. В случае `ro`, пользователь может просматривать MIB, но не может её изменять. В случае `rw`, пользователь может просматривать и изменять MIB.
community строка			Указывает строку общности (пароль) для доступа к MIB. Этот параметр имеет значение только при `version`, равном `v1` или `v2c`. Если `version` имеет другое значение, этот параметр игнорируется.
ip_version строка		Варианты: 4 6	Указывает, относится ли запись к адресам IPv4 или IPv6. При создании новой общности, если это значение не указано, по умолчанию используется `4`. Этот параметр имеет значение только при `version`, равном `v1` или `v2c`. Если `version` имеет другое значение, этот параметр игнорируется.
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 словарь добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий сведения о подключении.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную окружения `F5_TEEM`.
	password строка / обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное подключение для использования при подключении к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs логическое	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
snmp_auth_password строка			Указывает пароль пользователя. При создании новой SNMP `v3` общности, этот параметр обязателен. Это значение должно быть не менее 8 символов.
snmp_auth_protocol строка		Варианты: md5 sha none	Указывает метод аутентификации пользователя. При `md5`, система использует алгоритм MD5 для аутентификации пользователя. При `sha`, используется алгоритм безопасного хэширования (SHA) для аутентификации пользователя. При `none`, аутентификация пользователя не требуется. При создании новой SNMP `v3` общности, если этот параметр не указан, по умолчанию используется `sha`.
snmp_privacy_password строка			Указывает пароль пользователя. При создании новой SNMP `v3` общности, этот параметр обязателен. Это значение должно быть не менее 8 символов.
snmp_privacy_protocol строка		Варианты: aes des none	Указывает протокол шифрования. При `aes`, система шифрует информацию пользователя с помощью AES (Advanced Encryption Standard). При `des`, система шифрует информацию пользователя с помощью DES (Data Encryption Standard). При `none`, система не шифрует информацию пользователя. При создании новой SNMP `v3` общности, если этот параметр не указан, по умолчанию используется `aes`.
snmp_username строка			Указывает имя пользователя, которому предоставляется доступ к MIB SNMP v3. Этот параметр имеет значение только при `version`, равном `v3`. Если `version` имеет другое значение, этот параметр игнорируется. При создании новой SNMP `v3` общности, этот параметр обязателен. Этот параметр нельзя изменить после его установки.
source строка			Указывает исходный адрес для доступа к MIB. Этот параметр может принимать значение `all`. Если этот параметр не указан, значение — `all`. Этот параметр имеет значение только при `version`, равном `v1` или `v2c`. Если `version` имеет другое значение, этот параметр игнорируется. Если `source` установлено в значение `all`, невозможно указать `oid`. Это вызовет ошибку. Вы должны указать этот параметр, когда `state` равно `absent`, чтобы правильно удалить сообщество. Для удаления `public` SNMP сообщества, которое поставляется с BIG-IP, этот параметр должен быть `default`.
state строка		Варианты: present ← absent	При `present`, гарантирует, что список адресов и записи существуют. При `absent`, гарантирует удаление списка адресов.
update_password строка		Варианты: always ← on_create	`always` позволяет пользователям обновлять пароли. `on_create` устанавливает пароль только для вновь созданных ресурсов.
version строка		Варианты: v1 v2c ← v3	Указывает, к какой версии SNMP относится назначение ловушки.

Примечания

Примечание

Дополнительную информацию об использовании 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 строка	changed	Новый уровень доступа к MIB. Пример: ro
community строка	changed	Новое значение сообщества. Пример: community1
ip_version строка	changed	Новое значение версии IP. Пример: 0.1
oid строка	changed	Новое значение OID. Пример: 0.1
snmp_auth_password строка	changed	Новый пароль для данного snmp_username. Пример: secret1
snmp_auth_protocol строка	changed	Новый протокол SNMP-аутентификации. Пример: sha
snmp_privacy_password строка	changed	Новый пароль для данного snmp_username. Пример: secret2
snmp_privacy_protocol строка	changed	Новый протокол конфиденциальности SNMP. Пример: aes
snmp_username строка	changed	Новое имя пользователя SNMP. Пример: user1
source строка	changed	Новый адрес источника для доступа к MIB. Пример: 1.1.1.1

Авторы

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_snmp_community_module.html