Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_snmp_client — Управление клиентами SNMP (snmp:ClientP)

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.aci.aci_snmp_client.

  • Обзор
  • Параметры
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Управление клиентами SNMP

Параметры

Параметр

Комментарии

address

string

IP-подсеть для принятия SNMP-запросов от

annotation

string

Определяемая пользователем строка для аннотации объекта.

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

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

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

certificate_name

aliases: cert_name

string

Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.

Если указано имя файла private_key, по умолчанию используется базовое имя private_key без расширения.

Если для private_key указано содержимое в формате PEM, по умолчанию используется значение username.

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

client_group

aliases: client_group_name, client_group_profile

string

Имя существующей группы клиентов SNMP

client_name

string

Имя клиента SNMP

host

aliases: hostname

string

IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible.

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

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая словарь current

info добавляет информационный вывод, включая словари previous, proposed и sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

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

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

output_path

string

Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, генерируемых модулем.

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

password

string

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

Этот параметр взаимоисключающий с private_key. Если также указан private_key, он будет использоваться вместо него.

Если значение не указано в задаче, вместо него будут использованы значения переменных среды ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

policy

aliases: snmp_policy, snmp_policy_name

string

Имя существующей политики SNMP

port

integer

Номер порта, используемый для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

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

private_key

aliases: cert_key

string

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

Это значение также влияет на используемое значение certificate_name по умолчанию.

Этот параметр взаимоисключающий с password. Если также указан password, он будет игнорироваться.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

state

string

Используйте present или absent для добавления или удаления.

Используйте query для перечисления одного или нескольких объектов.

Варианты:

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

suppress_previous

aliases: no_previous, ignore_previous

boolean

Если true, запрос GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC.

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

Значение по умолчанию - false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым.

Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, проверка GET не будет отправлена после обновления POST в APIC.

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

Значение по умолчанию — false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное.

Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче.

Выбираемые значения:

  • false
  • true

timeout

integer

Таймаут уровня сокета в секундах.

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

Значение по умолчанию — 30.

use_proxy

boolean

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

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

Значение по умолчанию — true.

Выбираемые значения:

  • false
  • true

use_ssl

boolean

Если false, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение.

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

Значение по умолчанию — true для локального соединения.

Выбираемые значения:

  • false
  • true

username

aliases: user

string

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

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

Значение по умолчанию — admin.

validate_certs

boolean

Если false, сертификаты SSL не будут проверены.

Это значение должно быть установлено в false только при работе с сайтами, контролируемыми вами лично, которые используют самозаверяющие сертификаты.

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

Значение по умолчанию — true.

Выбираемые значения:

  • false
  • true

См. также

См. также

APIC Management Information Model reference

Дополнительная информация о внутренних классах APIC snmp:ClientP.

Руководство по Cisco ACI

Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create an SNMP client
  cisco.aci.aci_snmp_client:
    host: apic
    username: admin
    password: SomeSecretPassword
    policy: my_snmp_policy
    client_group: my_snmp_client_group
    address: 10.20.30.0/24
    client_name: my_client_name
    state: present
  delegate_to: localhost

- name: Remove an SNMP client
  cisco.aci.aci_snmp_client_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    policy: my_snmp_policy
    client_group: my_snmp_client_group
    address: 10.20.30.0/24
    state: absent
  delegate_to: localhost

- name: Query an SNMP client
  cisco.aci.aci_snmp_client:
    host: apic
    username: admin
    password: SomeSecretPassword
    policy: my_snmp_policy
    client_group: my_snmp_client_group
    address: 10.20.30.0/24
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all SNMP clients
  cisco.aci.aci_snmp_client:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

current

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

Текущая конфигурация с APIC после завершения модуля

Возвращено: успех

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

словарь

Информация об ошибке, возвращённая с APIC

Возвращено: неудача

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

строка

Строка фильтра, используемая для запроса

Возвращено: неудача или отладка

Пример: "?rsp-prop-include=config-only"

method

строка

HTTP-метод, используемый для запроса к APIC

Возвращено: неудача или отладка

Пример: "POST"

previous

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

Исходная конфигурация с APIC до запуска модуля

Возвращено: информация

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

словарь

Собранная конфигурация из предоставленных пользователем параметров

Возвращено: информация

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

строка

Необработанный вывод, возвращённый APIC REST API (xml или json)

Возвращено: ошибка разбора

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

строка

HTTP-ответ от APIC

Возвращено: неудача или отладка

Пример: "OK (30 bytes)"

sent

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

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращено: информация

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

целое число

HTTP-статус от APIC

Возвращено: неудача или отладка

Пример: 200

url

строка

HTTP-URL, используемый для запроса к APIC

Возвращено: неудача или отладка

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Tim Cragg (@timcragg)

Ссылки на сборку

  • Отслеживание ошибок
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_snmp_client_module.html

Spec-Zone.ru

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