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

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

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
admin_state string	Административное состояние сеанса SPAN. Если при создании параметр не задан, по умолчанию используется `enabled`. Допустимые значения: `"enabled"` `"disabled"`
description string	Описание сеанса SPAN.
destination_epg dictionary	Группа конфигурации целевой EPG. При создании сеанса SPAN требуется этот параметр или `destination_port` или `destination_port_channel`.
destination_ip string	IP-адрес назначения для маршрутизации пакетов сеанса SPAN.
dscp string	Значение 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 boolean	Принудительно использовать версию сеанса SPAN, указанную в `destination_epg.span_version`. Если при создании параметр не задан, по умолчанию используется true. Допустимые значения: `false` `true`
epg dictionary	Целевая EPG для сеанса SPAN. Этот параметр или `destination_epg.epg_uuid` является обязательным.
anp string	Имя ANP, содержащей целевую EPG. Этот параметр или `destination_epg.epg.anp_uuid` является обязательным.
anp_uuid string	UUID ANP, содержащей целевую EPG. Этот параметр или `destination_epg.epg.anp` является обязательным.
name string / обязательный	Имя целевой EPG.
schema string	Имя схемы, содержащей целевую EPG. Этот параметр или `destination_epg.epg.schema_id` является обязательным.
schema_id string	Идентификатор схемы, содержащей целевую EPG. Этот параметр или `destination_epg.epg.schema` является обязательным.
template string	Имя шаблона, содержащего целевую EPG. Этот параметр или `destination_epg.epg.template_id` является обязательным.
template_id string	Идентификатор шаблона, содержащего целевую EPG. Этот параметр или `destination_epg.epg.template` является обязательным.
epg_uuid string	UUID целевой EPG для сеанса SPAN. Этот параметр или `destination_epg.epg` является обязательным.
flow_id integer	Идентификатор потока пакетов сеанса SPAN. Значение должно находиться в диапазоне от 1 до 1023. Если при создании параметр не задан, по умолчанию используется 1.
source_ip_prefix string	Префикс для назначения исходных IP-адресов пакетам ERSPAN. Он позволяет определить, какой Leaf или Spine отправляет трафик. Можно использовать любой IP-адрес. Если указан префикс, неопределённые биты префикса заполняются идентификатором узла-источника.
span_version string	Версия сеанса SPAN. Если при создании параметр не задан, по умолчанию используется `v2`. Допустимые значения: `"v1"` `"v2"`
ttl integer	Время жизни (TTL) пакетов сеанса SPAN. Значение должно находиться в диапазоне от 1 до 1023. Если при создании параметр не задан, по умолчанию используется 1.
destination_port dictionary	Группа конфигурации порта назначения. При создании сеанса SPAN требуется этот параметр или `destination_epg` или `destination_port_channel`.
port dictionary	Порт назначения для сеанса SPAN. Этот параметр или `destination_port.port_uuid` является обязательным.
interface string / обязательный	Интерфейс Ethernet узла для сеанса SPAN
node integer / обязательный	Идентификатор узла для сеанса SPAN.
port_uuid string	UUID порта назначения для сеанса SPAN. Этот параметр или `destination_port.port` является обязательным.
destination_port_channel dictionary	Группа конфигурации канала портов назначения. При создании сеанса SPAN требуется этот параметр или `destination_epg` или `destination_port`.
port_channel dictionary	Канал портов назначения для сеанса SPAN. Этот параметр или `destination_port_channel.port_channel_uuid` является обязательным.
name string / обязательный	Имя канала портов назначения.
template string	Имя шаблона, содержащего канал портов назначения. Этот параметр или `destination_port_channel.port_channel.template_id` является обязательным.
template_id string	Идентификатор шаблона, содержащего канал портов назначения. Этот параметр или `destination_port_channel.port_channel.template` является обязательным.
port_channel_uuid string	UUID канала портов назначения для сеанса SPAN. Этот параметр или `destination_port_channel.port_channel` является обязательным.
host псевдонимы: hostname string	IP-адрес или имя хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_HOST`.
login_domain string	Имя домена входа для аутентификации. По умолчанию используется Local. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_login_domain`.
mtu integer	Размер усечения MTU для пакетов SPAN. Значение должно находиться в диапазоне от 64 до 9216. Если при создании параметр не задан, по умолчанию используется 1518.
name псевдонимы: span_session string	Имя сеанса SPAN.
output_level string	Влияет на вывод этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_OUTPUT_LEVEL`. Допустимые значения: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password string	Пароль для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_PORT`.
state string	Используйте `absent` для удаления. Используйте `query` для получения списка одного или нескольких объектов. Используйте `present` для создания или обновления. Допустимые значения: `"absent"` `"query"` ← (по умолчанию) `"present"`
template string	Имя шаблона. Шаблон должен быть шаблоном политики доступа Fabric Monitoring. Этот параметр или `template_id` является обязательным.
template_id string	Идентификатор шаблона. Шаблон должен быть шаблоном политики доступа Fabric Monitoring. Этот параметр или `template` является обязательным.
timeout integer	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_TIMEOUT`.
use_proxy boolean	Если `false`, прокси-сервер использоваться не будет, даже если он задан в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_PROXY`. По умолчанию используется `true`. Допустимые значения: `false` `true`
use_ssl boolean	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_use_ssl`. По умолчанию используется `false` при работе с плагином подключения HTTPAPI (mso или nd) и `true` при использовании устаревшего способа подключения (только для mso). Допустимые значения: `false` `true`
username string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
uuid псевдонимы: span_session_uuid string	UUID сеанса SPAN. Этот параметр обязателен, если требуется обновить `name`.
validate_certs boolean	Если `false`, SSL-сертификаты проверяться не будут. Задавайте значение `false` только для сайтов под личным контролем, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_VALIDATE_CERTS`. По умолчанию используется `true`. Допустимые значения: `false` `true`

Примечания

Примечание

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

См. также

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

Примеры

- name: Create Fabric SPAN Session with destination EPG
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_test_epg
    destination_epg:
      epg:
        schema: ansible_test
        template: Template1
        anp: Anp1
        name: EPG1
      destination_ip: "1.1.1.1"
      source_ip_prefix: "2.2.2.2"
    state: present
  register: create_epg_span_session

- name: Create Fabric SPAN Session with destination Port
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_test_port
    destination_port:
      port:
        node: 101
        interface: "eth1/1"
    state: present

- name: Create Fabric SPAN Session with destination Port Channel
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_test_pc
    destination_port_channel:
      port_channel:
        template: ansible_test
        name: ansible_test_resource_pc_1
    state: present

- name: Update Fabric SPAN Session from destination EPG to destination Port
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_test_epg
    destination_port:
      port:
        node: 101
        interface: "eth1/1"
    state: present

- name: Update Fabric SPAN Session from destination Port to destination Port Channel
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_test_port
    destination_port_channel:
      port_channel:
        template: ansible_test
        name: ansible_test_resource_pc_1
    state: present

- name: Update Fabric SPAN Session from destination Port Channel to destination EPG
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_test_pc
    destination_epg:
      epg:
        schema: ansible_test
        template: Template1
        anp: Anp1
        name: EPG1
      destination_ip: "1.1.1.1"
      source_ip_prefix: "2.2.2.2"
    state: present

- name: Update the Fabric SPAN Session name using UUID
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    uuid: "{{ create_epg_span_session.current.uuid }}"
    name: ansible_test_pc_updated
    state: present

- name: Query a specific Fabric SPAN Session using name
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_test_pc_updated
    state: query
  register: query_with_name

- name: Query a specific Fabric SPAN Session using UUID
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    uuid: "{{ create_epg_span_session.current.uuid }}"
    state: query
  register: query_with_uuid

- name: Query all Fabric SPAN Sessions
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    state: query
  register: query_all_objects

- name: Delete a specific Fabric SPAN Session using Name
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    name: ansible_test_pc_updated
    state: absent

- name: Delete a Fabric SPAN Session using UUID
  cisco.mso.ndo_fabric_span_session:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: ansible_test
    uuid: "{{ create_epg_span_session.current.uuid }}"
    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_module.html