nxos_command – Выполнение произвольной команды на устройствах Cisco NXOS

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands - / обязательно			Команды для отправки на удалённое устройство NXOS. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращает значения, пока условие не будет выполнено или не истечёт лимит попыток. Аргумент commands также поддерживает альтернативную форму, которая позволяет указать сложные значения, определяющие выполняемую команду и формат возвращаемого вывода. Это можно сделать для каждой команды. Сложный аргумент поддерживает ключевые слова `command` и `output`, где `command` — это выполняемая команда, а `output` — это 'text' или 'json'.
interval -		По умолчанию: 1	Устанавливает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет заданному условию, интервал определяет, как долго ждать перед следующей попыткой.
match - добавлен в 2.2		По умолчанию: "all"	Аргумент match используется совместно с аргументом wait_for для указания политики соответствия. Допустимые значения — `all` или `any`. Если значение установлено на `all`, все условия в wait_for должны быть выполнены. Если значение установлено на `any`, достаточно выполнения хотя бы одного из условий.
provider -			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass - добавлен в 2.5.3	По умолчанию: "none"	Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize ложно, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлен в 2.5.3	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение хоста используется в качестве адреса назначения для транспорта.
	password -		Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port -	По умолчанию: "0 (использовать общий порт)"	Указывает порт для использования при создании подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует обычному порту транспорта, если он не указан в задаче (cli=22, http=80, https=443).
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout - добавлен в 2.3	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.).
	transport - / обязательно	По умолчанию: "cli"	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
	use_proxy boolean добавлен в 2.5	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут игнорироваться.
	use_ssl boolean	Варианты: нет ← да	Настраивает transport на использование SSL, если значение равно true только в случае `transport=nxapi`, в противном случае это значение игнорируется.
	username -		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: нет да	Если `no`, сертификаты SSL не будут проверяться. Это следует использовать только на управляемых лично сайтах, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
retries -		По умолчанию: 10	Указывает количество попыток выполнения команды, после которых она считается неудачной. Команда выполняется на целевом устройстве при каждой повторной попытке и оценивается по условиям wait_for.
wait_for - добавлен в 2.2			Указывает, что необходимо оценить из вывода команды и какие условия применить. Этот аргумент заставляет задачу ждать выполнения определённого условия до продолжения. Если условие не выполняется в течение заданного количества попыток, задача завершается неудачей. См. примеры. псевдонимы: waitfor

Примечания

Примечание

Сведения о работе с CLI и NX-API см. в руководстве NXOS Platform Options
Дополнительная информация об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Дополнительная информация об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

---
- name: run show version on remote devices
  nxos_command:
    commands: show version

- name: run show version and check to see if output contains Cisco
  nxos_command:
    commands: show version
    wait_for: result[0] contains Cisco

- name: run multiple commands on remote nodes
  nxos_command:
    commands:
      - show version
      - show interfaces

- name: run multiple commands and evaluate the output
  nxos_command:
    commands:
      - show version
      - show interfaces
    wait_for:
      - result[0] contains Cisco
      - result[1] contains loopback0

- name: run commands and specify the output format
  nxos_command:
    commands:
      - command: show version
        output: json

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

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

Ключ	Возвращаемое значение	Описание
failed_conditions список	неуспешно	Список условных выражений, которые завершились неудачно Пример: ['...', '...']
stdout список	всегда, кроме ошибок низкого уровня (например, плагины действий)	Набор ответов от команд Пример: ['...', '...']
stdout_lines список	всегда, кроме ошибок низкого уровня (например, плагины действий)	Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Этот модуль не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается командой Ansible Network Team. [сетевой]

Поддержка Red Hat

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

Авторы

Peter Sprygada (@privateip)

Подсказка

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

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