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

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

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

Обзор

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

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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 -		По умолчанию: "Общие"	Раздел устройства для управления ресурсами.
password - / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, установив переменную среды `F5_PASSWORD`. Псевдонимы: pass, pwd
port -			Указывает порт для назначения ловушки. Этот параметр актуален только тогда, когда `version` равно `v1`, или `v2c`. Если `version` имеет другое значение, этот параметр игнорируется.
provider - добавлено в 2.5		По умолчанию: null	Объект 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 - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: 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 -			Указывает имя пользователя, которому нужно предоставить доступ к SNMP v3 MIB. Этот параметр актуален только тогда, когда `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 boolean добавлен в 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.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
Требуется версия ПО 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
    password: secret
    server: lb.mydomain.com
    state: present
    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
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

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

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

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

Ключ	Возвращаемое значение	Описание
param1 boolean	changed	Новое значение param1 ресурса. Пример: True
param2 строка	changed	Новое значение param2 ресурса. Пример: Foo is bar

Статус

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

Авторы

Tim Rupp (@caphrim007)

Подсказка

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

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