Spec-Zone.ru › Ansible 2.11

cisco.nxos.nxos_interface – (deprecated, removed after 2022-06-01) Управляет физическими атрибутами интерфейсов.

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в плейбуке укажите: cisco.nxos.nxos_interface.

Новое в версии 1.0.0: of cisco.nxos

  • УСТЕРЕЛО
  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТЕРЕЛО

Удалён в

главной версии после 2022-06-01

Почему

Выпущены обновлённые модули с большей функциональностью

Альтернатива

nxos_interfaces

Обзор

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

Примечание

У данного модуля есть соответствующий плагин действий.

Параметры

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

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

Примечания

Примечание

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

Примеры

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

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

- name: Remove all loopback interfaces
  cisco.nxos.nxos_interface:
    name: loopback
    state: absent

- name: Remove all logical interfaces
  cisco.nxos.nxos_interface:
    interface_type: '{{ item }} '
    state: absent
  loop:
  - loopback
  - portchannel
  - svi
  - nve

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

- name: Admin down all loopback interfaces
  cisco.nxos.nxos_interface:
    name: loopback 0-1023
    admin_state: down

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

- name: Add interface using aggregate
  cisco.nxos.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
  cisco.nxos.nxos_interface:
    aggregate:
    - name: Loopback9
    - name: Loopback10
    state: absent

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

Значения возврата

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

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

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


Статус

  • Этот модуль будет удалён в основной версии после 2022-06-01. [устарел]
  • Дополнительную информацию см. в УСТАРЕВШИЙ.

Авторы

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_interface_module.html

Spec-Zone.ru

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