Spec-Zone.ru › Ansible 2.10

cisco.ios.ios_vrf – Управление набором определений VRF на устройствах Cisco IOS

Примечание

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

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

Для использования в книге задач, укажите: cisco.ios.ios_vrf.

Новый в версии 1.0.0: of cisco.ios

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Примечание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
associated_interfaces
список / элементы=строка
Это необязательный параметр, проверяющий оперативное состояние для заданного vrf name для ассоциированных интерфейсов. Если значение в associated_interfaces не соответствует оперативному состоянию интерфейсов vrf на устройстве, произойдёт ошибка.
delay
целое число
По умолчанию:
10
Время в секундах ожидания, прежде чем проверить оперативное состояние на удалённом устройстве.
description
строка
Предоставляет краткое описание определения VRF в текущей активной конфигурации. Значение определения VRF принимает буквенно-цифровые символы, используемые для предоставления дополнительной информации о VRF.
interfaces
список / элементы=строка
Идентифицирует набор интерфейсов, которые должны быть настроены в VRF. Интерфейсы должны быть маршрутизируемыми для размещения в VRF.
name
строка
Имя определения VRF, подлежащего управлению на удалённом устройстве IOS. Имя определения VRF — это строка ASCII, используемая для уникальной идентификации VRF. Этот аргумент взаимоисключает аргумент vrfs
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
целое число
Указывает порт для создания соединения с удалённым устройством.
ssh_keyfile
путь
Указывает SSH-ключ для проверки подлинности соединения с удалённым устройством. Это значение — путь к ключу, используемому для проверки подлинности сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Указывает время ожидания в секундах для взаимодействия с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку.
username
строка
Настраивает имя пользователя для проверки подлинности соединения с удалённым устройством. Это значение используется для проверки подлинности сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_USERNAME.
purge
булево
    Варианты:
  • нет ←
  • да
Инструктирует модуль рассматривать определение VRF как абсолютное. Он удалит все ранее настроенные VRF на устройстве.
rd
строка
Значение разделителя маршрутизатора (RD) уникально идентифицирует VRF для процессов маршрутизации на удалённой системе IOS. Значение RD имеет вид A:B, где A и B — числовые значения.
route_both
список / элементы=строка
Добавляет списки экспорта и импорта расширенных сообществ целевых маршрутов в VRF.
route_both_ipv4
список / элементы=строка
Добавляет списки экспорта и импорта расширенных сообществ целевых маршрутов в подрежиме конфигурации адресной семьи в VRF.
route_both_ipv6
список / элементы=строка
Добавляет списки экспорта и импорта расширенных сообществ целевых маршрутов в подрежиме конфигурации адресной семьи в VRF.
route_export
список / элементы=строка
Добавляет список экспорта расширенных сообществ целевых маршрутов в VRF.
route_export_ipv4
список / элементы=строка
Добавляет список экспорта расширенных сообществ целевых маршрутов в подрежиме конфигурации адресной семьи в VRF.
route_export_ipv6
список / элементы=строка
Добавляет список экспорта расширенных сообществ целевых маршрутов в подрежиме конфигурации адресной семьи в VRF.
route_import
список / элементы=строка
Добавляет список импорта расширенных сообществ целевых маршрутов в VRF.
route_import_ipv4
список / элементы=строка
Добавляет список импорта расширенных сообществ целевых маршрутов в подрежиме конфигурации адресной семьи в VRF.
route_import_ipv6
список / элементы=строка
Добавляет список импорта расширенных сообществ целевых маршрутов в подрежиме конфигурации адресной семьи в VRF.
state
строка
    Варианты:
  • присутствует ←
  • отсутствует
Настраивает состояние определения VRF, относящееся к оперативной конфигурации устройства. При значении присутствует, VRF должен быть настроен в активной конфигурации устройства, а при значении отсутствует — VRF не должен быть в активной конфигурации устройства.
vrfs
список / элементы=сырые данные
Набор объектов определения VRF, которые должны быть настроены на удалённом устройстве IOS. Элементы списка могут быть именем VRF или хэшем определений VRF и атрибутов. Этот аргумент взаимоисключает аргумент name.

Примечания

Примечание

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

Примеры

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

- name: remove a vrf named test
  cisco.ios.ios_vrf:
    name: test
    state: absent

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

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

- name: Creates a list of import RTs in address-family configuration submode for the
    VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_import_ipv4
    rd: 1:100
    route_import_ipv4:
    - 1:100
    - 3:100

- name: Creates a list of import RTs in address-family configuration submode for the
    VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_import_ipv6
    rd: 1:100
    route_import_ipv6:
    - 1:100
    - 3:100

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

- name: Creates a list of export RTs in address-family configuration submode for the
    VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_export_ipv4
    rd: 1:100
    route_export_ipv4:
    - 1:100
    - 3:100

- name: Creates a list of export RTs in address-family configuration submode for the
    VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_export_ipv6
    rd: 1:100
    route_export_ipv6:
    - 1:100
    - 3:100

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

- name: Creates a list of import and export route targets in address-family configuration
    submode for the VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_both_ipv4
    rd: 1:100
    route_both_ipv4:
    - 1:100
    - 3:100

- name: Creates a list of import and export route targets in address-family configuration
    submode for the VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_both_ipv6
    rd: 1:100
    route_both_ipv6:
    - 1:100
    - 3:100

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

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

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

Пример:
['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


Авторы

  • 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.10/collections/cisco/ios/ios_vrf_module.html

Spec-Zone.ru

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