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