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

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

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

f5-sdk >= 3.0.9

Параметры

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

validate_certs bool (added in 2.0)		Choices: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами лично, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, если переменная среды `F5_VALIDATE_CERTS` установлена.
version		Choices: 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.

Примеры

- 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 bool	changed	Новое значение параметра param1 ресурса. Пример: True
param2 string	changed	Новое значение параметра param2 ресурса. Пример: Foo is bar

Статус

Данный модуль помечен как preview, что означает, что его интерфейс не гарантированно будет обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом 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.6/modules/bigip_snmp_community_module.html