cisco.aci.aci_cloud_bgp_asn модуль — Управление профилем автономной системы BGP Cloud APIC (cloud:BgpAsP)

Примечание

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

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

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

Для использования в книге задач укажите: cisco.aci.aci_cloud_bgp_asn.

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

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

Описание

Управление профилем автономной системы BGP для Cloud APIC

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
asn строка	Номер автономной системы BGP.
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для проверки подлинности на основе подписи. Если указано имя файла `private_key`, значение по умолчанию устанавливается в `private_key` без расширения. Если для `private_key` предоставлено содержимое в формате PEM, значение по умолчанию устанавливается в `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание профиля автономной системы BGP.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешимое хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`.
name псевдонимы: autonomous_system_profile, autonomous_system_profile_name строка	имя объекта
name_alias строка	Псевдоним текущего объекта. Связан с полем nameAlias в ACI.
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`.
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`.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous булево	Если `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`, после обновления APIC с помощью POST-запроса проверка 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 aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует установить в `false` только при работе с сайтами под собственным управлением, использующими самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Доступные значения: `false` `true`

Примечания

Примечание

Дополнительную информацию об внутреннем классе APIC cloud:BgpAsP можно найти в справочнике по модели управления информацией APIC.

См. также

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

Примеры

- name: Add a new cloud BGP ASN
  cisco.aci.aci_cloud_bgp_asn:
    host: apic
    username: admin
    password: SomeSecretPassword
    asn: 64601
    description: ASN description
    name: ASN_1
    state: present
  delegate_to: localhost
- name: Remove a cloud BGP ASN
  cisco.aci.aci_cloud_bgp_asn:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    state: absent
  delegate_to: localhost
- name: Query a cloud BGP ASN
  cisco.aci.aci_cloud_bgp_asn:
    host: apic
    username: admin
    password: SomeSecretPassword
    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 строка	Необработанный вывод, возвращённый 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 строка	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"`

Авторы

Anvitha Jain (@anvitha-jain)

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

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