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 строка		По умолчанию: "Общая"	Раздел устройства для управления ресурсами.
port целое число			Указывает порт для назначения ловушки. Этот параметр актуален только когда `version` равно `v1`, или `v2c`. Если `version` имеет другое значение, этот параметр игнорируется.
provider словарь добавлено в 2.5			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	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 целое число		Указывает тайм-аут в секундах для взаимодействия с сетевым устройством при подключении или отправке команд. Если тайм-аут истечет до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli 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 строка			Указывает имя пользователя, которому вы хотите предоставить доступ к SNMP v3 MIB. Этот параметр актуален только когда `version` равно `v3`. Если `version` имеет другое значение, этот параметр игнорируется. При создании новой SNMP `v3` общности, этот параметр обязателен. Этот параметр нельзя изменить после его установки.
source строка			Указывает исходный адрес для доступа к MIB. Этот параметр может принимать значение `all`. Если этот параметр не указан, используется значение `all`. Этот параметр актуален только когда `version` равно `v1`, или `v2c`. Если `version` имеет другое значение, этот параметр игнорируется. Если `source` установлено в `all`, то указать `oid` невозможно. Это вызовет ошибку. Этот параметр должен быть указан при `state` равно `absent`, чтобы удалить соответствующую общность. Для удаления `public` SNMP общности, которая поставляется с BIG-IP, этот параметр должен быть установлен на `default`.

состояние строка	Варианты: текущее ← отсутствует	При `present`, гарантирует, что список адресов и записи существуют. При `absent`, гарантирует удаление списка адресов.
update_password строка	Варианты: всегда ← при_создании	`always` позволит обновить пароли, если пользователь этого пожелает. `on_create` будет устанавливать пароль только для вновь созданных ресурсов.
версия строка	Варианты: 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

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

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

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