arista.eos.eos_system – Управление системными атрибутами на устройствах Arista EOS
Примечание
Этот плагин входит в состав коллекции arista.eos (версия 1.3.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. Объект словаря, содержащий данные подключения. | ||
| 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
- Дополнительную информацию об использовании 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/arista/eos/eos_system_module.html
