Spec-Zone.ru › Ansible

Модуль cisco.intersight.intersight_snmp_policy — настройка политики SNMP для Cisco Intersight

Примечание

Этот модуль входит в коллекцию cisco.intersight (версия 2.18.0).

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

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

Чтобы использовать её в плейбуке, укажите: cisco.intersight.intersight_snmp_policy.

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

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

  • Управляет настройкой политики SNMP в Cisco Intersight.
  • Политика для настройки параметров SNMP на серверах, управляемых Cisco Intersight.
  • Поддерживает конфигурации SNMPv2c и SNMPv3 с пользователями, ловушками и строками сообщества.
  • Дополнительную информацию см. в документации Cisco Intersight.

Параметры

Параметр

Комментарии

access_community_string

string

Имя сообщества SNMPv1 или SNMPv2c либо имя пользователя SNMPv3 по умолчанию, включаемое в сообщения ловушек, отправляемые на узел SNMP.

Длина имени может составлять до 32 символов.

Используется только для доступа по SNMPv2c.

api_key_id

string / обязательный

Идентификатор открытого API-ключа, связанного с закрытым ключом.

Если значение не задано, используется значение переменной среды INTERSIGHT_API_KEY_ID.

api_private_key

path / обязательный

Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM, используемого для аутентификации в API Intersight.

Если используется строка, для шифрования её данных следует использовать Ansible Vault.

Например: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY-----

<your private key data>

-----END EC PRIVATE KEY-----’

Если значение не задано, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY.

api_uri

string

URI для доступа к API Intersight.

Если значение не задано, используется значение переменной среды INTERSIGHT_API_URI.

По умолчанию: "https://intersight.com/api/v1"

community_access

string

Управляет доступом к информации в таблицах инвентаризации.

Применимо только для пользователей SNMPv2c.

Для SNMPv3 всегда задаётся значение Disabled.

Для SNMPv2c допустимы значения Disabled, Limited и Full.

Обязательно, если enabled имеет значение true.

Допустимые значения:

  • "Disabled" ← (по умолчанию)
  • "Limited"
  • "Full"

description

псевдонимы: descr

string

Описание политики SNMP, заданное пользователем.

Описание может содержать буквы (a–z, A–Z), цифры (0–9), дефис (-), точку (.), двоеточие (:) или символ подчёркивания (_).

enabled

boolean

Состояние политики SNMP на конечной точке.

Если политика включена, конечная точка отправляет SNMP-ловушки на указанный узел.

Допустимые значения:

  • false
  • true ← (по умолчанию)

engine_input_id

string

Задаваемый пользователем уникальный идентификатор статического движка.

Используется только для SNMPv3.

name

string / обязательный

Имя, присвоенное политике SNMP.

Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.

organization

string

Имя организации, которой назначен этот ресурс.

Профили, политики и пулы, созданные в пользовательской организации, применимы только к устройствам в этой же организации.

По умолчанию: "default"

snmp_port

integer

Порт, на котором работает агент SNMP Cisco IMC. Введите значение от 1 до 65535.

Зарезервированные порты использовать нельзя (22, 23, 80, 123, 389, 443, 623, 636, 2068, 3268, 3269).

По умолчанию: 161

snmp_traps

list / elements=dictionary

Список адресатов SNMP-ловушек.

community

string

Группа сообщества SNMP, используемая для отправки SNMP-ловушек на другие устройства.

Применимо только для SNMP v2c.

destination

string / обязательный

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

enabled

boolean

Включает или отключает ловушку на сервере. Если она включена, ловушка активна на сервере.

Допустимые значения:

  • false
  • true ← (по умолчанию)

port

integer

Номер порта для адресата ловушек.

По умолчанию: 162

type

string

Тип ловушки, определяющий, следует ли получать уведомление при получении ловушки адресатом.

Обратите внимание: «Inform» поддерживается только для ловушек V2, ловушки V3 поддерживают только тип «Trap».

Допустимые значения:

  • "Trap" ← (по умолчанию)
  • "Inform"

user

string

Пользователь SNMP для ловушки.

Применимо только для SNMPv3.

version

string / обязательный

Версия SNMP для ловушки.

Допустимые значения:

  • "V2"
  • "V3"

snmp_users

list / elements=dictionary

Список пользователей SNMP для аутентификации SNMPv3.

auth_password

string / обязательный

Пароль авторизации пользователя.

Обязательно, если security_level имеет значение AuthPriv или AuthNoPriv.

name

string / обязательный

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

Длина должна составлять от 1 до 31 символа.

privacy_password

string

Пароль конфиденциальности пользователя SNMP.

Обязательно, если security_level имеет значение AuthPriv.

security_level

string

Механизм безопасности, используемый для связи между агентом и диспетчером.

Допустимые значения:

  • "AuthPriv" ← (по умолчанию)
  • "AuthNoPriv"

state

string

Если задано present, будет проверено наличие ресурса и при необходимости он будет создан.

Если задано absent, будет проверено отсутствие ресурса и при необходимости он будет удалён.

Допустимые значения:

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

sys_contact

string

Контактное лицо, ответственное за реализацию SNMP.

Введите строку длиной до 64 символов, например адрес электронной почты, имя и номер телефона.

Обязательно, если enabled имеет значение true.

sys_location

string

Расположение узла, на котором работает агент SNMP (сервер).

Обязательно, если enabled имеет значение true.

tags

list / elements=dictionary

Список тегов в формате Key:<задаваемый пользователем ключ> Value:<задаваемое пользователем значение>.

trap_community

string

Группа сообщества SNMP, используемая для отправки SNMP-ловушек на другие устройства.

Допустимо только для пользователей SNMPv2c.

use_proxy

boolean

Если задано no, прокси использоваться не будет, даже если он указан в переменной среды на целевых узлах.

Допустимые значения:

  • false
  • true ← (по умолчанию)

v2c_enabled

boolean

Состояние протокола SNMPv2c.

Если протокол включён, для связанных серверов доступен SNMPv2c.

Допустимые значения:

  • false
  • true ← (по умолчанию)

v3_enabled

boolean

Состояние протокола SNMPv3.

Если протокол включён, для связанных серверов доступен SNMPv3.

Допустимые значения:

  • false
  • true ← (по умолчанию)

validate_certs

boolean

Логическое значение, управляющее проверкой TLS-сертификата api_uri.

Допустимые значения:

  • false
  • true ← (по умолчанию)

Примеры

- name: Create SNMP Policy with SNMPv2 and SNMPv3 enabled
  cisco.intersight.intersight_snmp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "mixed-snmp-policy"
    description: "SNMP policy with both v2 and v3 enabled"
    enabled: true
    v2c_enabled: true
    v3_enabled: true
    snmp_port: 161
    sys_contact: "admin@example.com"
    sys_location: "Data Center A"
    community_access: "Full"
    access_community_string: "public"
    trap_community: "trapcomm"
    engine_input_id: "custom-engine-id"
    snmp_users:
      - name: "admin"
        security_level: "AuthPriv"
        auth_password: "authpassword123"
        privacy_password: "privpassword123"
      - name: "readonly"
        security_level: "AuthNoPriv"
        auth_password: "readonlypass123"
    snmp_traps:
      - enabled: true
        version: "V2"
        community: "trapcomm"
        type: "Trap"
        destination: "192.168.1.100"
        port: 162
      - enabled: true
        version: "V3"
        user: "admin"
        type: "Trap"
        destination: "192.168.1.101"
        port: 162
    tags:
      - Key: "Environment"
        Value: "Production"
    state: present

- name: Create SNMP Policy with only SNMPv3 enabled
  cisco.intersight.intersight_snmp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "v3-only-snmp-policy"
    description: "SNMP policy with only v3 enabled"
    enabled: true
    v2c_enabled: false
    v3_enabled: true
    snmp_port: 161
    sys_contact: "admin@example.com"
    sys_location: "Data Center B"
    engine_input_id: "v3-engine-id"
    snmp_users:
      - name: "v3user"
        security_level: "AuthPriv"
        auth_password: "v3authpass123"
        privacy_password: "v3privpass123"
    state: present

- name: Create SNMP Policy with only SNMPv2 enabled
  cisco.intersight.intersight_snmp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "v2-only-snmp-policy"
    description: "SNMP policy with only v2 enabled"
    enabled: true
    v2c_enabled: true
    v3_enabled: false
    snmp_port: 161
    sys_contact: "admin@example.com"
    sys_location: "Data Center C"
    community_access: "Limited"
    access_community_string: "readonly"
    trap_community: "v2traps"
    state: present

- name: Create disabled SNMP Policy
  cisco.intersight.intersight_snmp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "disabled-snmp-policy"
    description: "Disabled SNMP policy"
    enabled: false
    state: present

- name: Delete SNMP Policy
  cisco.intersight.intersight_snmp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "mixed-snmp-policy"
    state: absent

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

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

Ключ

Описание

api_response

dictionary

Данные ответа API, возвращённые указанным ресурсом.

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

Пример: {"api_response": {"AccessCommunityString": "public", "CommunityAccess": "Full", "Enabled": true, "EngineId": "custom-engine-id", "Name": "mixed-snmp-policy", "ObjectType": "snmp.Policy", "SnmpPort": 161, "SnmpTraps": [{"Community": "trapcomm", "Destination": "192.168.1.100", "Enabled": true, "Port": 162, "Type": "Trap", "Version": "V2"}], "SnmpUsers": [{"AuthType": "SHA", "IsAuthPasswordSet": true, "IsPrivacyPasswordSet": true, "Name": "admin", "PrivacyType": "AES", "SecurityLevel": "AuthPriv"}], "SysContact": "admin@example.com", "SysLocation": "Data Center A", "Tags": [{"Key": "Environment", "Value": "Production"}], "TrapCommunity": "trapcomm", "V2Enabled": true, "V3Enabled": true}}

Авторы

  • Ron Gershburg (@rgershbu)

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

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

© 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/cisco/intersight/intersight_snmp_policy_module.html

Spec-Zone.ru

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