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 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 | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использоваться значение переменной окружения 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 строка / обязательно |
| Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по протоколу cli (ssh) или nxapi. | |
| use_proxy boolean добавлено в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут игнорироваться. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если значение равно yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самоподписанными сертификатами. Если аргумент transport не является 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
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible
- Для получения дополнительной информации об использовании 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 словарь | всегда | пара Ключ-Значение атрибутов 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.8/modules/nxos_ip_interface_module.html
