nxos_ip_interface — Управляет атрибутами L3 для интерфейсов IPv4 и IPv6.
Новая версия 2.1.
УСТАРЕВШЕЕ
| Удалено в Ansible: | |
|---|---|
| версия: 2.9 | |
| Почему: | Заменено общими модулями сети *_l3_interface. |
| Альтернатива: | Используйте nxos_l3_interface вместо этого. |
Описание
- Управляет атрибутами уровня 3 для интерфейсов IPv4 и IPv6.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ipaddress
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| addr | Значение по умолчанию: None | Адрес IPv4 или IPv6. | |
| allow_secondary (добавлено в 2.4) | Значение по умолчанию: нет | Разрешить конфигурацию вторичных адресов IPv4 на интерфейсе. | |
| dot1q (добавлено в 2.5) | Значение по умолчанию: None | Настраивает инкапсуляцию VLAN IEEE 802.1Q на подинтерфейсе. Диапазон от 2 до 4093. | |
| interface обязательно | Полное имя интерфейса, например, Ethernet1/1, vlan10. | ||
| mask | Значение по умолчанию: None | Маска подсети для адреса IPv4 или IPv6 в десятичном формате. | |
| provider | Значение по умолчанию: None | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| authorize (добавлено в 2.5.3) |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| auth_pass (добавлено в 2.5.3) | Значение по умолчанию: none | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize ложно, этот аргумент не имеет эффекта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| timeout (добавлено в 2.3) | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т. д.). | |
| use_ssl |
| Настраивает транспорт для использования SSL, если значение равно true, только если transport=nxapi, в противном случае это значение игнорируется. | |
| password | Значение по умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для cli или nxapi транспортов. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | |
| validate_certs |
None | Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Если аргумент транспорта не nxapi, это значение игнорируется. | |
| port | Значение по умолчанию: 0 (использовать стандартный порт) | Указывает порт для подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию соответствовать стандартному порту для транспорта, если оно не предоставлено в задаче (cli=22, http=80, https=443). | |
| transport обязательно | Значение по умолчанию: cli | Настраивает транспортное подключение, используемое при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| state |
| Укажите желаемое состояние ресурса. | |
| tag (добавлено в 2.4) | Значение по умолчанию: 0 | Тег маршрута для адреса IPv4 или IPv6 в целых числах. | |
| version |
| Версия IP-адреса. Если IP-адрес IPv4, версия должна быть v4. Если IP-адрес IPv6, версия должна быть v6. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Интерфейс должен быть портом L3 при использовании этого модуля.
- Логические интерфейсы (po, loop, svi) должны быть созданы предварительно.
-
maskдолжно быть вставлено в десятичном формате (например, 24) как для IPv6, так и для IPv4. - Один интерфейс может иметь несколько настроенных адресов IPv6.
-
tagне идемпотентен для адресов IPv6 и I2 системы. - Подробную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: Ensure ipv4 address is configured on Ethernet1/32
nxos_ip_interface:
interface: Ethernet1/32
transport: nxapi
version: v4
state: present
addr: 20.20.20.20
mask: 24
- name: Ensure ipv6 address is configured on Ethernet1/31
nxos_ip_interface:
interface: Ethernet1/31
transport: cli
version: v6
state: present
addr: '2001::db8:800:200c:cccb'
mask: 64
- name: Ensure ipv4 address is configured with tag
nxos_ip_interface:
interface: Ethernet1/32
transport: nxapi
version: v4
state: present
tag: 100
addr: 20.20.20.20
mask: 24
- name: Ensure ipv4 address is configured on sub-intf with dot1q encapsulation
nxos_ip_interface:
interface: Ethernet1/32.10
transport: nxapi
version: v4
state: present
dot1q: 10
addr: 20.20.20.20
mask: 24
- name: Configure ipv4 address as secondary if needed
nxos_ip_interface:
interface: Ethernet1/32
transport: nxapi
version: v4
state: present
allow_secondary: true
addr: 21.21.21.21
mask: 24
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны здесь, а следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | всегда | проверка, было ли внесено изменение на устройстве Пример: True |
| commands список | всегда | команды, отправленные на устройство Пример: ['interface ethernet1/32', 'ip address 20.20.20.20/24 secondary tag 100'] |
| end_state словарь | всегда | пара k/v атрибутов IP после выполнения модуля Пример: {'interface': 'ethernet1/32', 'prefixes': ['11.11.0.0/17', '20.20.20.0/24'], 'type': 'ethernet', 'addresses': [{'tag': 101, 'mask': 17, 'addr': '11.11.11.11', 'secondary': False}, {'tag': 100, 'mask': 24, 'addr': '20.20.20.20', 'secondary': True}], 'vrf': 'default'} |
| existing словарь | всегда | пара k/v существующих атрибутов IP на интерфейсе Пример: {'interface': 'ethernet1/32', 'prefixes': ['11.11.0.0/17'], 'type': 'ethernet', 'addresses': [{'tag': 101, 'mask': 17, 'addr': '11.11.11.11', 'secondary': False}], 'vrf': 'default'} |
| proposed словарь | всегда | пара k/v параметров, переданных в модуль Пример: {'interface': 'Ethernet1/32', 'allow_secondary': True, 'mask': '24', 'addr': '20.20.20.20', 'tag': 100} |
Состояние
Этот модуль помечен как устаревший и будет удален в версии 2.9. Дополнительную информацию см. в разделе УСТАРЕВШЕЕ.
Автор
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/nxos_ip_interface_module.html
