Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_fabric_span_src_group_src_path – Управление путями источников SPAN Fabric (span:RsSrcToPathEp)

Примечание

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

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

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

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

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

Обзор

  • Управление путями источников SPAN Fabric на 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.

host

aliases: hostname

string

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

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

node

aliases: node_id

integer

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

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.

password

string

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

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

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

path_ep

string

Путь исходного пути доступа.

Необходимо указать интерфейс, например, eth1/7.

pod

aliases: pod_id, pod_number

integer

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

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.

source

aliases: src

string

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

source_group

aliases: src_group

string

Имя группы источников Fabric 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

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

aliases: 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 Management Information Model reference

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

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

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

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

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

Примеры

- name: Create a Fabric SPAN source path of type path
  cisco.aci.aci_fabric_span_src_group_src_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    source_group: my_span_source_group
    source: my_source
    pod: 1
    node: 101
    path_ep: eth1/1
    state: present
  delegate_to: localhost

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

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

- name: Query a specific Fabric SPAN source path
  cisco.aci.aci_fabric_span_src_group_src_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    source_group: my_span_source_group
    source: my_source
    pod: 1
    node: 101
    path_ep: eth1/1
    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

строка

Необработанный вывод 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

строка

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"

Авторы

  • Akini Ross (@akinross)

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

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

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

Spec-Zone.ru

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