eos_system — Управление системными атрибутами на устройствах Arista EOS
Новая в версии 2.3.
Обзор
- Этот модуль предоставляет декларативное управление атрибутами системы узла на устройствах Arista EOS. Он предоставляет возможность настроить параметры системы узла или удалить эти параметры из активной конфигурации устройства.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Дополнительную информацию см. в руководстве EOS Platform Options. Указывает пароль, который требуется для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize bool |
| Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только при использовании eAPI. Дополнительную информацию см. в руководстве EOS Platform Options. Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| domain_name | Настройка имени домена IP на удалённом устройстве на указанное значение. Значение должно быть в формате доменного имени и будет добавлено к hostname, чтобы создать полное доменное имя. | ||
| domain_search | Предоставляет список суффиксов доменов, которые нужно добавить к имени хоста для выполнения разрешения имён. Этот аргумент принимает список имён и будет согласован с текущей активной конфигурацией на запущенном узле. псевдонимы: domain_list | ||
| hostname | Настройка параметра имени хоста устройства. Этот параметр принимает строковое значение ASCII. | ||
| lookup_source | Предоставляет один или несколько источников интерфейсов для выполнения разрешения DNS-имен. Интерфейс, указанный в lookup_source, может существовать только в одной VRF. Этот аргумент принимает либо список имён интерфейсов, либо список хешей, которые настраивают имя интерфейса и имя VRF. См. примеры. | ||
| name_servers | Список DNS-серверов по IP-адресу, которые следует использовать для выполнения разрешения DNS-имен. Этот аргумент принимает либо список DNS-серверов, либо список хешей, которые настраивают имя сервера и имя VRF. См. примеры. | ||
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Дополнительную информацию см. в руководстве EOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| host обязательно | Указывает имя DNS-хоста или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: "0 (использовать общий порт)" | Указывает порт, используемый при построении соединения с удалённым устройством. Это значение относится к cli или eapi. Значение порта по умолчанию будет соответствовать общему порту соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| username | Настройка имени пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| timeout | По умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль, который требуется для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| transport обязательно |
| Настраивает транспортное соединение, которое следует использовать при подключении к удалённому устройству. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если значение true только при transport=eapi. Если аргумент transport не eapi, это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на управляемых вами сайтах, использующих самозаверенные сертификаты. Если аргумент transport не eapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| state |
| Состояние значений конфигурации в текущей активной конфигурации устройства. При значении present значения должны быть настроены в активной конфигурации устройства, а при значении absent — нет. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Сведения об использовании CLI, eAPI и привилегированного режима см. в руководстве EOS Platform Options.
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide.
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista Arista integration.
Примеры
- name: configure hostname and domain-name
eos_system:
hostname: eos01
domain_name: test.example.com
- name: remove configuration
eos_system:
state: absent
- name: configure DNS lookup sources
eos_system:
lookup_source: Management1
- name: configure DNS lookup sources with VRF support
eos_system:
lookup_source:
- interface: Management1
vrf: mgmt
- interface: Ethernet1
vrf: myvrf
- name: configure name servers
eos_system:
name_servers:
- 8.8.8.8
- 8.8.4.4
- name: configure name servers with VRF support
eos_system:
name_servers:
- { server: 8.8.8.8, vrf: mgmt }
- { server: 8.8.4.4, vrf: mgmt }
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands list | всегда | Список команд режима конфигурации для отправки на устройство Пример: ['hostname eos01', 'ip domain-name test.example.com'] |
| session_name str | изменённое | Имя сессии конфигурации EOS, используемой для загрузки конфигурации Пример: ansible_1479315771 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по сетевым технологиям. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются командой Ansible по сетевым технологиям, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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/eos_system_module.html
