Spec-Zone.ru › Ansible

Модуль dellemc.enterprise_sonic.sonic_dhcp_relay – управление конфигурациями ретрансляции DHCP и DHCPv6 на SONiC

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить коллекцию, используйте: ansible-galaxy collection install dellemc.enterprise_sonic.

Чтобы использовать её в плейбуке, укажите: dellemc.enterprise_sonic.sonic_dhcp_relay.

Добавлено в dellemc.enterprise_sonic 2.1.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль управляет конфигурацией параметров ретрансляции DHCP и DHCPv6 на интерфейсах уровня 3 устройств под управлением SONiC.
  • Интерфейс уровня 3 и имя VRF необходимо предварительно создать на устройстве.

Параметры

Параметр

Описание

config

list / elements=dictionary

Задает конфигурации ретрансляции DHCP и DHCPv6.

ipv4

dictionary

Конфигурации ретрансляции DHCP, применяемые к интерфейсу, указанному в параметре name.

circuit_id

string

Задает формат circuit-id для ретрансляции DHCP.

%h:%p - имя узла, за которым следует имя интерфейса, например sonic:Vlan100

%i - имя физического интерфейса, например Eth1/2

%p - имя интерфейса, например Vlan100

Варианты:

  • "%h:%p"
  • "%i"
  • "%p"

link_select

boolean

Включает субопцию выбора канала связи.

Варианты:

  • false
  • true

max_hop_count

integer

Задает максимальное число переходов для пакетов ретрансляции DHCP.

Диапазон: от 1 до 16.

policy_action

string

Задает политику обработки параметров ретрансляции DHCP.

Варианты:

  • "append"
  • "discard"
  • "replace"

server_addresses

list / elements=dictionary

Список IPv4-адресов DHCP-серверов.

address

string

IPv4-адрес DHCP-сервера.

source_interface

string

Задает исходный интерфейс ретрансляции DHCP.

vrf_name

string

Задает имя VRF, в которой находится DHCP-сервер.

Этот параметр не используется при состоянии deleted.

vrf_select

boolean

Включает субопцию выбора VRF.

Варианты:

  • false
  • true

ipv6

dictionary

Конфигурации ретрансляции DHCPv6, применяемые к интерфейсу, указанному в параметре name.

max_hop_count

integer

Задает максимальное число переходов для пакетов ретрансляции DHCPv6.

Диапазон: от 1 до 16.

server_addresses

list / elements=dictionary

Список IPv6-адресов DHCPv6-серверов.

address

string

IPv6-адрес DHCPv6-сервера.

source_interface

string

Задает исходный интерфейс ретрансляции DHCPv6.

vrf_name

string

Задает имя VRF, в которой находится DHCPv6-сервер.

Этот параметр используется только при состоянии merged.

vrf_select

boolean

Включает субопцию выбора VRF.

Варианты:

  • false
  • true

name

string / обязательный

Полное имя интерфейса уровня 3, например Eth1/1.

state

string

Состояние конфигурации после выполнения модуля.

merged - Объединяет предоставленную конфигурацию ретрансляции DHCP и DHCPv6 с конфигурацией устройства.

deleted - Удаляет конфигурацию ретрансляции DHCP и DHCPv6 на устройстве.

replaced - Заменяет конфигурацию ретрансляции DHCP и DHCPv6 на устройстве для указанных интерфейсов предоставленной конфигурацией.

overridden - Переопределяет все конфигурации ретрансляции DHCP и DHCPv6 на устройстве предоставленной конфигурацией.

Варианты:

  • "merged" ← (по умолчанию)
  • "deleted"
  • "replaced"
  • "overridden"

Примечания

Примечание

  • Проверено на Enterprise SONiC Distribution от Dell Technologies.
  • Поддерживает check_mode.

Примеры

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 92.1.1.1 vrf VrfReg1
#  ip dhcp-relay max-hop-count 5
#  ip dhcp-relay vrf-select
#  ip dhcp-relay policy-action append
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 91::1 92::1
#  ipv6 dhcp-relay max-hop-count 5
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1 73.1.1.1
#  ip dhcp-relay source-interface Vlan100
#  ip dhcp-relay link-select
#  ip dhcp-relay circuit-id %h:%p
# !

- name: Delete DHCP and DHCPv6 relay configurations
  dellemc.enterprise_sonic.sonic_dhcp_relay:
    config:
      - name: 'Eth1/1'
        ipv4:
          server_addresses:
            - address: '92.1.1.1'
          vrf_select: true
          max_hop_count: 5
        ipv6:
          server_addresses:
            - address: '91::1'
            - address: '92::1'
      - name: 'Eth1/2'
        ipv4:
          server_addresses:
            - address: '71.1.1.1'
            - address: '72.1.1.1'
          source_interface: 'Vlan100'
          link_select: true
          circuit_id: '%h:%p'
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 vrf VrfReg1
#  ip dhcp-relay policy-action append
#  ipv6 address 81::1/24
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 73.1.1.1
# !


# Using "deleted" state
#
# NOTE: Support is provided in the dhcp_relay resource module for deletion of all attributes for a
# given address family (IPv4 or IPv6) by using a "special" YAML sequence specifying a server address list
# containing a single "blank" IP address under the target address family. The following example shows
# a task using this syntax for deletion of all DHCP (IPv4) configurations for an interface, but the
# equivalent syntax is supported for DHCPv6 (IPv6) as well.
#
# Before state:
# -------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 92.1.1.1 vrf VrfReg1
#  ip dhcp-relay max-hop-count 5
#  ip dhcp-relay vrf-select
#  ip dhcp-relay policy-action append
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 91::1 92::1
#  ipv6 dhcp-relay max-hop-count 5
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1 73.1.1.1
#  ip dhcp-relay source-interface Vlan100
#  ip dhcp-relay link-select
#  ip dhcp-relay circuit-id %h:%p
# !

- name: Delete all IPv4 DHCP relay configurations for interface Eth1/1
  dellemc.enterprise_sonic.sonic_dhcp_relay:
    config:
      - name: 'Eth1/1'
        ipv4:
          server_addresses:
            - address:
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 91::1 92::1
#  ipv6 dhcp-relay max-hop-count 5
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1 73.1.1.1
#  ip dhcp-relay source-interface Vlan100
#  ip dhcp-relay link-select
#  ip dhcp-relay circuit-id %h:%p
# !


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 92.1.1.1 vrf VrfReg1
#  ip dhcp-relay max-hop-count 5
#  ip dhcp-relay vrf-select
#  ip dhcp-relay policy-action append
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 91::1 92::1
#  ipv6 dhcp-relay max-hop-count 5
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1 73.1.1.1
#  ip dhcp-relay source-interface Vlan100
#  ip dhcp-relay link-select
#  ip dhcp-relay circuit-id %h:%p
# !

- name: Delete all DHCP and DHCPv6 relay configurations for interface Eth1/1
  dellemc.enterprise_sonic.sonic_dhcp_relay:
    config:
      - name: 'Eth1/1'
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ipv6 address 81::1/24
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1 73.1.1.1
#  ip dhcp-relay source-interface Vlan100
#  ip dhcp-relay link-select
#  ip dhcp-relay circuit-id %h:%p
# !


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 92.1.1.1 vrf VrfReg1
#  ip dhcp-relay max-hop-count 5
#  ip dhcp-relay vrf-select
#  ip dhcp-relay policy-action append
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 91::1 92::1
#  ipv6 dhcp-relay max-hop-count 5
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1 73.1.1.1
#  ip dhcp-relay source-interface Vlan100
#  ip dhcp-relay link-select
#  ip dhcp-relay circuit-id %h:%p
# !

- name: Delete all DHCP and DHCPv6 relay configurations
  dellemc.enterprise_sonic.sonic_dhcp_relay:
    config:
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ipv6 address 81::1/24
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
# !


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ipv6 address 81::1/24
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1
# !

- name: Add DHCP and DHCPv6 relay configurations
  dellemc.enterprise_sonic.sonic_dhcp_relay:
    config:
      - name: 'Eth1/1'
        ipv4:
          server_addresses:
            - address: '91.1.1.1'
            - address: '92.1.1.1'
          vrf_name: 'VrfReg1'
          vrf_select: true
          max_hop_count: 5
          policy_action: 'append'
        ipv6:
          server_addresses:
            - address: '91::1'
            - address: '92::1'
          max_hop_count: 5
      - name: 'Eth1/2'
        ipv4:
          server_addresses:
            - address: '73.1.1.1'
          source_interface: 'Vlan100'
          link_select: true
          circuit_id: '%h:%p'
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 92.1.1.1 vrf VrfReg1
#  ip dhcp-relay max-hop-count 5
#  ip dhcp-relay vrf-select
#  ip dhcp-relay policy-action append
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 91::1 92::1
#  ipv6 dhcp-relay max-hop-count 5
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1 73.1.1.1
#  ip dhcp-relay source-interface Vlan100
#  ip dhcp-relay link-select
#  ip dhcp-relay circuit-id %h:%p
# !


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 92.1.1.1 vrf VrfReg1
#  ip dhcp-relay max-hop-count 5
#  ip dhcp-relay vrf-select
#  ip dhcp-relay policy-action append
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 91::1 92::1
#  ipv6 dhcp-relay max-hop-count 5
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1 73.1.1.1
#  ip dhcp-relay source-interface Vlan100
#  ip dhcp-relay link-select
#  ip dhcp-relay circuit-id %h:%p
#  ipv6 address 61::1/24
#  ipv6 dhcp-relay 71::1 72::1
# !
# interface Eth1/3
#  mtu 9100
#  speed 400000
#  fec RS
#  shutdown
#  ip address 41.1.1.1/24
#  ip dhcp-relay 51.1.1.1 52.1.1.1
#  ip dhcp-relay circuit-id %h:%p
#  ipv6 address 41::1/24
#  ipv6 dhcp-relay 51::1 52::1
# !

- name: Replace DHCP and DHCPv6 relay configurations of specified interfaces
  dellemc.enterprise_sonic.sonic_dhcp_relay:
    config:
      - name: 'Eth1/1'
        ipv4:
          server_addresses:
            - address: '91.1.1.1'
            - address: '93.1.1.1'
            - address: '95.1.1.1'
          vrf_name: 'VrfReg1'
          vrf_select: true
        ipv6:
          server_addresses:
            - address: '93::1'
            - address: '94::1'
          source_interface: 'Vlan100'
      - name: 'Eth1/2'
        ipv4:
          server_addresses:
            - address: '73.1.1.1'
          circuit_id: '%h:%p'
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 93.1.1.1 95.1.1.1 vrf VrfReg1
#  ip dhcp-relay vrf-select
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 93::1 94::1
#  ipv6 dhcp-relay source-interface Vlan100
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 73.1.1.1
#  ip dhcp-relay circuit-id %h:%p
#  ipv6 address 61::1/24
# !
# interface Eth1/3
#  mtu 9100
#  speed 400000
#  fec RS
#  shutdown
#  ip address 41.1.1.1/24
#  ip dhcp-relay 51.1.1.1 52.1.1.1
#  ip dhcp-relay circuit-id %h:%p
#  ipv6 address 41::1/24
#  ipv6 dhcp-relay 51::1 52::1
# !


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 92.1.1.1 vrf VrfReg1
#  ip dhcp-relay max-hop-count 5
#  ip dhcp-relay vrf-select
#  ip dhcp-relay policy-action append
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 91::1 92::1
#  ipv6 dhcp-relay max-hop-count 5
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 71.1.1.1 72.1.1.1 73.1.1.1
#  ip dhcp-relay source-interface Vlan100
#  ip dhcp-relay link-select
#  ip dhcp-relay circuit-id %h:%p
#  ipv6 address 61::1/24
#  ipv6 dhcp-relay 71::1 72::1
# !
# interface Eth1/3
#  mtu 9100
#  speed 400000
#  fec RS
#  shutdown
#  ip address 41.1.1.1/24
#  ip dhcp-relay 51.1.1.1 52.1.1.1
#  ip dhcp-relay circuit-id %h:%p
#  ipv6 address 41::1/24
#  ipv6 dhcp-relay 51::1 52::1
# !

- name: Override DHCP and DHCPv6 relay configurations
  dellemc.enterprise_sonic.sonic_dhcp_relay:
    config:
      - name: 'Eth1/1'
        ipv4:
          server_addresses:
            - address: '91.1.1.1'
            - address: '93.1.1.1'
            - address: '95.1.1.1'
          vrf_name: 'VrfReg1'
          vrf_select: true
        ipv6:
          server_addresses:
            - address: '93::1'
            - address: '94::1'
          source_interface: 'Vlan100'
      - name: 'Eth1/2'
        ipv4:
          server_addresses:
            - address: '73.1.1.1'
          circuit_id: '%h:%p'
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration interface
# !
# interface Eth1/1
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 81.1.1.1/24
#  ip dhcp-relay 91.1.1.1 93.1.1.1 95.1.1.1 vrf VrfReg1
#  ip dhcp-relay vrf-select
#  ipv6 address 81::1/24
#  ipv6 dhcp-relay 93::1 94::1
#  ipv6 dhcp-relay source-interface Vlan100
# !
# interface Eth1/2
#  mtu 9100
#  speed 400000
#  fec RS
#  no shutdown
#  ip address 61.1.1.1/24
#  ip dhcp-relay 73.1.1.1
#  ip dhcp-relay circuit-id %h:%p
#  ipv6 address 61::1/24
# !
# interface Eth1/3
#  mtu 9100
#  speed 400000
#  fec RS
#  shutdown
#  ip address 41.1.1.1/24
#  ipv6 address 41::1/24
# !

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ

Описание

after

list / elements=string

Конфигурация после выполнения модуля.

Возвращается: при изменении

Пример: ["The configuration returned will always be in the same format as the parameters above.\n"]

after(generated)

list / elements=string

Сгенерированная конфигурация модуля.

Возвращается: когда check_mode

Пример: ["The configuration returned will always be in the same format as the parameters above.\n"]

before

list / elements=string

Конфигурация до выполнения модуля.

Возвращается: всегда

Пример: ["The configuration returned will always be in the same format as the parameters above.\n"]

commands

list / elements=string

Набор команд, отправленных на удаленное устройство.

Возвращается: всегда

Пример: ["command 1", "command 2", "command 3"]

Авторы

  • Arun Saravanan Balachandran (@ArunSaravananBalachandran)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/enterprise_sonic/sonic_dhcp_relay_module.html

Spec-Zone.ru

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