ios_vlan – Управление VLAN на устройствах сети IOS

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

УСТЕРЕГШИЙСЯ
Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТЕРЕГШИЙСЯ

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

Описание

Этот модуль обеспечивает декларативное управление VLAN на устройствах Cisco IOS.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate -			Список определений VLAN.
associated_interfaces - добавлен в 2.5			Это опция намерений и проверяет оперативное состояние заданной vlan `name` для ассоциированных интерфейсов. Если значение в `associated_interfaces` не соответствует оперативному состоянию интерфейсов vlan на устройстве, это приведет к ошибке.
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	Задержка, которую должна подождать игра для проверки значений параметров декларативного намерения.
interfaces - / обязательно			Список интерфейсов, которые должны быть ассоциированы с VLAN.
name -			Имя VLAN.
provider словарь			Устаревший Начиная с Ansible 2.5, мы рекомендуем использовать `connection: network_cli`. Для получения дополнительной информации, пожалуйста, ознакомьтесь с руководством IOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль для использования в случае необходимости входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка / обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение хоста используется в качестве целевого адреса для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число	По умолчанию: 22	Указывает порт для использования при построении подключения к удаленному устройству.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
	username строка		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
purge логическое значение		Варианты: нет ← да	Очистить VLAN, не определенные в параметре aggregate.
state -		Варианты: наличие ← отсутствует активно приостановить	Состояние конфигурации VLAN.
vlan_id - / обязательно			Идентификатор VLAN. Диапазон от 1 до 4094.

Примечания

Примечание

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

Примеры

- name: Create vlan
  ios_vlan:
    vlan_id: 100
    name: test-vlan
    state: present

- name: Add interfaces to VLAN
  ios_vlan:
    vlan_id: 100
    interfaces:
      - GigabitEthernet0/0
      - GigabitEthernet0/1

- name: Check if interfaces is assigned to VLAN
  ios_vlan:
    vlan_id: 100
    associated_interfaces:
      - GigabitEthernet0/0
      - GigabitEthernet0/1

- name: Delete vlan
  ios_vlan:
    vlan_id: 100
    state: absent

- name: Add vlan using aggregate
  ios_vlan:
    aggregate:
    - { vlan_id: 100, name: test-vlan, interfaces: [GigabitEthernet0/1, GigabitEthernet0/2], delay: 15, state: suspend }
    - { vlan_id: 101, name: test-vlan, interfaces: GigabitEthernet0/3 }

- name: Move interfaces to a different VLAN
  ios_vlan:
    vlan_id: 102
    interfaces:
      - GigabitEthernet0/0
      - GigabitEthernet0/1

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

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

Ключ	Возвращено	Описание
commands список	всегда	Список команд конфигурации в режиме конфигурации для отправки устройству Пример: ['vlan 100', 'name test-vlan']

Статус

Этот модуль будет удален в версии 2.13. [устаревший]
Для получения дополнительной информации см. УСТЕРЕГШИЙСЯ.

Авторы

Trishna Guha (@trishnaguha)

Подсказка

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

© 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_vlan_module.html