nxos_ip_interface - Управляет атрибутами L3 для интерфейсов IPv4 и IPv6.
Новая версия 2.1.
- Описание
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Описание
- Управляет атрибутами уровня 3 для интерфейсов IPv4 и IPv6.
Требования (для хоста, на котором выполняется модуль)
- ipaddress
Параметры
| параметр | обязательный | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| addr | нет | Адрес IPv4 или IPv6. | ||
| allow_secondary (добавлено в 2.4)
| нет | Разрешить конфигурирование вторичных адресов IPv4 на интерфейсе. | ||
| auth_pass (добавлено в 2.4.4)
| нет | none | Указывает пароль для использования при входе в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host | да | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| interface | да | Полное имя интерфейса, например Ethernet1/1, vlan10. | ||
| mask | нет | Маска подсети для адреса IPv4 или IPv6 в десятичном формате. | ||
| password | нет | Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать общий порт) | Указывает порт для использования при установлении подключения к удаленному устройству. Это значение применяется к cli или nxapi. Значение порта будет по умолчанию установлено на соответствующий общий порт транспорта, если в задаче не указано иное. (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта dict. Все ограничения (обязательность, варианты и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом dict. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | present |
| Указывает желаемое состояние ресурса. |
| tag (добавлено в 2.4)
| нет | Метка маршрута для адреса IPv4 или IPv6 в целочисленном формате. | ||
| timeout (добавлено в 2.3)
| нет | 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает транспортное подключение для использования при подключении к удаленному устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает transport для использования SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется. |
Примеры
- 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: 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 в формате ключ/значение после выполнения модуля | всегда | dict | {'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 | параметры IP в формате ключ/значение, существующие на интерфейсе | всегда | dict | {'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 | параметры в формате ключ/значение, переданные в модуль | всегда | dict | {'interface': 'Ethernet1/32', 'allow_secondary': True, 'mask': '24', 'addr': '20.20.20.20', 'tag': 100} |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Интерфейс должен быть портом уровня 3 при использовании этого модуля.
- Логические интерфейсы (po, loop, svi) должны быть созданы предварительно.
-
maskдолжен быть вставлен в десятичном формате (например, 24) для IPv6 и IPv4. - Один интерфейс может иметь несколько настроенных IPv6.
-
tagне является идемпотентным для адресов IPv6 и I2 системной картинки.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля Red Hat, пожалуйста, обратитесь к knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если это вас интересует, пожалуйста, прочитайте Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_ip_interface_module.html