nxos_interface - Управление физическими атрибутами интерфейсов.
Новая версия 2.1.
Описание
- Управление физическими атрибутами интерфейсов коммутаторов NX-OS.
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| admin_state | нет | включено |
| Административное состояние интерфейса. |
| auth_pass (добавлен в 2.4.4)
| нет | нет | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлен в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| description | нет | Описание интерфейса. | ||
| fabric_forwarding_anycast_gateway (добавлен в 2.2)
| нет |
| Связать SVI с anycast-шлюзом в режиме конфигурации VLAN. | |
| host | да | Указывает имя или адрес хоста DNS для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| interface | да | Полное имя интерфейса, например Ethernet1/1, port-channel10. | ||
| interface_type (добавлен в 2.2)
| нет |
| Тип интерфейса, который нужно отключить на устройстве. | |
| ip_forward (добавлен в 2.2)
| нет |
| Включить/выключить функцию ip forward на SVI. | |
| mode | нет |
| Управление состоянием уровня 2 или уровня 3 интерфейса. | |
| password | нет | Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать общий порт) | Указывает порт для подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует обычному порту транспорта, если не указано иное в задаче. (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта словаря. Все ограничения (обязательность, варианты и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| state | да | наличие |
| Указывает желаемое состояние ресурса. |
| timeout (добавлен в 2.3)
| нет | 10 | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает transport для использования SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. |
Примеры
- name: Ensure an interface is a Layer 3 port and that it has the proper description
nxos_interface:
interface: Ethernet1/1
description: 'Configured by Ansible'
mode: layer3
host: 68.170.147.165
- name: Admin down an interface
nxos_interface:
interface: Ethernet2/1
host: 68.170.147.165
admin_state: down
- name: Remove all loopback interfaces
nxos_interface:
interface: loopback
state: absent
host: 68.170.147.165
- name: Remove all logical interfaces
nxos_interface:
interface_type: "{{ item }} "
state: absent
host: "{{ inventory_hostname }}"
with_items:
- loopback
- portchannel
- svi
- nve
- name: Admin up all loopback interfaces
nxos_interface:
interface: loopback 0-1023
admin_state: up
- name: Admin down all loopback interfaces
nxos_interface:
interface: looback 0-1023
admin_state: down
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| название | описание | возвращается | тип | пример |
|---|---|---|---|---|
| commands | список команд, отправленных на устройство | всегда | список | ['interface port-channel101', 'shutdown'] |
Примечания
Примечание
- Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
- Этот модуль также используется для создания логических интерфейсов, таких как svis и loopbacks.
- Будьте осторожны при работе с платформенными особенностями. Например, при сбросе интерфейса loopback в состояние по умолчанию административное состояние может изменяться в зависимости от версии NX-OS.
- Атрибут nxos_overlay_global
anycast_gateway_macдолжен быть установлен перед установкой свойстваfabric_forwarding_anycast_gateway.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Информация о поддержке
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этом документе knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.
Для получения помощи в разработке модулей, если вы заинтересованы в этом, прочитайте Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_interface_module.html