Модуль cisco.aci.aci_bgp_rr_node – Управление объектами BGP Route Reflector (bgp:RRNodePEp)

Примечание

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

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

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

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

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

Описание

Управление узлами ACI BGP Route Reflector.

Параметры

Параметр	Комментарии
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 string	Описание узла отражателя маршрута
host aliases: hostname string	IP-адрес или имя узла APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
node_id integer	ID узла отражателя маршрута
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `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`.
pod_id integer	Под, к которому принадлежит узел
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`.
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`

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 aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это должно быть установлено в `false` только при использовании на контролируемых сайтах с самозаверяющимися сертификатами. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

См. также

APIC Management Information Model reference: Дополнительная информация об внутренней APIC-классе bgp:RRNodePEp.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new BGP Route Reflector
  cisco.aci.aci_bgp_rr_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    node_id: 101
    pod_id: 1
    state: present
    delegate_to: localhost

- name: Remove a BGP Route Reflector
  cisco.aci.aci_bgp_rr_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    node_id: 101
    state: absent
    delegate_to: localhost

- name: Query a BGP Route Reflector
  cisco.aci.aci_bgp_rr_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    node_id: 101
    state: query
    delegate_to: localhost
    register: query_result

- name: Query all BGP Route Reflectors
  cisco.aci.aci_bgp_rr_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    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": "", "ownerTag": ""}}}]`
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": "", "ownerTag": ""}}}]`
proposed dictionary	Собранная конфигурация из предоставленных пользователем параметров Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	Необработанный вывод, возвращаемый API REST APIC (xml или json) Возвращается: parse error Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class \"/></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	HTTP-url, используемый для запроса к APIC Возвращается: failure or debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

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_bgp_rr_node_module.html