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 ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize |
| Устарело Начиная с 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-серверов, либо список хешей, которые настраивают имя сервера и имя VRF. См. примеры. | ||
| provider | По умолчанию: Нет | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Этот параметр требуется только при использовании eAPI. Дополнительную информацию см. в руководстве EOS Platform Options. Объект словаря, содержащий сведения о подключении. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлено в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| auth_pass | По умолчанию: нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает DNS-имя хоста или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout | По умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечёт до завершения операции, модуль вернёт ошибку. | |
| use_ssl |
| Настраивает транспорт для использования SSL, если значение истинно, только если transport=eapi. Если аргумент транспорта не eapi, это значение игнорируется. | |
| password | По умолчанию: Нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, управляемых лично, использующих самозаверяющие сертификаты. Если аргумент транспорта не eapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использование общего порта) | Указывает порт для создания подключения к удалённому устройству. Это значение применимо как к cli, так и к eapi. Значение порта по умолчанию соответствует общему порту соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| transport обязательно |
| Настраивает транспортное подключение для подключения к удалённому устройству. | |
| state |
| Состояние значений конфигурации в текущей активной конфигурации устройства. При установке в present значения должны быть настроены в активной конфигурации устройства, а при установке в absent значения не должны быть в активной конфигурации устройства. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Дополнительную информацию об использовании командной строки, eAPI и привилегированного режима см. в руководстве EOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista Arista integration page.
Примеры
- 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 список | всегда | Список команд режима конфигурации для отправки на устройство Пример: ['hostname eos01', 'ip domain-name test.example.com'] |
| session_name строка | изменённое | Имя сессии конфигурации EOS, используемой для загрузки конфигурации Пример: ansible_1479315771 |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантирует обратную совместимость.
Поддержка
Для получения дополнительной информации о поддержке этого модуля Red Hat, обратитесь к этой статье базы знаний
Автор
- Питер Спрыгада (@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/eos_system_module.html
