Модуль 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 | Определяемая пользователем строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Если значение не указано в задаче и переменной среды По умолчанию: |
certificate_name aliases: cert_name string | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
client_group aliases: client_group_name, client_group_profile string | Имя существующей группы клиентов SNMP |
client_name string | Имя клиента SNMP |
host aliases: hostname string | IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
output_level string | Влияет на вывод этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
output_path string | Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, генерируемых модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
password string | Пароль, используемый для аутентификации. Этот параметр взаимоисключающий с Если значение не указано в задаче, вместо него будут использованы значения переменных среды |
policy aliases: snmp_policy, snmp_policy_name string | Имя существующей политики SNMP |
port integer | Номер порта, используемый для REST-подключения. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
private_key aliases: cert_key string | Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение Этот параметр взаимоисключающий с Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
state string | Используйте Используйте Варианты:
|
suppress_previous aliases: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию - ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты:
|
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное. Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче. Выбираемые значения:
|
timeout integer | Таймаут уровня сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — 30. |
use_proxy boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — true. Выбираемые значения:
|
use_ssl boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — true для локального соединения. Выбираемые значения:
|
username aliases: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных окружения Значение по умолчанию — admin. |
validate_certs boolean | Если Это значение должно быть установлено в Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — 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 после завершения модуля Возвращено: успех Пример: |
error словарь | Информация об ошибке, возвращённая с APIC Возвращено: неудача Пример: |
filter_string строка | Строка фильтра, используемая для запроса Возвращено: неудача или отладка Пример: |
method строка | HTTP-метод, используемый для запроса к APIC Возвращено: неудача или отладка Пример: |
previous список / элементы=строка | Исходная конфигурация с APIC до запуска модуля Возвращено: информация Пример: |
proposed словарь | Собранная конфигурация из предоставленных пользователем параметров Возвращено: информация Пример: |
raw строка | Необработанный вывод, возвращённый APIC REST API (xml или json) Возвращено: ошибка разбора Пример: |
response строка | HTTP-ответ от APIC Возвращено: неудача или отладка Пример: |
sent список / элементы=строка | Фактическая/минимальная конфигурация, отправленная в APIC Возвращено: информация Пример: |
status целое число | HTTP-статус от APIC Возвращено: неудача или отладка Пример: |
url строка | HTTP-URL, используемый для запроса к APIC Возвращено: неудача или отладка Пример: |
Ссылки на сборку
© 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