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

Примечание

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

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

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

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

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

Описание

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
domain_lookup boolean		Варианты: no yes	Включает или отключает функцию поиска DNS в Cisco NXOS. Этот аргумент принимает булевы значения. При включении система будет пытаться разрешить имена хостов с помощью DNS, а при отключении имена хостов не будут разрешаться.
domain_name список / элементы=сырые			Настраивает суффикс имени домена по умолчанию, который используется при ссылке на этот узел по его полному доменному имени (FQDN). Этот аргумент принимает либо список имён доменов, либо список словарей, которые настраивают имя домена и имя VRF или ключевое слово «default». См. примеры.
domain_search список / элементы=сырые			Настраивает список суффиксов имен доменов для поиска при выполнении разрешения имен DNS. Этот аргумент принимает либо список имён доменов, либо список словарей, которые настраивают имя домена и имя VRF или ключевое слово «default». См. примеры.
hostname строка			Настройка имени хоста устройства. Этот параметр принимает значение ASCII-строки или ключевое слово 'default'.
name_servers список / элементы=сырые			Список DNS-серверов по IP-адресам, которые должны использоваться для выполнения поиска разрешения имен. Этот аргумент принимает либо список DNS-серверов, либо список словарей, которые настраивают имя сервера и имя VRF или ключевое слово 'default'. См. примеры.
provider словарь			Устаревший Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli` Начиная с Ansible 2.6 рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удален в релизе после 2022-06-01. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для использования при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`
	authorize boolean	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`
	host строка		Указывает имя или адрес DNS хоста для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_PASSWORD`
	port целое число		Указывает порт для построения подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту транспорта, если он не указан в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`
	timeout целое число		Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.).
	transport строка	Варианты: 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 строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_USERNAME`
	validate_certs boolean	Варианты: no ← yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не является nxapi, это значение игнорируется.
state строка		Варианты: present ← absent	Состояние значений конфигурации в текущей активной конфигурации устройства. При установке в present значения должны быть настроены в активной конфигурации устройства, а при установке в absent – значения не должны быть в активной конфигурации устройства.
system_mtu строка			Указывает 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 список / элементы=строка	всегда	Список команд конфигурации для отправки на устройство. Пример: ['hostname nxos01', 'ip domain-name test.example.com']

Авторы

Peter Sprygada (@privateip)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_system_module.html