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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands - / обязательно			Команды для отправки на удалённое устройство NXOS. Результат выполнения команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт время ожидания. Аргумент commands также принимает альтернативную форму, которая позволяет использовать сложные значения, задающие команду для выполнения и формат возвращаемого результата. Это можно сделать для каждой команды. Сложный аргумент поддерживает ключевые слова `command` и `output`, где `command` - команда для выполнения, а `output` - один из 'text' или 'json'.
interval -		Значение по умолчанию: 1	Устанавливает интервал в секундах для ожидания между повторными попытками выполнения команды. Если команда не выполняет заданное условие, интервал определяет время ожидания перед повторной попыткой.
match -		Значение по умолчанию: "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		Указывает пароль для использования при входе в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize булево добавлено в 2.5.3	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в обычном режиме. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	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 целое число	Значение по умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.).
	transport строка / обязательно	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy булево добавлено в 2.5	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl булево	Варианты: нет ← да	Настраивает transport для использования SSL, если установлено значение `yes`, только если `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs булево	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами, с самозаверенными сертификатами. Если аргумент transport не равен nxapi, это значение игнорируется.
retries -		Значение по умолчанию: 10	Устанавливает количество попыток выполнения команды перед признанием её неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for -			Указывает, что следует оценивать из вывода команды и какие условия применять. Этот аргумент заставит задачу ожидать выполнения определённого условия до продолжения. Если условие не выполняется к заданному количеству попыток, задача завершается с ошибкой. См. примеры. Псевдонимы: 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

- name: run commands that require answering a prompt
  nxos_command:
    commands:
      - configure terminal
      - command: 'no feature npv'
        prompt: 'Do you want to continue'
        answer: 'y'

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

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

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

Статус

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

Поддержка Red Hat

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

Авторы

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.9/modules/nxos_command_module.html