cisco.aci.aci_vrf модуль – Управление контекстами или VRF (fv:Ctx)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.aci.
Для использования в плейбуке укажите: cisco.aci.aci_vrf.
Описание
- Управление контекстами или VRF на Cisco ACI fabric.
- Каждый контекст — это частная сеть, связанная с арендатором, то есть VRF.
- Включить предпочтительные группы для VRF
Параметры
Параметр | Комментарии |
|---|---|
annotation string | Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Если значение не указано в задаче и переменной окружения Default: |
certificate_name aliases: cert_name string | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
description aliases: descr string | Описание для VRF. |
host aliases: hostname string | IP-адрес или имя хоста APIC, разрешаемые узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
ip_data_plane_learning aliases: ip_dataplane_learning string | Включено или выключено обучение IP-каналов передачи данных. APIC по умолчанию использует Choices:
|
match_type string | Настраивает тип соответствия для контрактов под vzAny Choices:
|
name_alias string | Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI. |
output_level string | Влияет на вывод этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Choices:
|
output_path string | Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
owner_key string | Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ для предоставления клиентам права владения своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
owner_tag string | Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег для предоставления клиентам возможности добавлять собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
password string | Пароль, который будет использоваться для аутентификации. Этот параметр является взаимоисключающим с Если значение не указано в задаче, вместо него будут использованы значения переменных окружения |
policy_control_direction string | Определяет, должна ли политика применяться структурой на входе или выходе. Choices:
|
policy_control_preference string | Определяет, должна ли структура применять политики контрактов для разрешения маршрутизации и пересылки пакетов. Choices:
|
port integer | Порт, который будет использоваться для подключения REST. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
preferred_group string | Включает предпочтительные группы для VRF под vzAny Choices:
|
private_key aliases: cert_key string | Либо файл с закрытым ключом в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на используемый по умолчанию Этот параметр взаимоисключающий с Если значение не указано в задаче, будет использовано значение переменной окружения |
state string | Используйте Используйте Варианты:
|
suppress_previous aliases: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты:
|
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче. Варианты:
|
tenant aliases: tenant_name string | Имя Tenant, к которому должен принадлежать VRF. |
timeout integer | Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию 30. |
use_proxy boolean | Если Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию true, когда соединение локальное. Варианты:
|
username aliases: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных окружения Значение по умолчанию admin. |
validate_certs boolean | Если Это следует установить только в Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию true. Варианты:
|
vrf aliases: context, name, vrf_name string | Имя VRF. |
Примечания
Примечание
- Перед использованием данного модуля в вашем плейбуке должен существовать
tenant. Для этого можно использовать модуль cisco.aci.aci_tenant.
См. также
См. также
- cisco.aci.aci_tenant
-
Управление Tenant (fv:Tenant).
- APIC Management Information Model reference
-
Дополнительная информация о внутреннем классе APIC fv:Ctx.
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять инфраструктурой Cisco ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для участия.
Примеры
- name: Add a new VRF to a tenant
cisco.aci.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
cisco.aci.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
cisco.aci.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
cisco.aci.aci_vrf:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
current список / элементы=строка | Существующая конфигурация с APIC после завершения модуля Возвращается при: успехе Пример: |
error словарь | Информация об ошибке, возвращённая APIC Возвращается при: ошибке Пример: |
filter_string строка | Строка фильтра, используемая для запроса Возвращается при: ошибке или отладке Пример: |
method строка | HTTP-метод, используемый для запроса к APIC Возвращается при: ошибке или отладке Пример: |
previous список / элементы=строка | Исходная конфигурация с APIC до запуска модуля Возвращается при: информации Пример: |
proposed словарь | Скомпонованная конфигурация из предоставленных пользователем параметров Возвращается при: информации Пример: |
raw строка | Необработанный вывод, возвращённый API REST APIC (xml или json) Возвращается при: ошибке парсинга Пример: |
response строка | HTTP-ответ с APIC Возвращается при: ошибке или отладке Пример: |
sent список / элементы=строка | Фактическая/минимальная конфигурация, отправленная в APIC Возвращается при: информации Пример: |
status целое число | HTTP-статус с APIC Возвращается при: ошибке или отладке Пример: |
url строка | HTTP-URL, используемый для запроса к APIC Возвращается при: ошибке или отладке Пример: |
Ссылки на коллекции
© 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_vrf_module.html