Spec-Zone.ru › Ansible

модуль cisco.aci.aci_l4l7_device_selection_interface_context — управление контекстами логических интерфейсов политики выбора устройств L4–L7 (vns:LIfCtx)

Примечание

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

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

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

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

Добавлено в cisco.aci 2.12.0

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

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

  • Управление контекстами логических интерфейсов политики выбора устройств L4–L7

Псевдонимы: aci_l4l7_device_selection_if_context

Параметры

Параметр

Комментарии

acl

логическое значение

Указывает, применяется ли список контроля доступа (ACL) к логическому интерфейсу.

Если при создании значение не задано, APIC использует false.

Варианты:

  • false
  • true

annotation

строка

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

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

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

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

bridge_domain

псевдонимы: bd, bd_name

строка

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

bridge_domain_tenant

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

строка

Арендатор, в котором находится домен моста.

Не указывайте эту переменную, если контекст и домен моста находятся в одном арендаторе.

Предназначено для случаев, когда домен моста находится в общем арендаторе, а контекст — нет.

certificate_name

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

строка

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

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

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

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

context

строка

Имя контекста логического интерфейса.

contract

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

строка

Имя существующего контракта.

description

строка

Краткое описание контекста логического интерфейса.

external_epg

строка

Имя профиля экземпляра внешней сети (внешней EPG или ExtEpg), связанного с L3Out.

graph

псевдонимы: service_graph, service_graph_name

строка

Имя существующего шаблона графа сервисов.

host

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

строка

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

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

l3_destination

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

логическое значение

Указывает, является ли контекст назначением уровня 3.

Если при создании значение не задано, APIC использует true.

Варианты:

  • false
  • true

l3out

строка

Имя объекта Layer 3 Outside (L3Out).

l3out_tenant

строка

Арендатор, в котором находится L3Out.

Не указывайте эту переменную, если контекст и L3Out находятся в одном арендаторе.

logical_device

строка

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

logical_interface

строка

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

node

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

строка

Имя существующего узла графа сервисов.

output_level

строка

Управляет выводом этого модуля ACI.

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

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

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

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

Варианты:

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

output_path

строка

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

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

password

строка

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

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

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

permit_handoff

логическое значение

Указывает, разрешена ли передача трафика связанному логическому интерфейсу.

Если при создании значение не задано, APIC использует false.

Варианты:

  • false
  • true

permit_log

логическое значение

Указывает, следует ли регистрировать разрешённый трафик.

Если при создании значение не задано, APIC использует false.

Варианты:

  • false
  • true

port

целое число

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

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

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

private_key

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

строка

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

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

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

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

redirect_policy

строка

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

redistribute

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

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

Варианты:

  • "bgp"
  • "ospf"
  • "connected"
  • "static"

rule_type

логическое значение

Указывает, использует ли контекст определённый тип правила для обработки трафика.

Если при создании значение не задано, APIC использует false.

Варианты:

  • false
  • true

state

строка

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

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

Варианты:

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

suppress_previous

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

логическое значение

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

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

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

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

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

Варианты:

  • false
  • true

suppress_verification

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

логическое значение

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

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

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

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

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

Варианты:

  • false
  • true

tenant

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

строка

Имя существующего арендатора.

timeout

целое число

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

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

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

use_proxy

логическое значение

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

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

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

Варианты:

  • false
  • true

use_ssl

логическое значение

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

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

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

Варианты:

  • false
  • true

username

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

строка

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

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

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

validate_certs

логическое значение

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

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

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

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

Варианты:

  • false
  • true

Примечания

Примечание

  • Перед использованием этого модуля в плейбуке должны существовать арендатор, граф, контракт и узел. Для этого можно использовать модули cisco.aci.aci_tenant, cisco.aci.aci_l4l7_service_graph_template, cisco.aci.aci_contract и cisco.aci.aci_l4l7_service_graph_template_node.

См. также

См. также

cisco.aci.aci_tenant

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

cisco.aci.aci_l4l7_service_graph_template

Управление шаблонами графов сервисов L4–L7 (vns:AbsGraph).

cisco.aci.aci_contract

Управление ресурсами контрактов (vz:BrCP).

cisco.aci.aci_l4l7_service_graph_template_node

Управление узлами шаблонов графов сервисов L4–L7 (vns:AbsNode).

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

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

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

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

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

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

Примеры

- name: Add a new interface context
  cisco.aci.aci_l4l7_device_selection_interface_context:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    contract: my_contract
    graph: my_graph
    node: my_node
    context: provider
    state: present
  delegate_to: localhost

- name: Query an interface context
  cisco.aci.aci_l4l7_device_selection_interface_context:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    contract: my_contract
    graph: my_graph
    node: my_node
    context: consumer
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all interface contexts
  cisco.aci.aci_l4l7_device_selection_interface_context:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete an interface context
  cisco.aci.aci_l4l7_device_selection_interface_context:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    contract: my_contract
    graph: my_graph
    node: my_node
    context: provider
    state: absent
  delegate_to: localhost

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

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

Ключ

Описание

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

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

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

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

Авторы

  • Tim Cragg (@timcragg)
  • Shreyas Srish (@shrsr)

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

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

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

Spec-Zone.ru

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