Spec-Zone.ru › Ansible

модуль cisco.aci.aci_l4l7_service_graph_template_node – управление узлами шаблонов графов сервисов L4-L7 (vns:AbsNode)

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install cisco.aci.

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

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

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

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

  • Управление узлами шаблонов графов сервисов L4-L7.

Параметры

Параметр

Комментарии

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.

description

string

Описание узла шаблона графа сервисов.

device

string

Имя существующего логического устройства.

device_tenant

string

Тенант, в котором находится логическое устройство.

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

Предполагается, что устройство находится в тенанте common, а узел — нет.

function_type

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

string

Тип функции.

При создании APIC использует значение go_to по умолчанию, если параметр не задан.

Варианты:

  • "go_to"
  • "go_through"
  • "l1"
  • "l2"

functional_template_type

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

string

Тип функционального шаблона для узла.

При создании APIC использует значение other по умолчанию, если параметр не задан.

Варианты:

  • "adc_one_arm"
  • "adc_two_arm"
  • "cloud_native_fw"
  • "cloud_native_lb"
  • "cloud_vendor_fw"
  • "cloud_vendor_lb"
  • "fw_routed"
  • "fw_trans"
  • "other"

host

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

string

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

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

is_copy

boolean

Является ли устройство копирующим устройством.

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

Варианты:

  • false
  • true

managed

boolean

Управляется ли это устройство контроллером APIC.

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

Варианты:

  • false
  • true

node

string

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

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.

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

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

string

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

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

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

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

routing_mode

string

Режим маршрутизации для узла.

При создании APIC использует значение unspecified по умолчанию, если параметр не задан.

Варианты:

  • "redirect"
  • "unspecified"

service_graph

string

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

share_encap

boolean

Нужно ли совместно использовать инкапсуляцию в пределах графа сервисов.

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

Варианты:

  • false
  • true

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

tenant

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

string

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

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

Примечания

Примечание

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

См. также

См. также

cisco.aci.aci_tenant

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

cisco.aci.aci_l4l7_service_graph_template

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

cisco.aci.aci_l4l7_device

Управление устройствами L4-L7 (vns:LDevVip).

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

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

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

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

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

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

Примеры

- name: Add a new Service Graph Template Node
  cisco.aci.aci_l4l7_service_graph_template_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    service_graph: test-graph
    node: test-node
    functional_template_type: adc_one_arm
    function_type: GoTo
    device: test-device
    managed: false
    routing_mode: redirect
    state: present
  delegate_to: localhost

- name: Query a Service Graph Template Node
  cisco.aci.aci_l4l7_service_graph_template_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    service_graph: test-graph
    node: test-node
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Service Graph Template Nodes
  cisco.aci.aci_l4l7_service_graph_template_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a Service Graph Template Node
  cisco.aci.aci_l4l7_service_graph_template_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    service_graph: test-graph
    node: test-node
    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

URL 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_service_graph_template_node_module.html

Spec-Zone.ru

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