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 Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: "0 (использовать общий порт)" | Указывает порт, который нужно использовать при построении соединения с удалённым устройством. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует соответствующему общему порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в консоль CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспорта cli или nxapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлено в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлено в 2.5.3) | По умолчанию: "нет" | Указывает пароль, если требуется для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент не выполняет никаких действий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлено в 2.3) | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | По умолчанию: "cli" | Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport на использование SSL, если значение true, только при transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под собственным контролем, использующих самозаверяемые сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| state |
| Состояние значений конфигурации в текущей активной конфигурации устройства. При значении 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 список | всегда | Список команд конфигурации, которые необходимо отправить устройству. Пример: ['hostname nxos01', 'ip domain-name test.example.com'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что его обслуживает команда Ansible Network Team. Смотрите Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также обслуживает команда Ansible Network Team, см. здесь.
Поддержка
Для получения дополнительной информации о поддержке данного модуля компанией 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.6/modules/nxos_system_module.html
