bigip_static_route - Управление статическими маршрутами на BIG-IP
Новое в версии 2.5.
Обзор
- Управление статическими маршрутами на BIG-IP.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.9
- netaddr
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description | Дескриптивный текст, идентифицирующий маршрут. | ||
| destination | Указывает IP-адрес для статической записи в таблице маршрутизации. При создании нового статического маршрута это значение обязательно. Это значение нельзя изменить после его установки. | ||
| gateway_address | Указывает маршрутизатор, который система должна использовать для пересылки пакетов целевому хосту или сети. Также известен как адрес маршрутизатора следующего перехода. Это может быть IPv4 или IPv6 адрес. Если это IPv6 адрес, начинающийся с FE80:, адрес будет обрабатываться как адрес локальной сети. Для этого требуется также указать параметр vlan. | ||
| mtu | Указывает определенный максимальный размер пакета (MTU). | ||
| name обязательно | Имя статического маршрута. | ||
| netmask | Маска подсети для статического маршрута. При создании нового статического маршрута это значение обязательно. Это значение может быть в формате IP или CIDR. Это значение нельзя изменить после его установки. | ||
| partition (добавлено в 2.6) | По умолчанию: "Общие" | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| pool | Указывает пул, через который система пересылает пакеты к месту назначения. | ||
| provider (добавлено в 2.5) | Объект словаря, содержащий данные подключения. | ||
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с самозаверяемыми сертификатами. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| timeout | По умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернет ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| reject bool |
| Указывает, что система отбрасывает пакеты, отправленные к месту назначения. | |
| route_domain | Идентификатор домена маршрутизации системы. При создании нового статического маршрута, если это значение не указано, будет использоваться значение по умолчанию 0. Это значение нельзя изменить после его установки. | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| state |
| Когда present, гарантирует, что статический маршрут существует.Когда absent, гарантирует, что статический маршрут не существует. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с самозаверяемыми сертификатами. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| vlan | Указывает VLAN или туннель, через который система пересылает пакеты к месту назначения. Если gateway_address это адрес локальной сети IPv6, это значение требуется. | ||
Примечания
Примечание
- Требуется пакет netaddr Python на хосте. Это так же просто, как pip install netaddr.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Create static route with gateway address
bigip_static_route:
destination: 10.10.10.10
netmask: 255.255.255.255
gateway_address: 10.2.2.3
name: test-route
password: secret
server: lb.mydomain.come
user: admin
validate_certs: no
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | изменено | Включён или выключен баннер. Пример: True |
| destination строка | изменено | Включён или выключен баннер. Пример: True |
| gateway_address строка | изменено | Включён или выключен баннер. Пример: True |
| netmask строка | изменено | Маска сети назначения. Пример: 255.255.255.255 |
| partition строка | изменено | Раздел, на котором была создана статическая маршрутизация. Пример: Common |
| pool строка | изменено | Включён или выключен баннер. Пример: True |
| reject строка | изменено | Включён или выключен баннер. Пример: True |
| route_domain целое число | изменено | Домен маршрутизации статического маршрута. Пример: 1 |
| vlan строка | изменено | Включён или выключен баннер. Пример: True |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут внесены несовместимые изменения в интерфейс.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. в разделе здесь.
Автор
- Tim Rupp (@caphrim007)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/bigip_static_route_module.html