cisco.nxos.nxos_system – Управление системными атрибутами на устройствах Cisco NXOS

Примечание

Этот плагин входит в состав коллекции cisco.nxos (версия 1.3.1).

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

Для использования в книге задач укажите: cisco.nxos.nxos_system.

В версии 1.0.0: плагина cisco.nxos

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль обеспечивает декларативное управление атрибутами системы узла на устройствах Cisco NXOS. Он предоставляет возможность настроить параметры системы узла или удалить эти параметры из активной конфигурации устройства.

Примечание

У данного модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
domain_lookup boolean		Варианты: no yes	Включает или отключает функцию поиска домена в Cisco NXOS. Этот аргумент принимает булевы значения. При включении система будет пытаться разрешить имена хостов с помощью DNS, а при отключении имена хостов не будут разрешаться.
domain_name list / elements=raw			Настраивает суффикс доменного имени по умолчанию, который используется при ссылке на этот узел по его полному доменному имени (FQDN). Этот аргумент принимает либо список доменных имен, либо список словарей, которые настраивают доменное имя и имя VRF или ключевое слово «default». См. примеры.
domain_search list / elements=raw			Настраивает список суффиксов доменных имен для поиска при выполнении разрешения имен DNS. Этот аргумент принимает либо список доменных имен, либо список словарей, которые настраивают доменное имя и имя VRF или ключевое слово «default». См. примеры.
hostname string			Настройте параметр имени хоста устройства. Этот параметр принимает значение ASCII-строки или ключевое слово «default».
name_servers list / elements=raw			Список DNS-серверов по IP-адресу, которые необходимо использовать для выполнения поиска разрешения имен. Этот аргумент принимает либо список DNS-серверов, либо список словарей, которые настраивают имя сервера и имя VRF или ключевое слово «default». См. примеры.
provider dictionary			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6, рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удален в выпуске после 2022-06-01. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass string		Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host string		Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password string		Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port integer		Указывает порт для подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует общему порту соответствующего транспорта, если в задаче не указано другое значение. (cli=22, http=80, https=443).
	ssh_keyfile string		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer		Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.).
	transport string	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по протоколу cli (ssh) или nxapi.
	use_proxy boolean	Варианты: no yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: no ← yes	Настраивает транспорт transport для использования SSL, если значение установлено в `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username string		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: no ← yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с самозаверяющимися сертификатами. Если аргумент transport не является nxapi, это значение игнорируется.
state string		Варианты: present ← absent	Состояние значений конфигурации в текущей активной конфигурации устройства. При установке в present значения должны быть настроены в активной конфигурации устройства, а при установке в absent значения не должны входить в активную конфигурацию устройства.
system_mtu string			Указывает mtu, должно быть целым числом или ключевым словом 'default'.

Примечания

Примечание

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

Примеры

- name: configure hostname and domain-name
  cisco.nxos.nxos_system:
    hostname: nxos01
    domain_name: test.example.com

- name: remove configuration
  cisco.nxos.nxos_system:
    state: absent

- name: configure name servers
  cisco.nxos.nxos_system:
    name_servers:
    - 8.8.8.8
    - 8.8.4.4

- name: configure name servers with VRF support
  cisco.nxos.nxos_system:
    name_servers:
    - {server: 8.8.8.8, vrf: mgmt}
    - {server: 8.8.4.4, vrf: mgmt}

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

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

Ключ	Возвращенное значение	Описание
commands list / elements=string	всегда	Список команд режима конфигурации для отправки на устройство Пример: ['hostname nxos01', 'ip domain-name test.example.com']

Авторы

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.10/collections/cisco/nxos/nxos_system_module.html