Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию cisco.aci (версия 2.0.0).

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

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

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

Обзор

  • Управление группами источников SPAN на тканях Cisco ACI.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
admin_state
boolean
    Варианты:
  • no
  • yes
Включить или отключить источники span.
APIC по умолчанию устанавливает yes при создании, если значение не задано.
annotation
string
Пользовательская строка для аннотирования объекта.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_ANNOTATION.
certificate_name
string
Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.
Если был предоставлен файл с именем private_key, значение по умолчанию — имя файла private_key, без расширения.
Если для private_key был предоставлен контент в формате PEM, значение по умолчанию — значение username.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_CERTIFICATE_NAME.

псевдонимы: cert_name
description
string
Описание группы источников Span.

псевдонимы: descr
dst_group
string
Группа назначения Span для ассоциации с группой источников.
host
string / required
IP-адрес или имя хоста APIC, разрешаемое управляющим хостом Ansible.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_HOST.

псевдонимы: hostname
name_alias
string
Псевдоним текущего объекта. Он относится к полю nameAlias в ACI.
output_level
string
    Варианты:
  • debug
  • info
  • normal ←
Влияет на вывод этого модуля ACI.
normal означает стандартный вывод, включая current словарь
info добавляет информативный вывод, включая previous, proposed и sent словари
debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию
Если значение не указано в задаче, будет использовано значение переменной среды ACI_OUTPUT_LEVEL.
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
string
Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи.
Это значение также влияет на значение по умолчанию certificate_name, которое используется.
Этот параметр взаимно исключается с password. Если также предоставлено password, оно будет проигнорировано.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_PRIVATE_KEY.

псевдонимы: cert_key
src_group
string
Имя группы источников Span.

псевдонимы: name
state
string
    Варианты:
  • absent
  • present ←
  • query
Используйте present или absent для добавления или удаления.
Используйте query для отображения объекта или нескольких объектов.
tenant
string
Имя арендатора.

псевдонимы: tenant_name
timeout
integer
По умолчанию:
30
Таймаут уровня сокета в секундах.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_TIMEOUT.
use_proxy
boolean
    Варианты:
  • no
  • yes ←
Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_USE_PROXY.
use_ssl
boolean
    Варианты:
  • no
  • yes ←
Если no, вместо стандартного HTTPS-соединения будет использоваться HTTP-соединение.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_USE_SSL.
username
string
По умолчанию:
"admin"
Имя пользователя для аутентификации.
Если значение не указано в задаче, будут использованы переменные среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

псевдонимы: user
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверяться.
Это следует задавать значением no только при работе с сайтами, контролируемыми лично, с использованием самоподписанных сертификатов.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_VALIDATE_CERTS.

Примечания

Примечание

  • Необходимый tenant должен существовать перед использованием этого модуля в вашей книге задач. Для этого можно использовать модуль cisco.aci.aci_tenant.

См. также

См. также

cisco.aci.aci_tenant

Официальная документация по модулю cisco.aci.aci_tenant.

APIC Management Information Model reference

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

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

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

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

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

Примеры

- cisco.aci.aci_tenant_span_src_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    src_group: "{{ src_group }}"
    dst_group: "{{ dst_group }}"
    admin_state: "{{ admin_state }}"
    description: "{{ description }}"
  delegate_to: localhost

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

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

Ключ Возвращённое значение Описание
current
список / элементы=строка
успех
Текущая конфигурация с APIC после завершения модуля

Пример:
[{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error
словарь
ошибка
Информация об ошибке, возвращённая APIC

Пример:
{'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string
строка
ошибка или отладка
Строка фильтра, используемая для запроса

Пример:
?rsp-prop-include=config-only
method
строка
ошибка или отладка
HTTP-метод, используемый для запроса к APIC

Пример:
POST
previous
список / элементы=строка
информация
Исходная конфигурация с APIC до запуска модуля

Пример:
[{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed
словарь
информация
Собраная конфигурация из параметров пользователя

Пример:
{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw
строка
ошибка парсинга
Необработанный результат, возвращённый APIC REST API (xml или json)

Пример:
<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response
строка
ошибка или отладка
HTTP-ответ от APIC

Пример:
OK (30 байт)
sent
список / элементы=строка
информация
Фактическая/минимальная конфигурация, отправленная в APIC

Пример:
{'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/aci/aci_tenant_span_src_group_module.html

Spec-Zone.ru

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