eos_system – Управление системными атрибутами на устройствах Arista EOS
Обзор
- Этот модуль обеспечивает декларативное управление атрибутами системы узла на устройствах 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. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной окружения 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 логическое значение добавлен в 2.5 |
| Если 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
- Дополнительную информацию об использовании командной строки, eAPI и привилегированного режима см. в Руководстве по параметрам платформы EOS
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции 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 Network. [сеть]
Поддержка 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.9/modules/eos_system_module.html
