Spec-Zone.ru › Ansible 2.4

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

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

  • Обзор
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Состояние
    • Информация о техническом обслуживании

Обзор

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

Параметры

параметр обязательный по умолчанию варианты комментарии
auth_pass
нет нет
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
delay
(добавлен в 2.4)
нет 10
Время в секундах ожидания перед проверкой операционного состояния на удалённом устройстве.
description
нет
Предоставляет краткое описание определения VRF в текущей активной конфигурации. Значение определения VRF принимает буквенно-цифровые символы, используемые для предоставления дополнительной информации о VRF.
interfaces
нет
Идентифицирует набор интерфейсов, которые должны быть настроены в VRF. Интерфейсы должны быть маршрутизируемыми интерфейсами, чтобы быть помещены в VRF.
name
нет
Имя определения VRF, которое должно быть обработано на удалённом устройстве IOS. Имя определения VRF - это строка ASCII, используемая для уникальной идентификации VRF. Этот аргумент несовместим с аргументом vrfs
provider
нет
Объект словаря, содержащий данные подключения.
Объект словаря provider
параметр обязательный по умолчанию варианты комментарии
username
нет
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
authorize
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение - путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
auth_pass
нет нет
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
host
да
Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному каналу передачи данных. Значение host используется в качестве адреса назначения для канала передачи данных.
timeout
нет 10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
password
нет
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт для построения подключения к удалённому устройству.
purge
нет
Указывает модулю рассматривать определение VRF как абсолютное. Он удалит все ранее настроенные VRF на устройстве.
rd
нет
Значение router-distinguisher уникально идентифицирует VRF для процессов маршрутизации на удалённой системе IOS. Значение RD имеет вид A:B, где A и B - числовые значения.
state
нет present
  • present
  • absent
Настраивает состояние определения VRF, относящееся к операционной конфигурации устройства. При установке в present VRF должен быть настроен в активной конфигурации устройства, а при установке в absent VRF не должен быть в активной конфигурации устройства.
vrfs
нет
Набор объектов определения VRF, которые должны быть настроены на удалённом устройстве IOS. Элементы списка могут быть либо именем VRF, либо хешем определений и атрибутов VRF. Этот аргумент несовместим с аргументом name.

Примеры

- 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

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

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

имя описание возвращено тип образец
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

Примечания

Примечание

  • Тестировалось на IOS 15.6

Состояние

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

Информация о техническом обслуживании

Для получения дополнительной информации о поддержке этого модуля компанией Red Hat обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей, если вы заинтересованы, прочтите Информацию о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

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