модуль cisco.aci.aci_route_control_context – Управление контекстом управления маршрутами (rtctrl:CtxP)

Примечание

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

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

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

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

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

Обзор

Управление политиками контекста управления маршрутами для профилей управления маршрутами в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
action строка	Действие, выполняемое при соблюдении условия. Варианты: `"deny"` `"permit"`
action_rule псевдонимы: action_rule_name строка	Имя профиля правила действия, связываемого с этим контекстом управления маршрутами. Задайте правила для Route Map.
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 строка	Описание контекста управления маршрутами.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, доступное для разрешения на управляющем узле Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_HOST`.
l3out псевдонимы: l3out_name строка	Имя существующего объекта L3Out. Используйте только в том случае, если профиль управления маршрутами связан с существующим объектом L3Out.
match_rule псевдонимы: match_rule_name строка	Имя профиля правила сопоставления, связываемого с этим контекстом управления маршрутами. Задайте связанные правила сопоставления.
name_alias строка	Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.
order целое число	Порядок контекста управления маршрутами. Допустимый диапазон значений — от 0 до 9.
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`.
owner_tag строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_OWNER_TAG`.
password строка	Пароль для аутентификации. Этот параметр нельзя использовать одновременно с `private_key`. Если также указан `private_key`, будет использован именно он. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр нельзя использовать одновременно с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
route_control_context псевдонимы: name, route_control_context_name, context строка	Имя создаваемого контекста управления маршрутами.
route_control_profile псевдонимы: route_control_profile_name строка	Имя существующего профиля управления маршрутами.
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`

Примечания

Примечание

tenant и используемый route_control_profile должны существовать до использования этого модуля в плейбуке. Для этого можно использовать модули cisco.aci.aci_tenant и cisco.aci.aci_route_control_profile.
Если используется l3out, используемый l3out должен существовать до использования этого модуля в плейбуке. Для этого можно использовать модуль cisco.aci.aci_l3out.
Если используется action_rule, используемый action_rule должен существовать до использования этого модуля в плейбуке. Для этого можно использовать модуль cisco.aci.aci_tenant_action_rule_profile.
Если используется match_rule, используемый match_rule должен существовать до использования этого модуля в плейбуке. Для этого можно использовать модуль cisco.aci.aci_match_rule.

См. также

cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
cisco.aci.aci_route_control_profile: Управление профилем управления маршрутами (rtctrl:Profile).
cisco.aci.aci_l3out: Управление объектами внешнего уровня 3 (L3Out) (l3ext:Out).
cisco.aci.aci_tenant_action_rule_profile: Управление профилями правил действий (rtctrl:AttrP).
cisco.aci.aci_match_rule: Управление правилами сопоставления (rtctrl:SubjP).
Справочник информационной модели управления APIC: Дополнительные сведения о внутреннем классе APIC rtctrl:CtxP.
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Create a route context policy
  cisco.aci.aci_route_control_context:
    host: apic
    username: admin
    password: SomeSecretPassword
    route_control_context: prod_route_control_context
    route_control_profile: prod_route_control_profile
    tenant: production
    l3out: prod_l3out
    action: permit
    order: 0
    action_rule: prod_action_rule_profile
    match_rule: prod_match_rule
    state: present
  delegate_to: localhost

- name: Delete a route context policy
  cisco.aci.aci_route_control_context:
    host: apic
    username: admin
    password: SomeSecretPassword
    route_control_context: prod_route_control_context
    route_control_profile: prod_route_control_profile
    tenant: production
    l3out: prod_l3out
    state: absent
  delegate_to: localhost

- name: Query all route context policy
  cisco.aci.aci_route_control_context:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific route context policy
  cisco.aci.aci_route_control_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    route_control_context: prod_route_control_context
    route_control_profile: prod_route_control_profile
    tenant: production
    l3out: prod_l3out
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Описание
current list / elements=string	Текущая конфигурация APIC после завершения работы модуля Возвращается: success Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerauto_continue": ""}}}]`
error dictionary	Информация об ошибке, возвращённая APIC Возвращается: failure Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	Строка фильтра, использованная в запросе Возвращается: failure or debug Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: `"POST"`
previous list / elements=string	Исходная конфигурация APIC до начала работы модуля Возвращается: info Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerauto_continue": ""}}}]`
proposed dictionary	Сформированная конфигурация на основе параметров, заданных пользователем Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	Необработанный вывод, возвращённый REST API APIC (xml или json) Возвращается: parse error Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response string	Ответ HTTP от APIC Возвращается: failure or debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	Статус HTTP от APIC Возвращается: failure or debug Пример: `200`
url string	URL HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Gaspard Micol (@gmicol)
Tim Cragg (@timcragg)

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

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