Модуль f5networks.f5_modules.bigip_snmp_community — управление сообществами SNMP на BIG-IP.

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_snmp_community.

Добавлено в f5networks.f5_modules 1.0.0

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

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

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

Параметры

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

Примечания

Примечание

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

Авторы

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

Ссылки на коллекцию

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