Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_tenant_action_rule_profile — Управление профилями правил действий (rtctrl:AttrP)

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

action_rule

aliases: action_rule_name, name

string

Имя профиля правила действия.

annotation

string

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

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

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

Default: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

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

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

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

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

description

aliases: descr

string

Описание профиля правила действия.

host

aliases: hostname

string

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

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

multipath

boolean

Установить правило действия на основе конфигурации множественного пути перераспределения.

Не может быть настроено вместе с set_route_tag.

Не может быть настроено для версии APIC 4.2 и более ранних.

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

Choices:

  • false
  • true

name_alias

string

Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.

next_hop_propagation

boolean

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

Не может быть настроено вместе с set_route_tag.

Не может быть настроено для версии APIC 4.2 и более ранних.

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

Choices:

  • false
  • true

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая current dict

info добавляет информационный вывод, включая previous, proposed и sent dicts

debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию

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

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

output_path

string

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

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

password

string

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

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

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

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.

set_community

dictionary

Установить правило действия на основе сообществ.

Чтобы удалить этот атрибут, передайте пустой словарь.

community

string

Значение сообщества.

criteria

string

Критерии сообщества.

Вариант добавления или замены значения сообщества.

Варианты:

  • "append"
  • "replace"
  • "none"

set_dampening

dictionary

Установка правила действия на основе подавления.

Для удаления этого атрибута передайте пустой словарь.

half_life

integer

Значение времени полураспада (минуты).

max_suppress_time

integer

Максимальное время подавления (минуты).

reuse

integer

Значение предела повторного использования.

suppress

integer

Значение предела подавления.

set_metric

string

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

Для удаления этого атрибута передайте пустую строку.

set_metric_type

string

Установить правило действия на основе типа метрики.

Для удаления этого атрибута передайте пустую строку.

Варианты:

  • "ospf_type_1"
  • "ospf_type_2"
  • ""

set_next_hop

string

Установка правила действия на основе адреса следующего узла.

Для удаления этого атрибута передайте пустую строку.

set_preference

string

Установка правила действия на основе предпочтения.

Для удаления этого атрибута передайте пустую строку.

set_route_tag

string

Установка правила действия на основе тега маршрута.

Не может быть настроено вместе с next_hop_propagation и multipath.

Для удаления этого атрибута передайте пустую строку.

set_weight

string

Установка правила действия на основе веса.

Для удаления этого атрибута передайте пустую строку.

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, проверяющий GET не будет отправлен после обновления POST в APIC.

Если значение не указано в задании, будет использовано значение переменной среды 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
END_OF_DOCUMENT_MARKER

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 не будут проверены.

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

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

Значение по умолчанию — true.

Возможные значения:

  • false
  • true

Примечания

Примечание

  • Необходимая tenant должна существовать перед использованием данного модуля в вашем плейбуке. Для этого можно использовать модуль cisco.aci.aci_tenant.

См. также

См. также

cisco.aci.aci_tenant

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

APIC Management Information Model reference

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

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

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

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

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

Примеры

- name: Create a action rule profile
  cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    set_preference: 100
    set_weight: 100
    set_metric: 100
    set_metric_type: ospf_type_1
    set_next_hop: 1.1.1.1
    next_hop_propagation: true
    multipath: true
    set_community:
      community: no-advertise
      criteria: replace
    set_dampening:
      half_life: 10
      reuse: 1
      suppress: 10
      max_suppress_time: 100
    state: present
  delegate_to: localhost

- name: Delete action rule profile's children
  cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    set_preference: ""
    set_weight: ""
    set_metric: ""
    set_metric_type: ""
    set_next_hop: ""
    next_hop_propagation: false
    multipath: false
    set_community: {}
    set_dampening: {}
    state: present
  delegate_to: localhost

- name: Delete a action rule profile
  cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    state: absent
  delegate_to: localhost

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

- name: Query a specific action rule profile
  cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

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

строка

Необработанный вывод, возвращённый APIC REST API (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"

Авторы

  • Dag Wieers (@dagwieers)
  • Tim Cragg (@timcragg)
  • 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_tenant_action_rule_profile_module.html

Spec-Zone.ru

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