Spec-Zone.ru › Ansible 2.5

nxos_snmp_location - Управление информацией о местоположении SNMP.

Новая версия 2.2.

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

Обзор

  • Управление конфигурацией местоположения SNMP.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
location
обязательно
Информация о местоположении.
provider По умолчанию:
Нет
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр необходим только при использовании NX-API.
Для получения дополнительной информации см. руководство по параметрам платформы NXOS NXOS Platform Options guide.
Объект dict, содержащий данные подключения.
username
Настройка имени пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа по CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_USERNAME.
authorize
(добавлен в 2.5.3)
    Варианты:
  • нет ←
  • да
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
use_proxy
(добавлен в 2.5)
    Варианты:
  • да ←
  • нет
Если no, переменные среды http_proxy и https_proxy будут проигнорированы.
auth_pass
(добавлен в 2.5.3)
По умолчанию:
нет
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize — ложь, этот параметр игнорируется. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS.
host
обязательно
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
timeout
(добавлен в 2.3)
По умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт, прежде чем операция будет завершена, модуль выдаст ошибку. NX-API может медленно реагировать на длительные команды (sh mac, sh bgp и т. д.).
use_ssl
    Варианты:
  • да
  • нет ←
Настраивает transport для использования SSL, если значение равно true только при transport=nxapi, в противном случае это значение игнорируется.
password По умолчанию:
Нет
Указывает пароль для аутентификации подключения к удалённому устройству. Этот параметр обычно используется для транспортов cli или nxapi. Если значение не указано в задании, вместо него будет использовано значение переменной среды ANSIBLE_NET_PASSWORD.
validate_certs
    Варианты:
  • да
  • нет
По умолчанию:
Нет
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под личным контролем, использующих самозаверенные сертификаты. Если параметр transport не nxapi, это значение игнорируется.
port По умолчанию:
0 (используется стандартный порт)
Указывает порт, используемый при построении подключения к удалённому устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию будет соответствовать стандартному порту для соответствующего транспорта, если он не указан в задании (cli=22, http=80, https=443).
transport
обязательно
По умолчанию:
cli
Настраивает транспортное соединение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi.
state
    Варианты:
  • present ←
  • absent
Управление состоянием ресурса.

Примечания

Примечание

  • Тестировалось с NXOSv 7.3.(0)D1(1) на VIRL
  • Информация об использовании CLI и NX-API см. в руководстве NXOS Platform Options guide
  • Дополнительная информация об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
  • Дополнительная информация об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.

Примеры

# ensure snmp location is configured
- nxos_snmp_location:
    location: Test
    state: present

# ensure snmp location is not configured
- nxos_snmp_location:
    location: Test
    state: absent

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

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

Ключ Возвращаемое значение Описание
commands
список
всегда
Команды, отправленные на устройство

Пример:
['snmp-server location New_Test']


Статус

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

Поддержка

Дополнительную информацию о поддержке данного модуля Red Hat см. в этой статье базы знаний

Автор

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/nxos_snmp_location_module.html

Spec-Zone.ru

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