community.network.ce_sflow – Управляет конфигурацией sFlow на коммутаторах HUAWEI CloudEngine.
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.ce_sflow.
Обзор
- Настройка выборочного потока (sFlow) для мониторинга трафика на интерфейсе в реальном времени, обнаружения аномального трафика и определения источника атакующего трафика, обеспечивая стабильную работу сети.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| agent_ip строка | Указывает IPv4/IPv6 адрес агента sFlow. | |
| collector_datagram_size строка | Указывает максимальную длину пакетов sFlow, отправляемых агентом sFlow коллектору sFlow. Значение — целое число в байтах. Диапазон от 1024 до 8100. Значение по умолчанию — 1400. | |
| collector_description строка | Указывает описание коллектора sFlow. Значение — строка от 1 до 255 символов, чувствительная к регистру, без пробелов. | |
| collector_id строка |
| Указывает идентификатор коллектора sFlow. Этот идентификатор используется при указании коллектора в последующей конфигурации sFlow. |
| collector_ip строка | Указывает IPv4/IPv6 адрес коллектора sFlow. | |
| collector_ip_vpn строка | Указывает имя экземпляра VPN. Значение — строка от 1 до 31 символа, чувствительная к регистру, пробелы не поддерживаются. При использовании двойных кавычек вокруг строки, пробелы в строке разрешены. Значение _public_ зарезервировано и не может быть использовано в качестве имени экземпляра VPN. | |
| collector_meth строка |
| Настраивает устройство на отправку пакетов sFlow через сервисные интерфейсы, повышая возможности переадресации пакетов sFlow. Параметр enhanced необязателен. Независимо от того, настраивается ли режим enhanced, коммутатор определяет отправку пакетов sFlow через сервисные карты или интерфейс управления на основе маршрутной информации о коллекторе. Когда значение равно meth, устройство пересылает пакеты sFlow на уровне управления. Когда значение равно enhanced, устройство пересылает пакеты sFlow на уровне пересылки для повышения пропускной способности пересылки пакетов sFlow. |
| collector_udp_port строка | Указывает номер UDP-порта назначения для пакетов sFlow. Значение — целое число от 1 до 65535. Значение по умолчанию — 6343. | |
| counter_collector строка | Указывает список идентификаторов коллектора счетчиков. | |
| counter_interval строка | Указывает интервал опроса счетчиков. Значение — целое число от 10 до 4294967295, в секундах. Значение по умолчанию — 20. | |
| export_route строка |
| Настраивает пакеты sFlow, отправляемые коммутатором, чтобы не нести маршрутную информацию. |
| forward_enp_slot строка добавлено в 0.2.0 community.network | Включает функциональность чипа Embedded Network Processor (ENP). Коммутатор использует чип ENP для выборки sFlow, и максимальный интервал выборки sFlow составляет 65535. Если вы установите интервал выборки больше 65535, коммутатор автоматически восстановит его до 65535. Значение — целое число или 'all'. | |
| rate_limit строка добавлено в 0.2.0 community.network | Указывает скорость пакетов sFlow, отправляемых картой на уровень управления. Значение — целое число от 100 до 1500, в пакетах в секунду (pps). | |
| rate_limit_slot строка добавлено в 0.2.0 community.network | Указывает слот, где ограничена скорость выходных пакетов sFlow. Если этот параметр не указан, скорость пакетов sFlow, отправляемых со всех карт на уровень управления, ограничивается. Значение — целое число или строка символов. | |
| sample_collector строка | Указывает список идентификаторов коллектора. | |
| sample_direction строка |
| Включает выборку потока входящем или исходящем направлении. |
| sample_length строка | Указывает максимальную длину выборочных пакетов. Значение — целое число от 18 до 512, в байтах. Значение по умолчанию — 128. | |
| sample_rate строка | Указывает скорость выборки потока в формате 1/скорость. Значение — целое число от 1 до 4294967295. Значение по умолчанию — 8192. | |
| sflow_interface строка | Полное имя интерфейса для выборки потока или счетчиков. Это должен быть физический интерфейс, Eth-Trunk или под-интерфейс уровня 2. | |
| source_ip строка | Указывает исходный IPv4/IPv6 адрес пакетов sFlow. | |
| state строка |
| Определяет, должен ли конфигурация быть present или не присутствовать на устройстве. |
Примечания
Примечание
- Для данного модуля требуется, чтобы служба системы netconf была включена на управляемом удаленном устройстве.
- Рекомендуемое подключение —
netconf. - Этот модуль также работает с
localподключениями для устаревших книг задач.
Примеры
---
- name: Sflow module test
hosts: ce128
connection: local
gather_facts: no
vars:
cli:
host: "{{ inventory_hostname }}"
port: "{{ ansible_ssh_port }}"
username: "{{ username }}"
password: "{{ password }}"
transport: cli
tasks:
- name: Configuring sFlow Agent
community.network.ce_sflow:
agent_ip: 6.6.6.6
provider: '{{ cli }}'
- name: Configuring sFlow Collector
community.network.ce_sflow:
collector_id: 1
collector_ip: 7.7.7.7
collector_ip_vpn: vpn1
collector_description: Collector1
provider: '{{ cli }}'
- name: Configure flow sampling.
community.network.ce_sflow:
sflow_interface: 10GE2/0/2
sample_collector: 1
sample_direction: inbound
provider: '{{ cli }}'
- name: Configure counter sampling.
community.network.ce_sflow:
sflow_interface: 10GE2/0/2
counter_collector: 1
counter_interval: 1000
provider: '{{ cli }}'
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed булево | всегда | Проверка внесения изменений на устройстве Пример: True |
| end_state словарь | режим verbose | k/v пары конфигурации после выполнения модуля Пример: {'agent': {'family': 'ipv4', 'ipv4Addr': '1.2.3.4', 'ipv6Addr': None}} |
| existing словарь | режим verbose | k/v пары существующей конфигурации Пример: {'agent': {}} |
| proposed словарь | режим verbose | k/v пары параметров, переданных в модуль Пример: {'agent_ip': '6.6.6.6', 'state': 'present'} |
| updates список / элементы=строка | всегда | команды, отправленные на устройство Пример: ['sflow agent ip 6.6.6.6'] |
Авторы
- QijunPan (@QijunPan)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ce_sflow_module.html