Spec-Zone.ru › Ansible

модуль cisco.aci.aci_vrf_fallback_route_group — управление группами резервных маршрутов VRF (fv:FBRGroup, fv:FBRoute и fv:FBRMember)

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.

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

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

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

Краткое описание

  • Управление группами резервных маршрутов VRF в фабриках Cisco ACI.
  • Группы резервных маршрутов используются для задания маршрутов и адресов следующего перехода для VRF.

Параметры

Параметр

Комментарии

annotation

string

Строка, заданная пользователем для добавления аннотации к объекту.

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

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

По умолчанию: "orchestrator:ansible"

certificate_name

псевдонимы: cert_name

string

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

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

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

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

description

псевдонимы: descr

string

Описание группы резервных маршрутов VRF.

fallback_members

псевдонимы: next_hop_address

list / элементы=string

Список IP-адресов резервных участников (адресов следующего перехода) для группы резервных маршрутов VRF.

Участники, отсутствующие в списке, будут удалены из конфигурации.

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

Чтобы удалить всех резервных участников, передайте пустой список.

host

псевдонимы: hostname

string

IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible.

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

name

псевдонимы: vrf_fallback_route_group

string

Имя группы резервных маршрутов VRF.

output_level

string

Управляет выводом этого модуля ACI.

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

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

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

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

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

output_path

string

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

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

owner_key

string

Строка, заданная пользователем для атрибута ownerKey объекта ACI.

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

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

owner_tag

string

Строка, заданная пользователем для атрибута ownerTag объекта ACI.

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

Например, он может указывать, кто создал этот объект.

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

password

string

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

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

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

port

integer

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

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

prefix_address

псевдонимы: fallback_route

string

Резервный маршрут (адрес префикса) для группы резервных маршрутов VRF.

Если параметр не указан, существующий резервный маршрут останется без изменений.

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

private_key

псевдонимы: cert_key

string

Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на используемое значение по умолчанию для certificate_name.

Этот параметр несовместим с password. Если также задан password, он будет проигнорирован.

Если значение не указано в задаче, вместо него используются переменные среды ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

state

string

Для добавления или удаления используйте present или absent.

Для просмотра одного или нескольких объектов используйте query.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

Если true, перед отправкой обновления POST в APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

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

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

ПРЕДУПРЕЖДЕНИЕ — возвращаемое значение previous будет пустым.

Предыдущее состояние объекта не будет проверяться, а запрос POST на обновление будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после отправки обновления POST в APIC проверочный GET-запрос не будет отправлен.

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

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

ПРЕДУПРЕЖДЕНИЕ — в качестве текущего возвращаемого значения будет установлено предлагаемое значение.

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

Варианты:

  • false
  • true

tenant

псевдонимы: tenant_name

string

Имя арендатора, связанного с группой резервных маршрутов VRF.

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

псевдонимы: user

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него используются переменные среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

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

validate_certs

boolean

Если false, сертификаты SSL проверяться не будут.

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

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

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

Варианты:

  • false
  • true

vrf

псевдонимы: context, vrf_name

string

Имя VRF, связанной с группой резервных маршрутов VRF.

Примечания

Примечание

  • Перед использованием этого модуля должны существовать tenant и vrf. При необходимости создайте их с помощью модулей cisco.aci.aci_tenant и cisco.aci.aci_vrf.

См. также

См. также

cisco.aci.aci_vrf

Управление контекстами или VRF (fv:Ctx).

cisco.aci.aci_tenant

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

Справочник информационной модели управления APIC

Дополнительные сведения о внутренних классах APIC fv:FBRGroup, fv:FBRoute и fv:FBRMember.

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

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

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

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

Примеры

- name: Create a new VRF Fallback Route Group
  cisco.aci.aci_vrf_fallback_route_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_test
    vrf: vrf_test
    vrf_fallback_route_group: test_fallback_route_group
    fallback_route: 1.1.1.1/24
    fallback_members:
      - 192.168.1.1
      - 192.168.1.2
    description: Test Fallback Route Group
    state: present
  delegate_to: localhost

- name: Update fallback members in an existing VRF Fallback Route Group
  cisco.aci.aci_vrf_fallback_route_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_test
    vrf: vrf_test
    vrf_fallback_route_group: test_fallback_route_group
    fallback_members:
      - 192.168.1.1
      - 192.168.1.3
    state: present
  delegate_to: localhost

- name: Delete children for VRF Fallback Route Group
  cisco.aci.aci_vrf_fallback_route_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_test
    vrf: vrf_test
    vrf_fallback_route_group: test_fallback_route_group
    fallback_route: ""
    fallback_members: []
    state: present
  delegate_to: localhost

- name: Query a VRF Fallback Route Group
  cisco.aci.aci_vrf_fallback_route_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_test
    vrf: vrf_test
    vrf_fallback_route_group: test_fallback_route_group
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all VRF Fallback Route Groups
  cisco.aci.aci_vrf_fallback_route_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a VRF Fallback Route Group
  cisco.aci.aci_vrf_fallback_route_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_test
    vrf: vrf_test
    vrf_fallback_route_group: test_fallback_route_group
    state: absent
  delegate_to: localhost

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

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

Ключ

Описание

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

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

Авторы

  • Dev Sinha (@devsinha13)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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