nxos_system - Управление атрибутами системы на устройствах Cisco NXOS
Новая версия 2.3.
Описание
- Этот модуль предоставляет декларативное управление атрибутами системы узла на устройствах Cisco NXOS. Он предоставляет возможность настроить параметры системы хоста или удалить эти параметры из активной конфигурации устройства.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| domain_lookup | Включает или отключает функцию поиска DNS в Cisco NXOS. Этот аргумент принимает булевы значения. При включении система будет пытаться разрешать имена хостов с помощью DNS, а при отключении имена хостов не будут разрешаться. | ||
| domain_name | Настраивает префикс имени домена по умолчанию, который будет использоваться при ссылке на этот узел по его полному доменному имени (FQDN). Этот аргумент принимает либо список имён доменов, либо список словарей, которые настраивают имя домена и имя VRF. См. примеры. | ||
| domain_search | Настраивает список префиксов имён доменов для поиска при выполнении разрешения имён DNS. Этот аргумент принимает либо список имён доменов, либо список словарей, которые настраивают имя домена и имя VRF. См. примеры. | ||
| hostname | Настройка параметра имени хоста устройства. Этот параметр принимает значение ASCII строки. | ||
| name_servers | Список DNS-серверов по IP-адресу для использования при выполнении поиска разрешения имён. Этот аргумент принимает либо список DNS-серверов, либо список словарей, которые настраивают имя сервера и имя VRF. См. примеры. | ||
| provider | По умолчанию: None | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только если используется NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize (добавлено в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| auth_pass (добавлено в 2.5.3) | По умолчанию: нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя или адрес хоста DNS для подключения к удалённому устройству по указанному транспорту. Значение host используется как адрес назначения для транспорта. | ||
| timeout (добавлено в 2.3) | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| use_ssl |
| Настраивает транспорт transport для использования SSL, если установлено значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| password | По умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
None | Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах, использующих самозаверенные сертификаты. Если параметр транспорта не nxapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта будет по умолчанию установлено в соответствующий стандартный порт транспорта, если он не указан в задании. (cli=22, http=80, https=443). | |
| transport обязательно | По умолчанию: cli | Настраивает транспортное подключение для подключения к удалённому устройству. Параметр транспорта поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| state |
| Состояние значений конфигурации в текущей активной конфигурации устройства. При значении present значения должны быть настроены в активной конфигурации устройства, а при значении absent значения не должны находиться в активной конфигурации устройства. | |
| system_mtu | Указывает MTU, должно быть целым числом. | ||
Примечания
Примечание
- Сведения об использовании командной строки и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- 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 список | всегда | Список команд режима конфигурации для отправки на устройство Пример: ['hostname nxos01', 'ip domain-name test.example.com'] |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/nxos_system_module.html
