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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.aci.aci_route_control_context.

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

Обзор

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

Параметры

Параметр	Комментарии
действие строка	Необходимое действие при выполнении условия. Варианты: `"deny"` `"permit"`
правило_действия алиасы: имя_правила_действия строка	Имя профиля правила действия, которое должно быть связано с этим контекстом управления маршрутизацией. Установите правила для карты маршрутизации.
аннотация строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменная окружения `ACI_ANNOTATION`, используется значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
имя_сертификата алиасы: имя_серт строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для проверки подлинности на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_CERTIFICATE_NAME`.
описание алиасы: описание строка	Описание контекста управления маршрутизацией.
хост алиасы: имя_хоста строка	IP-адрес или имя хоста, разрешаемый хостом управления Ansible. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_HOST`.
l3out алиасы: имя_l3out строка	Имя существующего L3Out. Использовать только в случае, если профиль управления маршрутизацией связан с существующим L3Out.
правило_сопоставления алиасы: имя_правила_сопоставления строка	Имя профиля правила сопоставления, которое должно быть связано с этим контекстом управления маршрутизацией. Установите сопоставленные правила.
псевдоним_имени строка	Псевдоним текущего объекта. Он относится к полю nameAlias в ACI.
порядок целое число	Порядок контекста управления маршрутизацией. Диапазон значений от 0 до 9.
уровень_вывода строка	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
путь_вывода строка	Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI в формате JSON, сгенерированных модулем. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_OUTPUT_PATH`.
ключ_владельца строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_OWNER_KEY`.
тег_владельца строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег, позволяющий клиентам добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_OWNER_TAG`.
пароль строка	Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если `private_key` также предоставлен, он будет использован вместо него. Если значение не указано в задаче, вместо него используются переменные окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
порт целое число	Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_PORT`.

private_key aliases: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Эта опция является взаимоисключающей с `password`. Если `password` также указано, оно будет проигнорировано. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
route_control_context aliases: name, route_control_context_name, context string	Имя контекста управления маршрутизацией, который создается.
route_control_profile aliases: route_control_profile_name string	Имя существующего профиля управления маршрутизацией.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления одного или нескольких объектов. Choices: `"absent"` `"present"` ← (default) `"query"`
suppress_previous aliases: no_previous, ignore_previous boolean	Если `true`, запрос GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Choices: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, подтверждающий запрос GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, будет невозможно проверить в одной задаче. Choices: `false` `true`
tenant aliases: tenant_name string	Имя существующего арендатора.
timeout integer	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию — true. Choices: `false` `true`
use_ssl boolean	Если `false`, будет использоваться HTTP-соединение вместо соединения HTTPS по умолчанию. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию — true, когда соединение локальное. Choices: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, SSL-сертификаты не будут проверяться. Это следует устанавливать в `false` только при использовании на лично контролируемых сайтах с самозаверяющими сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Choices: `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 Management Information Model reference: Дополнительная информация об внутренней класс 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 список / элементы=строка	Текущая конфигурация с APIC после завершения модуля Возвращено: успех Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerauto_continue": ""}}}]`
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": "", "ownerauto_continue": ""}}}]`
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"`

Авторы

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

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

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