Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_tenant_span_src_group_to_dst_group – Привязка источников SPAN к группам назначения (span:SpanLbl)

Примечание

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

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

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

Для использования в книге задач укажите: cisco.aci.aci_tenant_span_src_group_to_dst_group.

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

Обзор

  • Привязка источников SPAN к соответствующим группам назначения на Cisco ACI-фабриках.

Параметры

Параметр

Комментарии

annotation

string

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

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

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

Default: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

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

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

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

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

description

aliases: descr

string

Описание привязки группы источников Span к группе назначений.

dst_group

string

Группа назначений Span, которая будет связана с группой источников.

host

aliases: hostname

string

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

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

name_alias

string

Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.

output_level

string

Влияет на вывод этого модуля ACI.

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

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

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

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

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

output_path

string

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

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

owner_key

string

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

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

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

owner_tag

string

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

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

Например, для указания того, кто создал этот объект.

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

password

string

Пароль, используемый для аутентификации.

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

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

port

integer

Номер порта, который будет использоваться для соединения REST.

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

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

private_key

aliases: cert_key

string

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

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

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

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

src_group

string

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

state

string

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

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

Choices:

  • "absent"
  • "present" ← (default)
  • "query"

suppress_previous

aliases: no_previous, ignore_previous

boolean

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

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

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

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

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

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, проверка GET не будет отправлена после обновления POST в APIC.

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

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

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

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

Варианты:

  • false
  • true

tenant

aliases: tenant_name

string

Имя Тенанта.

timeout

integer

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

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

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

use_proxy

boolean

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

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

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

Варианты:

  • false
  • true

use_ssl

boolean

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

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

Значение по умолчанию — true, если подключение локальное.

Варианты:

  • false
  • true

username

aliases: user

string

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

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

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

validate_certs

boolean

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

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

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

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

Варианты:

  • false
  • true

Примечания

Примечание

  • tenant, src_group, и dst_group должны существовать перед использованием данного модуля в вашем плане. Модули cisco.aci.aci_tenant, cisco.aci.aci_tenant_span_src_group и cisco.aci.aci_tenant_span_dst_group могут быть использованы для этого.

См. также

См. также

cisco.aci.aci_tenant

Управление Теннтами (fv:Tenant).

cisco.aci.aci_tenant_span_src_group

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

cisco.aci.aci_tenant_span_dst_group

Управление группами получателей SPAN (span:DestGrp).

APIC Management Information Model reference

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

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

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

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

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

Примеры

- name: Bind SPAN source to destination group
  cisco.aci.aci_tenant_span_src_group_to_dst_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    src_group: my_span_source_group
    dst_group: my_span_destination_group
    tenant: prod
    state: present
  delegate_to: localhost

- name: Unbind SPAN source to destination group
  cisco.aci.aci_tenant_span_src_group_to_dst_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    src_group: my_span_source_group
    dst_group: my_span_destination_group
    tenant: prod
    state: absent
  delegate_to: localhost

- name: Query all SPAN source to destination group bindings
  cisco.aci.aci_tenant_span_src_group_to_dst_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific SPAN source to destination group binding
  cisco.aci.aci_tenant_span_src_group_to_dst_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    src_group: my_span_source_group
    dst_group: my_span_destination_group
    tenant: prod
    state: query
  delegate_to: localhost
  register: query_result

Значения возврата

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

Ключ

Описание

current

список / элементы=строка

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

Возвращаемое значение: успех

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

error

словарь

Информация об ошибке, возвращенная из APIC

Возвращаемое значение: неудача

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

filter_string

строка

Строка фильтра, используемая для запроса

Возвращаемое значение: неудача или отладка

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

method

строка

HTTP-метод, используемый для запроса к APIC

Возвращаемое значение: неудача или отладка

Пример: "POST"

previous

список / элементы=строка

Исходная конфигурация из APIC до запуска модуля

Возвращаемое значение: информация

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

proposed

словарь

Собраная конфигурация из параметров пользователя

Возвращаемое значение: информация

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

raw

строка

Необработанный вывод, возвращенный API REST APIC (xml или json)

Возвращаемое значение: ошибка разбора

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

response

строка

HTTP-ответ от APIC

Возвращаемое значение: неудача или отладка

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

sent

список / элементы=строка

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

Возвращаемое значение: информация

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

status

целое число

HTTP-статус от APIC

Возвращаемое значение: неудача или отладка

Пример: 200

url

строка

HTTP-URL, используемый для запроса к APIC

Возвращаемое значение: неудача или отладка

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

Авторы

  • Jacob McGill (@jmcgill298)

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

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_tenant_span_src_group_to_dst_group_module.html

Spec-Zone.ru

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