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 boolean |
| Устаревший Начиная с 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. Объект словаря, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения 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 - | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. | |
| transport - / обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает транспорт transport использовать SSL, если значение равно true, только когда transport=eapi. Если аргумент transport не равен eapi, это значение игнорируется. | |
| username - | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с самозаверяющимися сертификатами. Если аргумент transport не равен eapi, это значение игнорируется. | |
| state - |
| Состояние конфигурационных значений в текущей активной конфигурации устройства. При установке значения present значения должны быть настроены в активной конфигурации устройства, а при установке absent — значения не должны находиться в активной конфигурации устройства. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Сведения о работе с CLI, eAPI и привилегированным режимом см. в Руководстве по параметрам платформы EOS
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетевому Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista интеграции Arista.
Примеры
- 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 |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается командой Ansible по работе с сетями. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля компанией Red Hat см. в этой статье базы знаний 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.7/modules/eos_system_module.html
