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

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

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

Синопсис

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
domain_lookup -			Включает или выключает функцию поиска 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. Объект словаря, содержащий данные соединения.
	auth_pass - добавлено в 2.5.3	По умолчанию: "none"	Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлено в 2.5.3	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `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"	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy boolean добавлено в 2.5	Варианты: no yes ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут игнорироваться.
	use_ssl boolean	Варианты: no ← yes	Настраивает transport на использование SSL, если значение true, только когда `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
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco cisco integration page.

Примеры

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