Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_fabric_span_src_group_src_node — управление исходными узлами Fabric SPAN (span:RsSrcToNode)

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.aci.

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

  • Краткое описание
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

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

  • Управление исходными узлами Fabric SPAN в фабриках Cisco ACI.
  • Исходные узлы можно настроить, только если для указанной группы source_group параметр drop_packets имеет значение true.

Параметры

Параметр

Комментарии

annotation

string

Пользовательская строка для добавления аннотации к объекту.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_ANNOTATION.

Если значение не указано в задаче, а переменная окружения ACI_ANNOTATION не задана, будет использоваться значение по умолчанию.

По умолчанию: "orchestrator:ansible"

certificate_name

псевдонимы: cert_name

string

Имя сертификата X.509, привязанного к пользователю APIC AAA и используемого для аутентификации на основе подписи.

Если указан файл private_key, по умолчанию используется базовое имя файла private_key без расширения.

Если для private_key указано содержимое в формате PEM, по умолчанию используется значение username.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_CERTIFICATE_NAME.

host

псевдонимы: hostname

string

IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_HOST.

node

псевдонимы: node_id

integer

Идентификатор исходного узла доступа.

output_level

string

Настройка вывода этого модуля ACI.

normal — стандартный вывод, включая словарь current

info добавляет информационный вывод, включая previous, proposed и словари sent

debug добавляет отладочный вывод, включая сведения filter_string, method, response, status и url

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_OUTPUT_LEVEL.

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

output_path

string

Путь к файлу, в который будут записаны объекты конфигурации ACI в формате JSON, созданные модулем.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_OUTPUT_PATH.

password

string

Пароль для аутентификации.

Этот параметр нельзя использовать одновременно с private_key. Если также указан private_key, будет использоваться он.

Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

pod

псевдонимы: pod_id, pod_number

integer

Идентификатор pod исходного узла доступа.

port

integer

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_PORT.

private_key

псевдонимы: cert_key

string

Файл закрытого ключа в формате PEM или содержимое закрытого ключа для аутентификации на основе подписи.

Это значение также влияет на используемое значение certificate_name по умолчанию.

Этот параметр нельзя использовать одновременно с password. Если также указан password, он будет проигнорирован.

Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

source

псевдонимы: src

string

Имя источника Fabric SPAN.

source_group

псевдонимы: src_group

string

Имя группы источников Fabric SPAN.

state

string

Для добавления или удаления используйте present или absent.

Для получения одного или нескольких объектов используйте query.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

Если true, перед отправкой POST-запроса на обновление в APIC не будет выполняться GET-запрос для проверки предыдущего состояния.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию — false.

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым.

Предыдущее состояние объекта не будет проверяться, а POST-запрос на обновление будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после отправки POST-запроса на обновление в APIC проверочный GET-запрос выполняться не будет.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию — false.

ПРЕДУПРЕЖДЕНИЕ — в результате текущему возвращаемому значению будет присвоено предложенное значение.

Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи.

Варианты:

  • false
  • true

timeout

integer

Тайм-аут на уровне сокета в секундах.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_TIMEOUT.

Значение по умолчанию — 30.

use_proxy

boolean

Если false, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_USE_PROXY.

Значение по умолчанию — true.

Варианты:

  • false
  • true

use_ssl

boolean

Если false, вместо HTTPS-подключения, используемого по умолчанию, будет применяться HTTP-подключение.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_USE_SSL.

При локальном подключении значение по умолчанию — true.

Варианты:

  • false
  • true

username

псевдонимы: user

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию — admin.

validate_certs

boolean

Если false, сертификаты SSL проверяться не будут.

Это значение следует устанавливать в false только для контролируемых вами сайтов, использующих самоподписанные сертификаты.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_VALIDATE_CERTS.

Значение по умолчанию — true.

Варианты:

  • false
  • true

Примечания

Примечание

  • Перед использованием этого модуля в плейбуке должны существовать source_group и source. Для этого можно использовать модули cisco.aci.aci_fabric_span_src_group и cisco.aci.aci_fabric_span_src_group_src.

См. также

См. также

cisco.aci.aci_fabric_span_src_group

Управление группами источников Fabric SPAN (span:SrcGrp).

cisco.aci.aci_fabric_span_src_group_src

Управление источниками Fabric SPAN (span:Src).

Справочник информационной модели управления APIC

Дополнительная информация о внутреннем классе APIC span:RsSrcToNode.

Руководство по Cisco ACI

Подробная информация об управлении инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Create a Fabric SPAN source node
  cisco.aci.aci_fabric_span_src_group_src_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    source_group: my_span_source_group
    source: my_source
    pod: 1
    node: 101
    state: present
  delegate_to: localhost

- name: Delete a Fabric SPAN source node
  cisco.aci.aci_fabric_span_src_group_src_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    source_group: my_span_source_group
    source: my_source
    pod: 1
    node: 101
    state: absent
  delegate_to: localhost

- name: Query all Fabric SPAN source nodes
  cisco.aci.aci_fabric_span_src_group_src_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific Fabric SPAN source node
  cisco.aci.aci_fabric_span_src_group_src_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    source_group: my_span_source_group
    source: my_source
    pod: 1
    nodes: 101
    state: query
  delegate_to: localhost
  register: query_result

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

current

list / elements=string

Текущая конфигурация, полученная из APIC после завершения работы модуля

Возвращается: при успехе

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Сведения об ошибке, возвращенные APIC

Возвращается: при сбое

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная для запроса

Возвращается: при сбое или в режиме отладки

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: при сбое или в режиме отладки

Пример: "POST"

previous

list / elements=string

Исходная конфигурация из APIC до начала работы модуля

Возвращается: в информационном режиме

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе параметров, заданных пользователем

Возвращается: в информационном режиме

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Исходный вывод, возвращенный REST API APIC (xml или json)

Возвращается: при ошибке разбора

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: при сбое или в режиме отладки

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, переданная в APIC

Возвращается: в информационном режиме

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: при сбое или в режиме отладки

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: при сбое или в режиме отладки

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Akini Ross (@akinross)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/aci/aci_fabric_span_src_group_src_node_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API