Spec-Zone.ru › Ansible 2.9

ios_interface – Управление интерфейсом на устройствах Cisco IOS

Новое в версии 2.4.

  • УСТАРЕВШИЙ
  • Синопсис
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

УСТАРЕВШИЙ

Удалено в Ansible:
версия: 2.13
Почему: Выпущены новые и обновлённые модули с большей функциональностью в Ansible 2.9
Альтернатива: ios_interfaces

Синопсис

  • Этот модуль предоставляет декларативное управление интерфейсами на устройствах Cisco IOS.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aggregate
-
Список определений интерфейсов.
auth_pass
строка
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass.
Для получения дополнительной информации см. руководство IOS Platform Options.
Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
логическое значение
    Варианты:
  • нет ←
  • да
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.
Для получения дополнительной информации см. руководство IOS Platform Options.
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
delay
-
По умолчанию:
10
Время в секундах ожидания перед проверкой операционного состояния на удалённом устройстве. Это ожидание применимо к операционному состоянию аргумента state со значениями up/down, tx_rate и rx_rate.
description
-
Описание интерфейса.
duplex
-
    Варианты:
  • полный
  • полудуплексный
  • авто ←
Состояние связи интерфейса
enabled
логическое значение
    Варианты:
  • нет
  • да
Состояние связи интерфейса.
mtu
-
Максимальный размер передаваемого пакета.
name
- / обязательно
Имя интерфейса.
neighbors
-
Проверка операционного состояния данного интерфейса name для соседа CDP/LLDP.
Доступны следующие подварианты.
host
-
Хост соседа CDP/LLDP для данного интерфейса name.
port
-
Порт соседа CDP/LLDP, к которому подключён данный интерфейс name.
provider
словарь
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Для получения дополнительной информации см. руководство IOS Platform Options.
Объект словаря, содержащий данные подключения.
auth_pass
строка
Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
логическое значение
    Варианты:
  • нет ←
  • да
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
host
строка / обязательно
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password
строка
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
port
целое число
По умолчанию:
22
Указывает порт для создания подключения к удалённому устройству.
ssh_keyfile
путь
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
По умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку.
username
строка
Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
rx_rate
-
Скорость приёма в битах в секунду (бит/с).
Этот параметр используется только для проверки состояния.
Поддерживает условные выражения, см. Условные выражения в сетевых модулях
speed
-
Скорость интерфейса.
state
-
    Варианты:
  • present ←
  • absent
  • up
  • down
Состояние конфигурации интерфейса, up означает присутствие и операционное состояние «включено», а down означает присутствие и операционное состояние down.
tx_rate
-
Скорость передачи в битах в секунду (бит/с).
Этот параметр используется только для проверки состояния.
Поддерживает условные выражения, см. Условные выражения в сетевых модулях

Примечания

Примечание

  • Проверено на IOS 15.6
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
  • Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- name: configure interface
  ios_interface:
      name: GigabitEthernet0/2
      description: test-interface
      speed: 100
      duplex: half
      mtu: 512

- name: remove interface
  ios_interface:
    name: Loopback9
    state: absent

- name: make interface up
  ios_interface:
    name: GigabitEthernet0/2
    enabled: True

- name: make interface down
  ios_interface:
    name: GigabitEthernet0/2
    enabled: False

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

- name: Check neighbors intent arguments
  ios_interface:
    name: Gi0/0
    neighbors:
    - port: eth0
      host: netdev

- name: Config + intent
  ios_interface:
    name: GigabitEthernet0/2
    enabled: False
    state: down

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

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

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

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

Ключ Возвращаемое значение Описание
commands
список
всегда, за исключением платформ, использующих транспорт Netconf для управления устройством.
Список команд режима конфигурации, которые необходимо отправить устройству.

Пример:
['interface GigabitEthernet0/2', 'description test-interface', 'duplex half', 'mtu 512']


Статус

  • Этот модуль будет удален в версии 2.13. [устаревший]
  • Дополнительную информацию см. в УСТАРЕВШЕЕ.

Авторы

  • Ganesh Nalawade (@ganeshrn)

Подсказка

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

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

Spec-Zone.ru

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