ios_static_route - Управление статическими маршрутами IP на устройствах сети Cisco IOS

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

Обзор
- Требования
Параметры
Примечания
Примеры
Значения возврата
Статус
- Поддержка
- Автор

Обзор

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

Требования

Ниже приведены требования к хосту, на котором будет выполняться этот модуль.

Python >= 3.3 или ipaddress пакет python

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
admin_distance			Административная дистанция статического маршрута.
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`.
mask			Маска подсети статического маршрута.
next_hop			IP-адрес следующего узла статического маршрута.
prefix			Префикс сети статического маршрута.
provider		По умолчанию: None	Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. руководство IOS Platform Options. Объект словаря, содержащий данные подключения.
	username		Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	authorize	Варианты: да нет ←	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	auth_pass	По умолчанию: нет	Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент не используется. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	host обязательно		Указывает имя DNS-хоста или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	timeout	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку.
	password	По умолчанию: None	Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port	По умолчанию: 22	Указывает порт, который используется при построении соединения с удалённым устройством.
state		Варианты: present ← absent	Состояние конфигурации статического маршрута.

Примечания

Примечание

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

Примеры

- name: configure static route
  ios_static_route:
    prefix: 192.168.2.0
    mask: 255.255.255.0
    next_hop: 10.0.0.1

- name: remove configuration
  ios_static_route:
    prefix: 192.168.2.0
    mask: 255.255.255.0
    next_hop: 10.0.0.1
    state: absent

- name: Add static route aggregates
  ios_static_route:
    aggregate:
      - { prefix: 172.16.32.0, mask: 255.255.255.0, next_hop: 10.0.0.8 }
      - { prefix: 172.16.33.0, mask: 255.255.255.0, next_hop: 10.0.0.8 }

- name: Add static route aggregates
  ios_static_route:
    aggregate:
      - { prefix: 172.16.32.0, mask: 255.255.255.0, next_hop: 10.0.0.8 }
      - { prefix: 172.16.33.0, mask: 255.255.255.0, next_hop: 10.0.0.8 }
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
commands список	всегда	Список команд режима конфигурации для отправки на устройство Пример: ['ip route 192.168.2.0 255.255.255.0 10.0.0.1']

Статус

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

Поддержка

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

Автор

Ricardo Carrillo Cruz (@rcarrillocruz)

Подсказка

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

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