community.vmware.vmware_vspan_session – Создание или удаление сессии мониторинга портов.
Примечание
Этот плагин является частью коллекции community.vmware (версия 1.7.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Для использования в книге задач укажите: community.vmware.vmware_vspan_session.
Обзор
- Этот модуль можно использовать для создания, удаления или изменения различных типов сессий мониторинга портов.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python > = 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка | Описание сессии. | ||
| destination_port строка | Порт назначения, получивший отражённые пакеты. Кроме того, любой порт, указанный в этом свойстве, не может совпадать с портом источника в любой сессии распределённого мониторинга портов. | ||
| destination_vm словарь | С помощью этого параметра можно добавить сетевую карту виртуальной машины в сессию мониторинга портов. | ||
| name строка | Имя виртуальной машины. | ||
| nic_label строка | Метка сетевой карты. | ||
| enabled булево |
| Включена ли сессия. | |
| encapsulation_vlan_id целое число | Идентификатор VLAN, используемый для инкапсуляции отражённого трафика. | ||
| hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | ||
| mirrored_packet_length целое число | Целое число, описывающее, сколько каждого кадра нужно отражать. Если не установлено, отражается весь кадр. Установка этого свойства на меньшее значение полезна, если потребитель будет просматривать только заголовки. Значение не может быть меньше 60. | ||
| name строка / обязательно | Имя сессии. | ||
| normal_traffic_allowed булево |
| Разрешено ли портам назначения отправлять и получать "нормальный" трафик. Установка значения в false сделает порты зеркала предназначенными исключительно для мониторинга, а не в качестве обычных портов доступа. | |
| password строка | Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | ||
| port целое число | Значение по умолчанию: 443 | Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. | |
| proxy_host строка | Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12 | ||
| proxy_port целое число | Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_PORT. | ||
| sampling_rate целое число | Частота выборки сессии. Если её значение равно n, один из каждых n пакетов отражается. Допустимые значения находятся в диапазоне от 1 до 65535. | ||
| session_type строка |
| Выберите тип мониторинга. В сессии encapsulatedRemoteMirrorSource, распределённые порты могут использоваться в качестве источников, а IP-адреса — в качестве пунктов назначения.В сессии remoteMirrorDest, идентификаторы VLAN могут использоваться в качестве источников, а распределённые порты — в качестве пунктов назначения.В сессии remoteMirrorSource, распределённые порты могут использоваться в качестве источников, а имена портов соединения — в качестве пунктов назначения.В сессии dvPortMirror, распределённые порты могут использоваться как в качестве источников, так и в качестве пунктов назначения. | |
| source_port_received строка | Порт источника, для которого принимаемые пакеты отражаются. | ||
| source_port_transmitted строка | Порт источника, для которого передаваемые пакеты отражаются. | ||
| source_vm_received словарь | С помощью этого параметра можно добавить сетевую карту виртуальной машины в сессию мониторинга портов. | ||
| name строка | Имя виртуальной машины. | ||
| nic_label строка | Метка сетевой карты. | ||
| source_vm_transmitted словарь | С помощью этого параметра можно добавить сетевую карту виртуальной машины в сессию мониторинга портов. | ||
| name строка | Имя виртуальной машины. | ||
| nic_label строка | Метка сетевой карты. | ||
| state строка / обязательно |
| Создать или удалить сессию. | |
| strip_original_vlan булево |
| Удалить исходный тег VLAN. Если значение false, исходный тег VLAN будет сохранён в отражённом трафике. Если encapsulationVlanId установлено, а это свойство — false, кадры будут дважды помечены исходным идентификатором VLAN как внутренним тегом. | |
| switch строка / обязательно | Имя распределённого vSwitch, к которому добавляется или из которого удаляется сессия мониторинга. псевдонимы: switch_name | ||
| username строка | Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | ||
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите в false, когда сертификаты не доверяются.Если значение не указано в задаче, используется значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. | |
Примечания
Примечание
- Проверено на vSphere 6.7
Примеры
- name: Create distributed mirroring session.
community.vmware.vmware_vspan_session:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
switch_name: dvSwitch
state: present
name: Basic Session
enabled: True
description: "Example description"
source_port_transmitted: 817
source_port_received: 817
destination_port: 815
delegate_to: localhost
- name: Create remote destination mirroring session.
community.vmware.vmware_vspan_session:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
switch_name: dvSwitch
state: present
name: Remote Session
enabled: True
description: "Example description"
source_port_received: 105
destination_port: 815
session_type: "remoteMirrorDest"
delegate_to: localhost
- name: Create remote destination mirroring session.
community.vmware.vmware_vspan_session:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
switch_name: dvSwitch
state: absent
name: Remote Session
delegate_to: localhost
Авторы
- Peter Gyorgy (@gyorgypeter)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_vspan_session_module.html