Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_l3out_logical_interface_profile – Управление профилями логических интерфейсов Layer 3 Outside (L3Out) (l3ext:LIfP)

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.aci.aci_l3out_logical_interface_profile.

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

Обзор

  • Управление профилями интерфейсов L3Out на устройствах Cisco ACI.

Параметры

Параметр

Комментарии

annotation

строка

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

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

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

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

certificate_name

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

строка

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

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

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

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

description

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

строка

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

egress_dpp_policy

строка

Имя политики ограничения трафика egress на уровне данных.

host

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

строка

IP-адрес или имя хоста APIC, разрешаемое хостом Ansible.

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

igmp_interface_profile

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

словарь

Профиль интерфейса IGMP.

igmp

псевдонимы: igmp_interface_policy, name

строка

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

tenant

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

строка

Имя домена, к которому принадлежит политика интерфейса IGMP.

ingress_dpp_policy

строка

Имя политики ограничения трафика ingress на уровне данных.

interface_profile

псевдонимы: name, interface_profile_name, logical_interface

строка

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

l3out

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

строка

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

nd_policy

строка

Имя политики обнаружения соседей.

node_profile

псевдонимы: node_profile_name, logical_node

строка

Имя профиля узла.

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.

owner_key

строка

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

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

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

owner_tag

string

Строка, определённая пользователем, для атрибута ownerTag объекта ACI.

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

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

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

password

string

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

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

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

pim_v4_interface_profile

aliases: pim_v4

dictionary

Профиль интерфейса PIM IPv4.

pim

aliases: pim_interface_policy, name

string

Имя политики интерфейса PIM IPv4.

tenant

aliases: tenant_name

string

Имя клиента, к которому относится политика интерфейса PIM IPv4.

pim_v6_interface_profile

aliases: pim_v6

dictionary

Профиль интерфейса PIM IPv6.

pim

aliases: pim_interface_policy, name

string

Имя политики интерфейса PIM IPv6.

tenant

aliases: tenant_name

string

Имя клиента, к которому относится политика интерфейса PIM IPv6.

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.

qos_custom_policy

aliases: qos_custom_policy_name

string

Имя пользовательской политики QoS.

qos_priority

aliases: priority, prio

string

Идентификатор класса приоритета QoS.

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

Выбор:

  • "level1"
  • "level2"
  • "level3"
  • "level4"
  • "level5"
  • "level6"
  • "unspecified"

state

string

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

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

Выбор:

  • "absent"
  • "present" ← (по умолчанию)
  • "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, после обновления APIC с помощью POST-запроса проверка с помощью GET-запроса не будет выполняться.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды 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, l3out и node_profile должны существовать до использования данного модуля в вашем плане выполнения. Для этого можно использовать модули cisco.aci.aci_tenant, cisco.aci.aci_l3out и cisco.aci.aci_l3out_logical_node_profile.

См. также

См. также

cisco.aci.aci_tenant

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

cisco.aci.aci_l3out

Управление объектами Layer 3 Outside (L3Out) (l3ext:Out).

cisco.aci.aci_l3out_logical_node_profile

Управление логическими профилями узлов Layer 3 Outside (L3Out) (l3ext:LNodeP).

APIC Management Information Model reference

Дополнительная информация об внутренней APIC-классе l3ext:LIfP.

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

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

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

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

Примеры

- name: Add a new interface profile
  cisco.aci.aci_l3out_logical_interface_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    state: present
  delegate_to: localhost

- name: Query an interface profile
  cisco.aci.aci_l3out_logical_interface_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    state: query
  delegate_to: localhost
  register: query_result

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

- name: Delete an interface profile
  cisco.aci.aci_l3out_logical_interface_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    state: absent
  delegate_to: localhost

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

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

Ключ

Описание

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"

Авторы

  • Marcel Zehnder (@maercu)
  • Gaspard Micol (@gmicol)

Ссылки на сборку

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

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

Spec-Zone.ru

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