Spec-Zone.ru › Ansible 2.7

nxos_interface – Управляет физическими характеристиками интерфейсов.

Новая версия 2.1.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Управляет физическими характеристиками интерфейсов коммутаторов NX-OS.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
admin_state
-
    Варианты:
  • включен ←
  • выключен
Административное состояние интерфейса.
aggregate
-
добавлено в 2.5
Список определений интерфейсов.
delay
-
Значение по умолчанию:
10
Время в секундах ожидания перед проверкой оперативного состояния на удаленном устройстве. Это ожидание применимо к аргументам оперативного состояния.
description
-
Описание интерфейса.
duplex
-
добавлено в 2.5
    Варианты:
  • полный
  • полудуплексный
  • авто ←
Состояние соединения интерфейса. Применимо только к интерфейсам Ethernet.
fabric_forwarding_anycast_gateway
boolean
добавлено в 2.2
    Варианты:
  • нет
  • да
Связать SVI с шлюзом anycast в режиме конфигурации VLAN. Применимо только к интерфейсу SVI.
interface_type
-
добавлено в 2.2
    Варианты:
  • loopback
  • portchannel
  • svi
  • nve
Тип интерфейса, который должен быть отключен от устройства.
ip_forward
-
добавлено в 2.2
    Варианты:
  • включить
  • отключить
Включение/выключение функции ip forward на SVIs.
mode
-
    Варианты:
  • layer2
  • layer3
Управление состоянием интерфейса уровня 2 или уровня 3. Этот параметр поддерживается для интерфейсов Ethernet и portchannel. Применимо только к интерфейсам Ethernet и portchannel.
mtu
-
добавлено в 2.5
MTU для конкретного интерфейса. Должно быть чётным числом от 576 до 9216. Применимо только к интерфейсам Ethernet.
name
- / обязательно
Полное имя интерфейса, например Ethernet1/1, port-channel10.

псевдонимы: интерфейс
neighbors
-
добавлено в 2.5
Проверка оперативного состояния заданного интерфейса name для соседа LLDP.
Доступны следующие подопции. Это параметр только для проверки состояния.
host
-
Хост LLDP соседа для заданного интерфейса name.
port
-
Порт соседа LLDP, к которому подключен заданный интерфейс name.
provider
-
Устарело
Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli.
Этот параметр требуется только при использовании NX-API.
Дополнительная информация в руководстве NXOS Platform Options.
Объект типа dict, содержащий данные подключения.
auth_pass
-
добавлено в 2.5.3
Значение по умолчанию:
"none"
Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, то будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
boolean
добавлено в 2.5.3
    Варианты:
  • нет ←
  • да
Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE.
host
- / обязательно
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password
-
Указывает пароль для проверки подлинности подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD.
port
-
Значение по умолчанию:
"0 (использовать стандартный порт)"
Указывает порт для создания соединения с удалённым устройством. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию будет соответствовать стандартному порту для выбранного транспорта, если он не указан в задаче (cli=22, http=80, https=443).
ssh_keyfile
-
Указывает SSH-ключ для проверки подлинности подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, то будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
-
добавлено в 2.3
Значение по умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т.д.).
transport
- / обязательно
Значение по умолчанию:
"cli"
Настраивает транспортное соединение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству по cli (ssh) или nxapi.
use_proxy
boolean
добавлено в 2.5
    Варианты:
  • нет
  • да ←
Если no, переменные среды http_proxy и https_proxy будут игнорироваться.
use_ssl
boolean
    Варианты:
  • нет ←
  • да
Настраивает transport на использование SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется.
username
-
Настраивает имя пользователя для проверки подлинности подключения к удаленному устройству. Это значение используется для проверки подлинности входа в CLI или проверки подлинности nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME.
validate_certs
boolean
    Варианты:
  • нет
  • да
Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. Если параметр transport не nxapi, это значение игнорируется.
rx_rate
-
added in 2.5
Скорость приема в битах в секунду (бит/с).
Это параметр только для проверки состояния.
Поддерживает условные выражения, см. Условные выражения в сетевых модулях
speed
-
added in 2.5
Скорость интерфейса канала. Применимо только для интерфейсов Ethernet.
state
-
    Варианты:
  • present ←
  • absent
  • default
Укажите желаемое состояние ресурса.
tx_rate
-
added in 2.5
Скорость передачи в битах в секунду (бит/с).
Это параметр только для проверки состояния.
Поддерживает условные выражения, см. Условные выражения в сетевых модулях

Примечания

Примечание

  • Проверено на NXOSv 7.3.(0)D1(1) на VIRL
  • Этот модуль также используется для создания логических интерфейсов, таких как svis и loopbacks.
  • Будьте осторожны с платформенно-специфическими особенностями. Например, при сбросе значения интерфейса loopback, состояние администрирования переключается на некоторых версиях NX-OS.
  • Атрибут nxos_overlay_global anycast_gateway_mac должен быть установлен перед установкой свойства fabric_forwarding_anycast_gateway.
  • Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
  • Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.

Примеры

- name: Ensure an interface is a Layer 3 port and that it has the proper description
  nxos_interface:
    name: Ethernet1/1
    description: 'Configured by Ansible'
    mode: layer3

- name: Admin down an interface
  nxos_interface:
    name: Ethernet2/1
    admin_state: down

- name: Remove all loopback interfaces
  nxos_interface:
    name: loopback
    state: absent

- name: Remove all logical interfaces
  nxos_interface:
    interface_type: "{{ item }} "
    state: absent
  loop:
    - loopback
    - portchannel
    - svi
    - nve

- name: Admin up all loopback interfaces
  nxos_interface:
    name: loopback 0-1023
    admin_state: up

- name: Admin down all loopback interfaces
  nxos_interface:
    name: looback 0-1023
    admin_state: down

- name: Check neighbors intent arguments
  nxos_interface:
    name: Ethernet2/3
    neighbors:
    - port: Ethernet2/3
      host: abc.mycompany.com

- name: Add interface using aggregate
  nxos_interface:
    aggregate:
    - { name: Ethernet0/1, mtu: 256, description: test-interface-1 }
    - { name: Ethernet0/2, mtu: 516, description: test-interface-2 }
    duplex: full
    speed: 100
    state: present

- name: Delete interface using aggregate
  nxos_interface:
    aggregate:
    - name: Loopback9
    - name: Loopback10
    state: absent

- name: Check intent arguments
  nxos_interface:
    name: Ethernet0/2
    state: up
    tx_rate: ge(0)
    rx_rate: le(0)

Возвращаемые значения

Общие возвращаемые значения описаны в документации, а следующие — поля, уникальные для этого модуля:

Ключ Возвращаемое значение Описание
commands
list
всегда
Список команд, отправленных устройству

Пример:
['interface Ethernet2/3', 'mtu 1500', 'speed 10']


Статус

  • Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
  • Этот модуль поддерживается командой Ansible по работе с сетями. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье из базы знаний Red Hat: Red Hat Knowledge Base article.

Авторы

  • Jason Edelman (@jedelman8)
  • Trishna Guha (@trishnaguha)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/nxos_interface_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API