Spec-Zone.ru › Ansible

cisco.aci.aci_node_mgmt_epg_to_contract module – Привязка EPG управления узлами к контрактам (fv:RsCons, fv:RsProv, fv:RsProtBy, fv:RsConsIf и mgmt:RsOoBProv)

Примечание

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

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

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

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

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

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

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

  • Привязка EPG управления узлами к контрактам на фабриках Cisco ACI.

Параметры

Параметр

Описание

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.

contract

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

string

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

contract_type

string / обязательный

Определяет тип контракта.

Варианты:

  • "consumer"
  • "provider"
  • "taboo"
  • "interface"

epg

псевдоним: epg_name

string

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

epg_type

псевдоним: type

string / обязательный

Тип группы конечных точек управления узлами.

Варианты:

  • "in_band"
  • "out_of_band"

host

псевдоним: hostname

string

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

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

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

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

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

password

string

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

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

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

port

integer

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

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

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

priority

string

Класс качества обслуживания (QoS).

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

Варианты:

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

private_key

псевдоним: cert_key

string

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

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

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

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

provider_match

string

Алгоритм сопоставления для предоставляемых контрактов.

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

Варианты:

  • "all"
  • "at_least_one"
  • "at_most_one"
  • "none"

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

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

Примечания

Примечание

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

См. также

См. также

cisco.aci.aci_node_mgmt_epg

EPG управления внутриполосным или внеполосным трафиком (mgmt:OoB и mgmt:InB).

cisco.aci.aci_contract

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

cisco.aci.aci_oob_contract

Управление ресурсами контрактов для внеполосного доступа (OOB) (vz:OOBBrCP).

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

Дополнительные сведения о внутренних классах APIC fv:RsCons, fv:RsProv, fv:RsProtBy, fv:RsConsIf и mgmt:RsOoBProv.

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

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

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

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

Примеры

- name: Add a new contract to Inband EPG binding
  cisco.aci.aci_node_mgmt_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    epg: anstest
    epg_type: in_band
    contract: anstest_http
    contract_type: provider
    priority: level2
    provider_match: at_least_one
    state: present
  delegate_to: localhost

- name: Add a new contract to Out-of-Band EPG binding
  cisco.aci.aci_node_mgmt_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    epg: anstest
    epg_type: out_of_band
    contract: anstest_http
    contract_type: provider
    priority: level3
    state: present
  delegate_to: localhost

- name: Update a contract of Inband EPG binding
  cisco.aci.aci_node_mgmt_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    epg: anstest
    epg_type: in_band
    contract: anstest_http
    contract_type: provider
    priority: level5
    provider_match: all
    state: present
  delegate_to: localhost

- name: Query a specific contract to EPG binding
  cisco.aci.aci_node_mgmt_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    epg: anstest
    epg_type: in_band
    contract: anstest_http
    contract_type: consumer
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all provider contract to EPG bindings
  cisco.aci.aci_node_mgmt_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    contract_type: provider
    state: query
  delegate_to: localhost
  register: query_result

- name: Remove an existing contract to Inband EPG binding
  cisco.aci.aci_node_mgmt_epg_to_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    epg: anstest
    epg_type: in_band
    contract: anstest_http
    contract_type: consumer
    state: absent
  delegate_to: localhost

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

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

Ключ

Описание

current

list / элементы=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 / элементы=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 / элементы=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"

Авторы

  • Faiz Mohammad (@Ziaf007)

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

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

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

Spec-Zone.ru

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