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

Новая в версии 2.6.

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Краткое описание

Помогает управлять сообществами 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"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
port целое число			Указывает порт для назначения ловушки. Этот параметр актуален только когда `version` равно `v1`, или `v2c`. Если `version` отличается, этот параметр игнорируется.
provider словарь добавлено в 2.5			Объект типа dict, содержащий данные подключения.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает SSH ключ, используемый для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов типа cli. Этот параметр можно опустить, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
server строка / обязательно			Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
server_port целое число добавлено в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
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` общности, этот параметр обязателен. Этот параметр нельзя изменить после его установки.

источник строка		Указывает адрес источника для доступа к MIB. Этот параметр может принимать значение `all`. Если этот параметр не указан, используется значение `all`. Этот параметр актуален только тогда, когда `version` равно `v1`, или `v2c`. Если `version` другое, этот параметр игнорируется. Если `source` установлено в `all`, то указать `oid` невозможно. Это вызовет ошибку. Этот параметр необходимо указывать, когда `state` равно `absent`, чтобы правильно удалить сообщество. Чтобы удалить сообщество SNMP `public`, которое поставляется с BIG-IP, этот параметр должен быть установлен в значение `default`.
состояние строка	Варианты: present ← absent	При значении `present`, гарантирует, что список адресов и записи существуют. При значении `absent`, гарантирует удаление списка адресов.
update_password строка	Варианты: always ← on_create	`always` позволит обновлять пароли, если пользователь это выберет. `on_create` будет устанавливать пароль только для вновь созданных ресурсов.
пользователь строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную окружения `F5_USER`.
validate_certs логическое значение добавлено в 2.0	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты. Этот параметр можно опустить, установив переменную окружения `F5_VALIDATE_CERTS`.
версия строка	Варианты: v1 v2c ← v3	Указывает, к какой версии Simple Network Management Protocol (SNMP) относится пункт назначения ловушки.

Примечания

Примечание

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

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

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

Ключ	Возвращаемое значение	Описание
доступ строка	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
источник строка	changed	Новый адрес источника для доступа к MIB. Пример: 1.1.1.1

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицирован]

Авторы

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

Подсказка

Если вы заметите проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_snmp_community_module.html