Spec-Zone.ru › Ansible 2.7

nxos_ip_interface – Управляет атрибутами L3 для интерфейсов IPv4 и IPv6.

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

  • УСТАРЕЛО
  • Синопсис
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

УСТАРЕЛО

Удалено в Ansible:
версия: 2.9
Почему: Заменено на общие модули сети *_l3_interface.
Альтернатива: Используйте nxos_l3_interface вместо этого.

Синопсис

  • Управляет атрибутами третьего уровня (L3) для интерфейсов IPv4 и IPv6.

Требования

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

  • ipaddress

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
addr
-
Адрес IPv4 или IPv6.
allow_secondary
boolean
добавлен в 2.4
    Варианты:
  • нет ←
  • да
Разрешить конфигурирование вторичных адресов IPv4 на интерфейсе.
dot1q
-
добавлен в 2.5
Конфигурирует инкапсуляцию VLAN IEEE 802.1Q на подинтерфейсе. Диапазон от 2 до 4093.
interface
- / обязательно
Полное имя интерфейса, например Ethernet1/1, vlan10.
mask
-
Маска подсети для IPv4 или IPv6 адреса в десятичном формате.
provider
-
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр требуется только при использовании NX-API.
Дополнительная информация в руководстве NXOS Platform Options.
Объект словаря, содержащий данные соединения.
auth_pass
-
добавлен в 2.5.3
 Значение по умолчанию:
"none"
Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот параметр не влияет. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
boolean
добавлен в 2.5.3
    Варианты:
  • нет ←
  • да
Указывает модулю на вход в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
host
- / обязательно
Указывает имя или адрес хоста DNS для подключения к удалённому устройству через указанный транспорт. Значение host используется как адрес назначения для транспорта.
password
-
Указывает пароль для аутентификации подключения к удалённому устройству. Это общий параметр, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
port
-
Значение по умолчанию:
"0 (использовать общий порт)"
Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует обычному порту транспорта, если не указано в задаче. (cli=22, http=80, https=443).
ssh_keyfile
-
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
-
добавлен в 2.3
 Значение по умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результат при длительных командах (sh mac, sh bgp и т. д.).
transport
- / обязательно
Значение по умолчанию:
"cli"
Настраивает транспортное соединение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi.
use_proxy
boolean
добавлен в 2.5
    Варианты:
  • нет
  • да ←
Если no, переменные среды http_proxy и https_proxy будут проигнорированы.
use_ssl
boolean
    Варианты:
  • нет ←
  • да
Настраивает transport на использование SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется.
username
-
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
validate_certs
boolean
    Варианты:
  • нет
  • да
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых локальных сайтах с самоподписанными сертификатами. Если параметр transport не nxapi, это значение игнорируется.
state
-
    Варианты:
  • present ←
  • absent
Указывает желаемое состояние ресурса.
tag
-
добавлен в 2.4
 Значение по умолчанию:
0
Тег маршрута для адреса IPv4 или IPv6 в целочисленном формате.
version
-
    Варианты:
  • v4 ←
  • v6
Версия 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 Cisco integration page.

Примеры

- 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
словарь
 всегда
пары ключ-значение атрибутов IP после выполнения модуля

Пример:
{'addresses': [{'addr': '11.11.11.11', 'mask': 17, 'tag': 101, 'secondary': False}, {'addr': '20.20.20.20', 'mask': 24, 'tag': 100, 'secondary': True}], 'interface': 'ethernet1/32', 'prefixes': ['11.11.0.0/17', '20.20.20.0/24'], 'type': 'ethernet', 'vrf': 'default'}
existing
словарь
 всегда
пары ключ-значение существующих атрибутов IP на интерфейсе

Пример:
{'addresses': [{'addr': '11.11.11.11', 'mask': 17, 'tag': 101, 'secondary': False}], 'interface': 'ethernet1/32', 'prefixes': ['11.11.0.0/17'], 'type': 'ethernet', 'vrf': 'default'}
proposed
словарь
 всегда
пары ключ-значение параметров, переданных в модуль

Пример:
{'addr': '20.20.20.20', 'allow_secondary': True, 'interface': 'Ethernet1/32', 'mask': '24', '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.7/modules/nxos_ip_interface_module.html

Spec-Zone.ru

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