Модуль cisco.mso.ndo_tenant_span_session — управление сеансами 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_tenant_span_session.

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

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

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

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

Требования

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

Multi Site Orchestrator v2.1 или новее

Параметры

Параметр	Комментарии
admin_state строка	Административное состояние сеанса SPAN. При создании по умолчанию используется `enabled`, если параметр не задан. Варианты: `"enabled"` `"disabled"`
description строка	Описание сеанса SPAN.
destination_epg словарь	Группа конфигурации целевой EPG.
destination_ip строка	IP-адрес назначения для маршрутизации пакетов сеанса SPAN.
dscp строка	Значение DSCP для отправки отслеживаемых пакетов сеанса SPAN. При создании по умолчанию используется `unspecified`, если параметр не задан. Варианты: `"af11"` `"af12"` `"af13"` `"af21"` `"af22"` `"af23"` `"af31"` `"af32"` `"af33"` `"af41"` `"af42"` `"af43"` `"cs0"` `"cs1"` `"cs2"` `"cs3"` `"cs4"` `"cs5"` `"cs6"` `"cs7"` `"expedited_forwarding"` `"voice_admit"` `"unspecified"`
enforce_span_version логическое значение	Обеспечить соблюдение версии сеанса SPAN, заданной в `destination_epg.span_version`. При создании по умолчанию используется значение true, если параметр не задан. Варианты: `false` `true`
epg словарь	Целевая EPG для использования в сеансе SPAN. При создании сеанса SPAN необходимо указать этот параметр или `destination_epg.epg_uuid`.
anp строка	Имя ANP, содержащего целевую EPG. Необходимо указать этот параметр или `destination_epg.epg.anp_uuid`.
anp_uuid строка	UUID ANP, содержащего целевую EPG. Необходимо указать этот параметр или `destination_epg.epg.anp`.
name строка / обязательный	Имя целевой EPG.
schema строка	Имя схемы, содержащей целевую EPG. Необходимо указать этот параметр или `destination_epg.epg.schema_id`.
schema_id строка	Идентификатор схемы, содержащей целевую EPG. Необходимо указать этот параметр или `destination_epg.epg.schema`.
template строка	Имя шаблона, содержащего целевую EPG. Необходимо указать этот параметр или `destination_epg.epg.template_id`.
template_id строка	Идентификатор шаблона, содержащего целевую EPG. Необходимо указать этот параметр или `destination_epg.epg.template`.
epg_uuid строка	UUID целевой EPG для использования в сеансе SPAN. При создании сеанса SPAN необходимо указать этот параметр или `destination_epg.epg`.
flow_id целое число	Идентификатор потока пакетов сеанса SPAN. Значение должно находиться в диапазоне 1–1023. При создании по умолчанию используется значение 1, если параметр не задан.
source_ip_prefix строка	Префикс для назначения IP-адресов источника пакетам ERSPAN; он позволяет определить, какой Leaf или Spine отправляет трафик. Можно указать любой IP-адрес. Если используется префикс, для неопределённых битов префикса применяется идентификатор узла-источника.
span_version строка	Версия сеанса SPAN. При создании по умолчанию используется `v2`, если параметр не задан. Варианты: `"v1"` `"v2"`
ttl целое число	Время жизни (TTL) пакетов сеанса SPAN. Значение должно находиться в диапазоне 1–1023. При создании по умолчанию используется значение 1, если параметр не задан.
host псевдонимы: hostname строка	IP-адрес или имя узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_HOST`.
login_domain строка	Имя домена входа для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании подключаемого модуля подключения HTTPAPI, если этот атрибут не задан, будет использована переменная инвентаря `ansible_httpapi_login_domain`.
mtu целое число	Размер усечения MTU для пакетов SPAN. Значение должно находиться в диапазоне 64–9216. При создании по умолчанию используется значение 1518, если параметр не задан.
name псевдонимы: span_session строка	Имя сеанса 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`.
sources список / элементы=словарь	Источники сеанса SPAN. Передача нового списка `sources` заменит существующие источники сеанса SPAN. Передача пустого списка удалит `sources=[]` из сеанса SPAN.
direction строка / обязательный	Направление источника сеанса SPAN. Варианты: `"incoming"` `"outgoing"` `"both"`
epg словарь	EPG для использования в качестве источника сеанса SPAN. Необходимо указать этот параметр или `sources.epg_uuid`.
anp строка	Имя профиля приложения (ANP), содержащего исходную EPG. Необходимо указать этот параметр или `sources.epg.anp_uuid`.
anp_uuid строка	UUID ANP, содержащего исходную EPG. Необходимо указать этот параметр или `sources.epg.anp`.
name строка / обязательный	Имя исходной EPG.
schema строка	Имя схемы, содержащей исходную EPG. Необходимо указать этот параметр или `sources.epg.schema_id`.
schema_id строка	Идентификатор схемы, содержащей исходную EPG. Необходимо указать этот параметр или `sources.epg.schema`.
template строка	Имя шаблона, содержащего исходную EPG. Необходимо указать этот параметр или `sources.epg.template_id`.
template_id строка	Идентификатор шаблона, содержащего исходную EPG. Необходимо указать этот параметр или `sources.epg.template`.
epg_uuid строка	UUID исходной группы конечных точек (EPG) для использования в сеансе SPAN. Необходимо указать этот параметр или `sources.epg`.
name строка / обязательный	Имя источника сеанса SPAN.
state строка	Для удаления используйте `absent`. Для получения списка одного или нескольких объектов используйте `query`. Для создания или обновления используйте `present`. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
template строка	Имя шаблона. Шаблон должен быть шаблоном политики мониторинга арендатора. Необходимо указать этот параметр или `template_id`.
template_id строка	Идентификатор шаблона. Шаблон должен быть шаблоном политики мониторинга арендатора. Необходимо указать этот параметр или `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`. При использовании подключаемого модуля подключения HTTPAPI (mso или nd) значение по умолчанию — `false`; при использовании устаревшего метода подключения (только для mso) — `true`. Варианты: `false` `true`
username строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
uuid псевдонимы: span_session_uuid строка	UUID сеанса SPAN. Этот параметр обязателен, если требуется обновить `name`.
validate_certs логическое значение	Если `false`, SSL-сертификаты проверяться не будут. Задавайте значение `false` только для самостоятельно контролируемых сайтов, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должны существовать template, destination_epg.epg и sources.epg. Используйте cisco.mso.ndo_template для создания шаблона политики мониторинга арендатора. Используйте cisco.mso.mso_schema_template_anp_epg для создания EPG.
Этот модуль разработан для поддержки Multi Site Orchestrator v2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

См. также

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

Примеры

- name: Create a new SPAN Session
  cisco.mso.ndo_tenant_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: monitoring_tenant_template
    name: span_session_1
    sources:
      - name: source_1
        epg_uuid: '{{ query_epg_1.current.uuid }}'
        direction: both
      - name: source_2
        direction: outgoing
        epg:
          name: epg_2
          anp: anp_1
          template: template_1
          schema: schema_1
    admin_state: enabled
    mtu: 9216
    destination_epg:
      epg:
        name: epg_3
        anp: anp_1
        template: template_1
        schema: schema_1
      destination_ip: 10.1.1.1
      source_ip_prefix: 10.1.1.1/24
      span_version: v1
      enforce_span_version: false
      flow_id: 15
      ttl: 128
      dscp: af11
    state: present
  register: create_span_session_1

- name: Update the name of the SPAN Session using UUID
  cisco.mso.ndo_tenant_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: "{{ create_monitoring_tenant.current.templateId }}"
    uuid: "{{ create_span_session_1.current.uuid }}"
    name: span_session_1_updated
    state: present
  register: update_span_session_1

- name: Query an existing SPAN Session using UUID
  cisco.mso.ndo_tenant_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: monitoring_tenant_template
    uuid: "{{ create_span_session_1.current.uuid }}"
    state: query
  register: query_with_uuid

- name: Query an existing SPAN Session using name
  cisco.mso.ndo_tenant_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: monitoring_tenant_template
    name: span_session_1_updated
    state: query
  register: query_with_name

- name: Query all SPAN Sessions
  cisco.mso.ndo_tenant_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: monitoring_tenant_template
    state: query
  register: query_all

- name: Remove all sources from a SPAN Session
  cisco.mso.ndo_tenant_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: monitoring_tenant_template
    name: span_session_1_updated
    sources: []
    state: present

- name: Delete an existing SPAN Session using UUID
  cisco.mso.ndo_tenant_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: monitoring_tenant_template
    uuid: "{{ create_span_session_1.current.uuid }}"
    state: absent

- name: Delete an existing SPAN Session using Name
  cisco.mso.ndo_tenant_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: monitoring_tenant_template
    name: span_session_1_updated
    state: absent

Авторы

Samita Bhattacharjee (@samiib)

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

© 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_tenant_span_session_module.html