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

Новое в версии 2.4.

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

Обзор

Управление контекстами или VRF на тканях Cisco ACI.
Каждый контекст — это частная сеть, связанная с арендатором, т. е. VRF.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен `private_key` файл имени, по умолчанию используется `private_key` базовое имя без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется `username` значение. псевдонимы: cert_name
description строка		Описание VRF. псевдонимы: descr
host строка / обязательно		IP-адрес или имя хоста APIC, разрешимый контрольным хостом Ansible. псевдонимы: hostname
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию
password строка / обязательно		Пароль для аутентификации. Этот параметр является взаимоисключающим с `private_key`. Если также предоставлен `private_key`, он будет использован вместо него.
policy_control_direction строка	Варианты: egress ingress	Определяет, должна ли политика применяться тканью при поступлении или выходе.
policy_control_preference строка	Варианты: enforced unenforced	Определяет, должна ли ткань применять политики соглашений для разрешения маршрутизации и пересылки пакетов.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key строка / обязательно		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр является взаимоисключающим с `password`. Если также предоставлен `password`, он будет проигнорирован. псевдонимы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для получения списка объекта или нескольких объектов.
tenant строка		Имя арендатора, к которому должен принадлежать VRF. псевдонимы: tenant_name
timeout целое число	По умолчанию: 30	Тайм-аут уровня сокета в секундах.
use_proxy булево	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
use_ssl булево	Варианты: no yes ←	Если `no`, будет использоваться соединение HTTP вместо соединения HTTPS по умолчанию.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Это следует установить только в `no` при использовании на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.
vrf строка		Имя VRF. псевдонимы: context, name, vrf_name

Примечания

Примечание

Перед использованием этого модуля в вашей книге задач tenant должен существовать. Для этого можно использовать модуль aci_tenant.

См. также

aci_tenant – Управление арендаторами (fv:Tenant): Официальная документация по модулю aci_tenant.
Справочник по модели управления информацией APIC: Дополнительная информация о внутреннем классе APIC fv:Ctx.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new VRF to a tenant
  aci_vrf:
    host: apic
    username: admin
    password: SomeSecretPassword
    vrf: vrf_lab
    tenant: lab_tenant
    descr: Lab VRF
    policy_control_preference: enforced
    policy_control_direction: ingress
    state: present
  delegate_to: localhost

- name: Remove a VRF for a tenant
  aci_vrf:
    host: apic
    username: admin
    password: SomeSecretPassword
    vrf: vrf_lab
    tenant: lab_tenant
    state: absent
  delegate_to: localhost

- name: Query a VRF of a tenant
  aci_vrf:
    host: apic
    username: admin
    password: SomeSecretPassword
    vrf: vrf_lab
    tenant: lab_tenant
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all VRFs
  aci_vrf:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Возвращаемое значение	Описание
current список	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращённая APIC Пример: {'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список	информация	Исходная конфигурация с APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собраная конфигурация из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw строка	ошибка разбора	Необработанный вывод, возвращенный APIC REST API (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response строка	ошибка или отладка	HTTP-ответ от APIC Пример: OK (30 байт)
sent список	информация	Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status целое число	ошибка или отладка	HTTP-статус с APIC Пример: 200
url строка	ошибка или отладка	HTTP-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

Jacob McGill (@jmcgill298)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/aci_vrf_module.html