nxos_ip_interface - Управляет атрибутами L3 для интерфейсов IPv4 и IPv6.
Новая версия с 2.1.
УСТАРЕВШЕЕ
| Удалено в Ansible: | |
|---|---|
| версия: 2.9 | |
| Почему: | Заменено общими модулями сети *_l3_interface. |
| Альтернатива: | Используйте nxos_l3_interface вместо этого. |
Описание
- Управляет атрибутами уровня 3 для интерфейсов IPv4 и IPv6.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ipaddress
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| addr | Адрес IPv4 или IPv6. | ||
| allow_secondary bool (добавлен в 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 NXOS Platform Options guide. Объект словаря, содержащий данные подключения. | ||
| host обязательно | Указывает имя или адрес хоста DNS для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при создании подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту соответствующего транспорта, если не указано в задаче. (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий параметр, используемый для транспорта cli или nxapi. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлен в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлен в 2.5.3) | Значение по умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize равно false, этот параметр ничего не делает. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлен в 2.3) | Значение по умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечет до завершения операции, модуль вернет ошибку. NX-API может быть медленным для возврата при длительных командах (sh mac, sh bgp и т.д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | Значение по умолчанию: "cli" | Настраивает транспортное подключение для подключения к удаленному устройству. Параметр transport поддерживает подключение к устройству по протоколу cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если значение равно true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами, которые используют самозаверяемые сертификаты. Если параметр transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлен в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| 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 NXOS Platform Options guide
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, см. руководство по сети 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.6/modules/nxos_ip_interface_module.html
