Spec-Zone.ru › Ansible

Модуль hitachivantara.vspone_block.vsp.hv_snmp_settings — управление настройками SNMP в блочных системах хранения данных VSP.

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).

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

Для установки используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.vsp.hv_snmp_settings.

Добавлено в hitachivantara.vspone_block 4.0.0

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

Обзор

  • Этот модуль позволяет настраивать параметры SNMP (Simple Network Management Protocol, простой протокол сетевого управления) в блочных системах хранения данных VSP, в том числе включение агента, версии SNMP, адресаты ловушек, аутентификацию и сведения о системной группе.
  • Пример использования см. по ссылке https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/snmp_settings.yml

Требования

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

  • python >= 3.8

Параметры

Параметр

Комментарии

connection_info

словарь / обязательный

Сведения, необходимые для установления соединения с системой хранения данных.

address

строка / обязательный

IP-адрес или имя хоста системы хранения данных.

api_token

строка

Токен для работы с заблокированными ресурсами.

password

строка

Пароль для аутентификации. Это обязательное поле.

username

строка

Имя пользователя для аутентификации. Это обязательное поле.

spec

словарь

Спецификация параметров SNMP.

is_snmp_agent_enabled

логическое значение / обязательный

Указывает, включен ли агент SNMP. Обязателен для задач «Указание адресатов уведомлений об ошибках SNMP для версии v2c», «Указание адресатов уведомлений об ошибках SNMP для версии v3» и «Отключение агента SNMP».

Возможные значения:

  • false
  • true

snmp_v1v2c_authentication_settings

список / элементы=словарь

Параметры аутентификации SNMP v1/v2c. Обязательны для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v2c».

community

строка / обязательный

Строка сообщества SNMP. Обязательна для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v2c».

requests_permitted

список / элементы=строка / обязательный

Список разрешенных запросов. Обязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v2c».

snmp_v1v2c_trap_destination_settings

список / элементы=словарь

Параметры адресатов ловушек SNMP v1/v2c. Обязательны для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v2c».

community

строка / обязательный

Строка сообщества SNMP. Обязательна для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v2c».

send_trap_to

список / элементы=строка / обязательный

Список адресов назначения ловушек. Обязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v2c».

snmp_v3_authentication_settings

список / элементы=словарь

Параметры аутентификации SNMP v3. Обязательны для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

authentication

словарь

Параметры аутентификации SNMP v3. Необязательны для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

encryption

словарь

Параметры шифрования. Необязательны для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

key

строка

Ключ шифрования. Необязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

protocol

строка

Протокол шифрования. Необязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

Возможные значения:

  • "AES"
  • "DES"

password

строка

Пароль аутентификации. Необязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

protocol

строка

Протокол аутентификации. Необязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

Возможные значения:

  • "MD5"
  • "SHA"

user_name

строка / обязательный

Имя пользователя SNMP v3. Обязательно для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

snmp_v3_trap_destination_settings

список / элементы=словарь

Параметры адресатов ловушек SNMP v3. Обязательны для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

authentication

словарь

Параметры аутентификации SNMP v3. Необязательны для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

encryption

словарь

Параметры шифрования. Необязательны для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

key

строка

Ключ шифрования. Необязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

protocol

строка

Протокол шифрования. Необязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

Возможные значения:

  • "AES"
  • "DES"

password

строка

Пароль аутентификации. Необязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

protocol

строка

Протокол аутентификации. Необязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

Возможные значения:

  • "MD5"
  • "SHA"

send_trap_to

строка / обязательный

Адрес назначения ловушки. Обязателен для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

user_name

строка / обязательный

Имя пользователя SNMP v3. Обязательно для задачи «Указание адресатов уведомлений об ошибках SNMP для версии v3».

snmp_version

строка / обязательный

Используемая версия SNMP. Обязательна для задач «Указание адресатов уведомлений об ошибках SNMP для версии v2c», «Указание адресатов уведомлений об ошибках SNMP для версии v3» и «Отключение агента SNMP».

Возможные значения:

  • "v1"
  • "v2c"
  • "v3"

system_group_information

словарь / обязательный

Сведения о системной группе. Обязательны для задач «Указание адресатов уведомлений об ошибках SNMP для версии v2c», «Указание адресатов уведомлений об ошибках SNMP для версии v3» и «Отключение агента SNMP».

contact

строка / обязательный

Контактная информация. Обязательна для задач «Указание адресатов уведомлений об ошибках SNMP для версии v2c», «Указание адресатов уведомлений об ошибках SNMP для версии v3» и «Отключение агента SNMP».

location

строка / обязательный

Сведения о местоположении. Обязательны для задач «Указание адресатов уведомлений об ошибках SNMP для версии v2c», «Указание адресатов уведомлений об ошибках SNMP для версии v3» и «Отключение агента SNMP».

storage_system_name

строка / обязательный

Имя системы хранения данных. Обязательно для задач «Указание адресатов уведомлений об ошибках SNMP для версии v2c», «Указание адресатов уведомлений об ошибках SNMP для версии v3» и «Отключение агента SNMP».

state

строка

Требуемое состояние параметров SNMP.

Возможные значения:

  • "present" ← (по умолчанию)
  • "test"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: нет

Определяет, должен ли модуль работать в режиме проверки.

Примечания

Примечание

  • Тип подключения gateway удален начиная с версии 3.4.0. Если вам требуется этот тип подключения, используйте более раннюю версию.
  • Отправка тестовой ловушки SNMP
    1. Отправляет тестовую ловушку SNMP, чтобы проверить правильность настройки отчетов об ошибках SIM для менеджера SNMP. Если какие-либо ресурсы целевой системы хранения данных заблокированы через REST API, выполнить эту задачу невозможно. Прежде чем продолжить, разблокируйте эти ресурсы.

Примеры

- name: Configure SNMP settings on Hitachi Vantara storage system
  hitachivantara.vspone_block.vsp.hv_snmp_settings:
    connection_info:
      address: 192.0.2.10
      username: admin
      password: secret
    spec:
      is_snmp_agent_enabled: true
      snmp_version: "v2c"
      snmp_v1v2c_trap_destination_settings:
        - community: "public"
          send_trap_to:
            - "203.0.113.1"
            - "203.0.113.2"
      snmp_v1v2c_authentication_settings:
        - community: "public"
          requests_permitted:
            - "get"
            - "set"
      system_group_information:
        storage_system_name: "VSP-Block-01"
        contact: "admin@datacenter.com"
        location: "Data Center 1"

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

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

Ключ

Описание

snmp_settings

словарь

Сведения о конфигурации SNMP.

Возвращается: всегда

is_snmp_agent_enabled

логическое значение

Включён ли агент SNMP в системе хранения данных.

Возвращается: при успешном выполнении

Пример: true

request_authentication_setting

словарь

Параметры аутентификации запросов SNMP.

Возвращается: при успешном выполнении

snmpv1v2c_settings

список / элементы=словарь

Параметры аутентификации SNMPv1/v2c.

Возвращается: при успешном выполнении

community

строка

Строка сообщества SNMP.

Возвращается: при успешном выполнении

Пример: "public"

requests_permitted

список / элементы=строка

Список IP-адресов, с которых разрешены запросы.

Возвращается: при успешном выполнении

Пример: ["192.168.1.0/24", "10.0.0.0/8"]

snmpv3_settings

список / элементы=словарь

Параметры аутентификации SNMPv3.

Возвращается: при успешном выполнении

authentication

словарь

Конфигурация аутентификации.

Возвращается: при успешном выполнении

encryption

словарь

Параметры шифрования.

Возвращается: при успешном выполнении

key

строка

Ключ шифрования.

Возвращается: при успешном выполнении

Пример: "encryptionKey456"

protocol

строка

Протокол шифрования.

Возвращается: при успешном выполнении

Пример: "AES"

password

строка

Пароль аутентификации.

Возвращается: при успешном выполнении

Пример: "CHANGE_ME_SET_YOUR_PASSWORD"

protocol

строка

Протокол аутентификации.

Возвращается: при успешном выполнении

Пример: "SHA"

send_trap_to

строка

IP-адрес для отправки уведомлений.

Возвращается: при успешном выполнении

Пример: "192.168.1.100"

user_name

строка

Имя пользователя SNMPv3.

Возвращается: при успешном выполнении

Пример: "snmpv3user"

sending_trap_setting

словарь

Параметры конфигурации SNMP-уведомлений.

Возвращается: при успешном выполнении

snmpv1v2c_settings

список / элементы=словарь

Параметры SNMP-уведомлений SNMPv1/v2c.

Возвращается: при успешном выполнении

community

строка

Строка сообщества SNMP.

Возвращается: при успешном выполнении

Пример: "public"

send_trap_to

список / элементы=строка

Список IP-адресов для отправки уведомлений.

Возвращается: при успешном выполнении

Пример: ["172.25.37.79", "203.0.113.21"]

snmpv3_settings

список / элементы=словарь

Параметры SNMP-уведомлений SNMPv3.

Возвращается: при успешном выполнении

authentication

словарь

Конфигурация аутентификации.

Возвращается: при успешном выполнении

encryption

словарь

Параметры шифрования.

Возвращается: при успешном выполнении

key

строка

Ключ шифрования.

Возвращается: при успешном выполнении

Пример: "trapEncKey321"

protocol

строка

Протокол шифрования.

Возвращается: при успешном выполнении

Пример: "AES"

password

строка

Пароль аутентификации.

Возвращается: при успешном выполнении

Пример: "CHANGE_ME_SET_YOUR_PASSWORD"

protocol

строка

Протокол аутентификации.

Возвращается: при успешном выполнении

Пример: "SHA"

send_trap_to

строка

IP-адрес для отправки уведомлений.

Возвращается: при успешном выполнении

Пример: "192.168.1.200"

user_name

строка

Имя пользователя SNMPv3.

Возвращается: при успешном выполнении

Пример: "trapuser"

snmp_engine_id

строка

Идентификатор SNMP-движка системы хранения данных.

Возвращается: при успешном выполнении

Пример: "0x80001f88043636326431396163"

snmp_version

строка

Версия SNMP, настроенная в системе.

Возвращается: при успешном выполнении

Пример: "v2c"

system_group_information

словарь

Сведения о системной группе SNMP.

Возвращается: при успешном выполнении

contact

строка

Контактная информация системы.

Возвращается: при успешном выполнении

Пример: "admin@hitachivantara.com"

location

строка

Физическое расположение системы.

Возвращается: при успешном выполнении

Пример: "SC Data Center 1"

storage_system_name

строка

Имя системы хранения данных.

Возвращается: при успешном выполнении

Пример: "VSP-Block-45-102"

Авторы

  • Hitachi Vantara LTD (@hitachi-vantara)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/hitachivantara/vspone_block/vsp.hv_snmp_settings_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API