Модуль cisco.mso.ndo_fabric_span_session_source — управление источником сеансов Fabric SPAN в Cisco Nexus Dashboard Orchestrator (NDO).

Примечание

Этот модуль входит в коллекцию cisco.mso (версия 2.13.0).

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

Для установки используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.ndo_fabric_span_session_source.

Добавлено в cisco.mso 2.11.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

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

Управление источником сеансов анализатора коммутируемых портов (SPAN) в Cisco Nexus Dashboard Orchestrator (NDO).
Этот модуль поддерживается только в ND v3.1 (NDO v4.4) и более поздних версиях.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

Multi Site Orchestrator версии 2.1 или новее

Параметры

Параметр	Комментарии
access_paths список / элементы=словарь	Путь доступа к источнику сеанса SPAN. Передача нового списка `access_paths` полностью заменит существующий список источника сеанса SPAN. Передача пустого списка удалит `access_paths=[]` из источника сеанса SPAN.
access_path_type псевдонимы: type строка	Тип пути доступа. Варианты: `"port"` `"port_channel"` `"virtual_port_channel"` `"vpc_component_pc"`
interface строка	Интерфейс узла. Этот параметр необходим для настройки `access_paths.access_path_type=port`.
name строка	Имя «Port Channel» или «Virtual Port Channel», используемого для создания пути доступа.
node целое число	Идентификатор узла. Этот параметр необходим при использовании `access_paths.access_path_type=port` или `access_paths.access_path_type=vpc_component_pc`.
template строка	Имя шаблона политики ресурсов Fabric. Этот параметр или `access_paths.template_id` обязателен при использовании `access_paths.access_path_type=port_channel`, `access_paths.access_path_type=virtual_port_channel` или `access_paths.access_path_type=vpc_component_pc`.
template_id строка	Идентификатор шаблона политики ресурсов Fabric. Этот параметр или `access_paths.template` обязателен при использовании `access_paths.access_path_type=port_channel`, `access_paths.access_path_type=virtual_port_channel` или `access_paths.access_path_type=vpc_component_pc`.
uuid строка	UUID «Access Port», «Port Channel» или «Virtual Port Channel», используемого для создания пути доступа.
direction строка	Направление источника сеанса SPAN. При создании по умолчанию используется `direction=incoming`, если значение не задано. Варианты: `"incoming"` `"outgoing"` `"both"`
filter_epg псевдонимы: epg словарь	Фильтр EPG источника сеанса SPAN. Если в конфигурации указан фильтр EPG, фильтр L3Out будет удален. Этот параметр и `filter_l3out` являются взаимоисключающими. Передача пустого словаря `filter_epg={}` удалит фильтр L3Out из источника сеанса SPAN.
reference псевдонимы: ref словарь	Сведения об объекте EPG, используемом для настройки фильтра EPG. Этот параметр или `filter_epg.uuid` обязателен.
anp строка	Имя ANP, содержащего EPG. Этот параметр или `filter_epg.reference.anp_uuid` обязателен.
anp_uuid строка	UUID ANP, содержащего EPG. Этот параметр или `filter_epg.reference.anp` обязателен.
name строка / обязательный	Имя EPG.
schema строка	Имя схемы, содержащей EPG. Этот параметр или `filter_epg.reference.schema_id` обязателен.
schema_id строка	Идентификатор схемы, содержащей EPG. Этот параметр или `filter_epg.reference.schema` обязателен.
template строка	Имя шаблона, содержащего EPG. Этот параметр или `filter_epg.reference.template_id` обязателен.
template_id строка	Идентификатор шаблона, содержащего EPG. Этот параметр или `filter_epg.reference.template` обязателен.
uuid псевдонимы: epg_uuid строка	UUID EPG, используемого для настройки фильтра EPG. Этот параметр или `filter_epg.reference` обязателен.
filter_l3out псевдонимы: l3out словарь	Фильтр L3Out источника сеанса SPAN. Если в конфигурации указан фильтр L3Out, фильтр EPG будет удален. Этот параметр и `filter_epg` являются взаимоисключающими. L3Out должен быть определен в шаблоне L3Out или непосредственно в арендаторе APIC. Фильтр L3Out для источника сеанса SPAN не поддерживает использование L3Out из шаблона арендатора приложения. Передача пустого словаря `filter_l3out={}` удалит фильтр L3Out из источника сеанса SPAN.
reference псевдонимы: ref словарь	Сведения об объекте фильтра L3Out, используемом для настройки фильтра L3Out. Этот параметр или `filter_l3out.uuid` обязателен.
name строка / обязательный	Имя L3Out.
template строка	Имя шаблона L3Out. Этот параметр, `filter_l3out.reference.template_id` или `filter_l3out.reference.tenant` обязателен.
template_id строка	Идентификатор шаблона L3Out. Этот параметр, `filter_l3out.reference.template` или `filter_l3out.reference.tenant` обязателен.
tenant строка	Имя арендатора. Этот параметр используется для связывания L3Out из APIC. Этот параметр, `filter_l3out.reference.template` или `filter_l3out.reference.template_id` обязателен.
uuid псевдонимы: l3out_uuid строка	UUID L3Out. Этот параметр или `filter_l3out.reference` обязателен.
vlan_id целое число	Идентификатор VLAN, связанного с интерфейсом L3Out. Этот параметр необходим для настройки фильтра L3Out.
host псевдонимы: hostname строка	IP-адрес или имя хоста узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_HOST`.
login_domain строка	Имя домена для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_login_domain`.
name строка	Имя источника сеанса SPAN.
output_level строка	Определяет состав выходных данных этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая сведения `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password строка	Пароль для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-соединения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_PORT`.
span_drop_packets логическое значение	Параметр отбрасывания пакетов SPAN источника сеанса SPAN. Отброшенные пакеты SPAN — это пакеты, которые отбрасываются, когда порт назначения SPAN не справляется с объемом зеркалируемого трафика с исходных портов. При создании по умолчанию используется `span_drop_packets=false`, если значение не задано. Параметры `filter_epg` и `filter_l3out` нельзя настроить при `span_drop_packets=true`. Варианты: `false` `true`
span_session_name строка	Имя сеанса SPAN. Этот параметр или `span_session_uuid` обязателен.
span_session_uuid строка	UUID сеанса SPAN. Этот параметр или `span_session_name` обязателен.
state строка	Для удаления используйте `absent`. Для получения списка одного или нескольких объектов используйте `query`. Для создания или обновления используйте `present`. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
template строка	Имя шаблона. Шаблон должен быть шаблоном политики доступа для мониторинга Fabric. Этот параметр или `template_id` обязателен.
template_id строка	Идентификатор шаблона. Шаблон должен быть шаблоном политики доступа для мониторинга Fabric. Этот параметр или `template` обязателен.
timeout целое число	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_TIMEOUT`.
use_proxy логическое значение	Если задано `false`, прокси использоваться не будет, даже если он указан в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl логическое значение	Если задано `false`, вместо HTTPS-соединения по умолчанию будет использоваться HTTP-соединение. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_USE_SSL`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_use_ssl`. По умолчанию используется `false` при использовании подключаемого модуля соединения HTTPAPI (mso или nd) и `true` при использовании устаревшего метода соединения (только для mso). Варианты: `false` `true`
username строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs логическое значение	Если задано `false`, проверка SSL-сертификатов выполняться не будет. Задавайте значение `false` только на контролируемых вами сайтах, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должен существовать template. Используйте cisco.mso.ndo_template для создания шаблона политики доступа для мониторинга фабрики.
Перед использованием этого модуля в плейбуке должен существовать span_session_name. Используйте cisco.mso.ndo_fabric_span_session для создания сессии SPAN фабрики.
Перед использованием этого модуля в плейбуке должен существовать filter_epg.reference. Используйте cisco.mso.mso_schema_template_anp_epg для создания EPG.
Перед использованием этого модуля в плейбуке должен существовать filter_l3out.reference. Используйте cisco.mso.ndo_l3out_template для создания L3Out.
Перед использованием этого модуля в плейбуке должен существовать access_paths.name. Используйте cisco.mso.ndo_port_channel_interface для создания интерфейса агрегированного канала порта ресурса фабрики.
Перед использованием этого модуля в плейбуке должен существовать access_paths.name. Используйте cisco.mso.ndo_virtual_port_channel_interface для создания интерфейса виртуального агрегированного канала порта ресурса фабрики.
Этот модуль разработан для поддержки Multi Site Orchestrator версии 2.1 или новее. Часть или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.ndo_template: Управление шаблонами в Cisco Nexus Dashboard Orchestrator (NDO).
cisco.mso.ndo_fabric_span_session: Управление сессиями SPAN фабрики в Cisco Nexus Dashboard Orchestrator (NDO).
cisco.mso.mso_schema_template_anp_epg: Управление группами конечных точек (EPG) в шаблонах схем.
cisco.mso.ndo_port_channel_interface: Управление интерфейсами агрегированных каналов портов в Cisco Nexus Dashboard Orchestrator (NDO).
cisco.mso.ndo_virtual_port_channel_interface: Управление интерфейсами виртуальных агрегированных каналов портов в Cisco Nexus Dashboard Orchestrator (NDO).

Примеры

- name: Create the SPAN Session source with access paths
  cisco.mso.ndo_fabric_span_session_source:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_mon_pol
    span_session_name: ansible_test_span_session
    name: ansible_test_source_2
    direction: outgoing
    span_drop_packets: true
    access_paths:
      - access_path_type: port
        node: 101
        interface: eth1/6
      - access_path_type: port_channel
        name: ansible_test_pc1
        template: ansible_test_fabric_resource
      - access_path_type: virtual_port_channel
        name: ansible_test_vpc1
        template: ansible_test_fabric_resource
      - access_path_type: vpc_component_pc
        name: ansible_test_vpc1
        template: ansible_test_fabric_resource
        node: 101
    state: present
  register: add_ansible_test_source_2

- name: Create the SPAN Session source with access path and filter EPG
  cisco.mso.ndo_fabric_span_session_source:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_mon_pol
    span_session_name: ansible_test_span_session
    name: ansible_test_source_3
    direction: outgoing
    access_paths:
      - access_path_type: port
        node: 101
        interface: eth1/6
    filter_epg:
      reference:
        schema: ansible_test_schema
        template: template1
        anp: ansible_test_anp
        name: ansible_test_epg1
    state: present

- name: Create the SPAN Session source with access path and filter L3Out
  cisco.mso.ndo_fabric_span_session_source:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_mon_pol
    span_session_name: ansible_test_span_session
    name: ansible_test_source_4
    direction: outgoing
    access_paths:
      - access_path_type: port
        node: 101
        interface: eth1/1
    filter_l3out:
      reference:
        name: ansible_test_l3out
        template: ansible_test_l3out_template
      vlan_id: 41
    state: present

- name: Create the SPAN Session source with access paths UUID
  cisco.mso.ndo_fabric_span_session_source:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: "{{ add_span_session.current.templateId }}"
    span_session_uuid: "{{ add_span_session.current.uuid }}"
    name: ansible_test_source_1
    access_paths:
      - access_path_type: port
        node: 101
        interface: eth1/1
      - access_path_type: port_channel
        uuid: "{{ add_fabric_pc_1.current.uuid }}"
      - access_path_type: virtual_port_channel
        uuid: "{{ add_fabric_vpc1.current.uuid }}"
      - access_path_type: vpc_component_pc
        uuid: "{{ add_fabric_vpc1.current.uuid }}"
        node: 101
    state: present

- name: Update the SPAN Session source Filter EPG using UUID
  cisco.mso.ndo_fabric_span_session_source:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_mon_pol
    span_session_name: ansible_test_span_session
    name: ansible_test_source_1
    direction: outgoing
    filter_epg:
      uuid: "{{ add_epg.current.epg }}"
    state: present

- name: Update the SPAN Session source Filter L3Out using UUID
  cisco.mso.ndo_fabric_span_session_source:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_mon_pol
    span_session_name: ansible_test_span_session
    name: ansible_test_source_1
    direction: outgoing
    access_paths:
      - access_path_type: port_channel
        name: ansible_test_pc1
        template: ansible_test_fabric_resource
    filter_l3out:
      uuid: "{{ add_l3out.current.uuid }}"
      vlan_id: 42
    state: present

- name: Query a specific SPAN Session source
  cisco.mso.ndo_fabric_span_session_source:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_mon_pol
    span_session_name: ansible_test_span_session
    name: ansible_test_source_1
    state: query
  register: query_one

- name: Query all SPAN Session sources
  cisco.mso.ndo_fabric_span_session_source:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_mon_pol
    span_session_name: ansible_test_span_session
    state: query
  register: query_all

- name: Delete the SPAN Session source
  cisco.mso.ndo_fabric_span_session_source:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_mon_pol
    span_session_name: ansible_test_span_session
    name: ansible_test_source_1
    state: absent

Авторы

Sabari Jaganathan (@sajagana)

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

© 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/cisco/mso/ndo_fabric_span_session_source_module.html