eos_vlan — Управление VLAN на устройствах Arista EOS
Новое в версии 2.4.
Описание
- Этот модуль обеспечивает декларативное управление VLAN на устройствах Arista EOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate | Список определений VLAN. | ||
| associated_interfaces (добавлено в 2.5) | Это опция намерения и проверяет оперативное состояние для заданного vlan name для связанных интерфейсов. Имя интерфейса чувствительно к регистру и должно быть в полном формате, а не сокращенном. Если значение в associated_interfaces не совпадает с оперативным состоянием интерфейсов vlan на устройстве, это приведет к ошибке. | ||
| auth_pass | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Эта опция требуется только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize bool |
| Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Эта опция требуется только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| delay | Значение по умолчанию: 10 | Задержка, которую должен ожидать плей для проверки значений декларативных параметров намерения. | |
| interfaces | Список интерфейсов, которые должны быть связаны с VLAN. Имя интерфейса чувствительно к регистру и должно быть в полном формате, а не сокращенном. | ||
| name | Имя VLAN. | ||
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Эта опция требуется только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря с информацией о подключении. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола. | ||
| port | Значение по умолчанию: "0 (использовать общий порт)" | Указывает порт для создания подключения к удаленному устройству. Это значение относится к cli или eapi. Значение порта будет по умолчанию соответствовать обычному порту соответствующего протокола, если не указано в задаче (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого протокола. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для протоколов cli или eapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| timeout | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль вернет ошибку. | |
| ssh_keyfile | Указывает файл ключа SSH для аутентификации подключения к удаленному устройству. Этот аргумент используется только для протоколов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| transport обязательно |
| Настраивает протокол подключения при подключении к удаленному устройству. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если значение true, только когда transport=eapi. Если аргумент transport не eapi, это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах с самозаверенными сертификатами. Если аргумент transport не eapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| purge | Значение по умолчанию: "нет" | Удаляет VLAN, не определенные в параметре aggregate. | |
| state |
| Состояние конфигурации VLAN. | |
| vlan_id обязательно | ID VLAN. | ||
Примечания
Примечание
- Проверено на EOS 4.15
- Для информации о работе с CLI, eAPI и привилегированным режимом см. руководство EOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Для получения дополнительной информации об использовании Ansible для управления устройствами Arista EOS см. страницу интеграции Arista.
Примеры
- name: Create vlan
eos_vlan:
vlan_id: 4000
name: vlan-4000
state: present
- name: Add interfaces to vlan
eos_vlan:
vlan_id: 4000
state: present
interfaces:
- Ethernet1
- Ethernet2
- name: Check if interfaces is assigned to vlan
eos_vlan:
vlan_id: 4000
associated_interfaces:
- Ethernet1
- Ethernet2
- name: Suspend vlan
eos_vlan:
vlan_id: 4000
state: suspend
- name: Unsuspend vlan
eos_vlan:
vlan_id: 4000
state: active
- name: Create aggregate of vlans
eos_vlan:
aggregate:
- vlan_id: 4000
- {vlan_id: 4001, name: vlan-4001}
Возвращаемые значения
Общие возвращаемые значения описаны в документации, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд конфигурации режима для отправки на устройство Пример: ['vlan 20', 'name test-vlan'] |
Статус
Этот модуль помечен как превью, что означает, что его обратная совместимость не гарантируется.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по сетям. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых командой Ansible по сетям, см. здесь.
Поддержка
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, пожалуйста, обратитесь к этой статье базы знаний
Автор
- Ricardo Carrillo Cruz (@rcarrillocruz)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/eos_vlan_module.html
