Spec-Zone.ru › Ansible 2.5

ios_vrf — Управление коллекцией определений VRF на устройствах Cisco IOS

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

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Поддержка
    • Автор

Обзор

  • Этот модуль предоставляет декларативное управление определениями VRF на устройствах Cisco IOS. Он позволяет плейбукам управлять отдельными или всей коллекцией VRF. Он также поддерживает удаление определений VRF из конфигурации, которые не определены явно.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
associated_interfaces
(добавлен в 2.5)
Это параметр намерений и проверяет оперативное состояние для заданной vrf name для связанных интерфейсов. Если значение в associated_interfaces не соответствует оперативному состоянию интерфейсов vrf на устройстве, произойдет ошибка.
auth_pass По умолчанию:
none
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass.
Дополнительную информацию см. в руководстве IOS Platform Options.
Указывает пароль для использования при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize — false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
    Варианты:
  • yes
  • нет ←
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.
Дополнительную информацию см. в руководстве IOS Platform Options.
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
delay
(добавлен в 2.4)
По умолчанию:
10
Время в секундах ожидания перед проверкой оперативного состояния на удаленном устройстве.
description
Предоставляет краткое описание определения VRF в текущей активной конфигурации. Значение определения VRF принимает алфавитно-цифровые символы для предоставления дополнительной информации о VRF.
interfaces
Определяет набор интерфейсов, которые должны быть настроены в VRF. Интерфейсы должны быть маршрутизируемыми для размещения в VRF.
name
Имя определения VRF, подлежащего управлению на удаленном устройстве IOS. Имя определения VRF — это строка ASCII, используемая для уникальной идентификации VRF. Этот аргумент взаимоисключающий с аргументом vrfs
provider По умолчанию:
None
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Дополнительную информацию см. в руководстве IOS Platform Options.
Объект словаря, содержащий данные подключения.
username
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
authorize
    Варианты:
  • yes
  • нет ←
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
auth_pass По умолчанию:
none
Указывает пароль для использования при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize — false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
host
обязательно
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
timeout По умолчанию:
10
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
password По умолчанию:
None
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
port По умолчанию:
22
Указывает порт для создания подключения к удалённому устройству.
purge По умолчанию:
нет
Указывает модулю рассматривать определение VRF как абсолютное. Он удалит все ранее настроенные VRF на устройстве.
rd
Значение роутер-дискриминатора (RD) уникально идентифицирует VRF для процессов маршрутизации на удалённой системе IOS. Значение RD имеет вид A:B, где A и B — числовые значения.
route_both
(добавлен в 2.5)
Добавляет экспорт и импорт списка расширенных сообщений целевого маршрута в VRF.
route_export
(добавлен в 2.5)
Добавляет экспорт списка расширенных сообщений целевого маршрута в VRF.
route_import
(добавлен в 2.5)
Добавляет импорт списка расширенных сообщений целевого маршрута в VRF.
state
    Варианты:
  • настроен ←
  • отсутствует
Настраивает состояние определения VRF по отношению к операционной конфигурации устройства. При значении настроен определение VRF должно быть настроено в активной конфигурации устройства, а при значении отсутствует — нет.
vrfs
Набор объектов определения VRF, подлежащих настройке на удалённом устройстве IOS. Элементы списка могут быть именем VRF или словарём из определений VRF и атрибутов. Этот аргумент взаимоисключающий с аргументом name.

Примечания

Примечание

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

Примеры

- name: configure a vrf named management
  ios_vrf:
    name: management
    description: oob mgmt vrf
    interfaces:
      - Management1

- name: remove a vrf named test
  ios_vrf:
    name: test
    state: absent

- name: configure set of VRFs and purge any others
  ios_vrf:
    vrfs:
      - red
      - blue
      - green
    purge: yes

- name: Creates a list of import RTs for the VRF with the same parameters
  ios_vrf:
    name: test_import
    rd: 1:100
    route_import:
      - 1:100
      - 3:100

- name: Creates a list of export RTs for the VRF with the same parameters
  ios_vrf:
    name: test_export
    rd: 1:100
    route_export:
      - 1:100
      - 3:100

- name: Creates a list of import and export route targets for the VRF with the same parameters
  ios_vrf:
    name: test_both
    rd: 1:100
    route_both:
      - 1:100
      - 3:100

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

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

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

Пример:
['vrf definition ansible', 'description management vrf', {'rd': '1:100'}]
delta
строка
всегда
Время, затраченное на выполнение всех операций

Пример:
0:00:10.469466
end
строка
всегда
Время завершения задания

Пример:
2016-11-16 10:38:25.595612
start
строка
всегда
Время начала задания

Пример:
2016-11-16 10:38:15.126146


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Поддержка

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

Автор

  • Peter Sprygada (@privateip)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ios_vrf_module.html

Spec-Zone.ru

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