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

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

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

Описание

Этот модуль обеспечивает декларативное управление системными атрибутами узлов на устройствах 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`. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass строка добавлено в 2.5.3		Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, то используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлено в 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 целое число добавлено в 2.3	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.).
	transport строка / обязательно	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент транспорт поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy boolean добавлено в 2.5	Варианты: нет да ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: нет ← да	Настраивает transport для использования SSL, если установлено значение `yes`, только если `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настройка имени пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, то используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на управляемых вами сайтах с самозаверяемыми сертификатами. Если аргумент transport не nxapi, это значение игнорируется.
state -		Варианты: present ← absent	Состояние значений конфигурации в текущей активной конфигурации устройства. Если установлено значение present, значения должны быть настроены в активной конфигурации устройства, а если absent, то значения не должны быть в активной конфигурации устройства.
system_mtu -			Указывает mtu, должно быть целым числом или ключевым словом 'default'.

Примечания

Примечание

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

Примеры

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

- name: remove configuration
  nxos_system:
    state: absent

- name: configure name servers
  nxos_system:
    name_servers:
      - 8.8.8.8
      - 8.8.4.4

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

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

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

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

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается командой 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.8/modules/nxos_system_module.html