Модуль cisco.aci.aci_subject_label – Управление метками субъектов (vz:ConsSubjLbl и vz:ProvSubjLbl)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_subject_label.
Обзор
- Управление метками субъектов на тканях Cisco ACI.
Параметры
Параметр | Комментарии |
|---|---|
annotation строка | Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной окружения Если значение не указано в задаче и переменной окружения По умолчанию: |
ap псевдонимы: app_profile, app_profile_name, application_profile, application_profile_name строка | Название профиля приложения. |
certificate_name псевдонимы: cert_name строка | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем Если для Если значение не указано в задаче, используется значение переменной окружения |
complement логическое | Включен ли complement для метки объекта. APIC по умолчанию использует значение Варианты:
|
contract псевдонимы: contract_name строка | Имя контракта. |
description псевдонимы: descr строка | Описание метки объекта. |
| ... |
password string | Пароль для аутентификации. Этот параметр взаимоисключающий с Если значение не указано в задании, будет использовано значение переменных окружения |
port integer | Номер порта для подключения REST. Значение по умолчанию зависит от параметра Если значение не указано в задании, будет использовано значение переменной окружения |
private_key aliases: cert_key string | Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию Этот параметр взаимоисключающий с Если значение не указано в задании, будет использовано значение переменной окружения |
state string | Используйте Используйте Варианты:
|
subject aliases: subject_name string | Имя субъекта. |
subject_label aliases: subject_label_name, name, label string | Имя метки субъекта. |
subject_label_type aliases: type string / обязательно | Определяет тип метки субъекта. Варианты:
|
suppress_previous aliases: no_previous, ignore_previous boolean | Если Если значение не указано в задании, будет использовано значение переменной окружения Значение по умолчанию ПРЕДУПРЕЖДЕНИЕ - Это приводит к пустому значению предыдущего возвращаемого значения. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты:
|
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задании, будет использовано значение переменной окружения Значение по умолчанию ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в задании. Варианты:
|
tag string | Цвет метки политики Subject Label. APIC по умолчанию использует Возможные значения:
|
tenant aliases: tenant_name string | Имя Tenant. |
timeout integer | Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию 30. |
use_proxy boolean | Если Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию true. Возможные значения:
|
| ... |
См. также
См. также
- Справочник по модели информации управления APIC
-
Дополнительная информация об внутренней классе APIC vz:ConsSubjLbl и (vz:ProvSubjLbl).
- Руководство по Cisco ACI
-
Подробная информация о управлении инфраструктурой Cisco ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.
Примеры
- name: Add a Subject Label on a Contract Subject
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web
subject: web_subject
subject_label: web_subject_label
subject_type: consumer
state: present
delegate_to: localhost
- name: Add a Subject Label on a L2Out External EPG
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l2out: l2out_name
external_epg: external_epg_name
subject_label: l2out_subject_label
subject_type: consumer
state: present
delegate_to: localhost
- name: Add a Subject Label on a L3Out External EPG
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: l3out_name
external_epg: external_epg_name
subject_label: l3out_subject_label
subject_type: consumer
state: present
delegate_to: localhost
- name: Add a Subject Label on a L3Out External EPG Contract
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: l3out_name
external_epg: external_epg_name
contract: web
subject_label: l3out_subject_label
subject_type: consumer
state: present
delegate_to: localhost
- name: Add a Subject Label on a ESG
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
ap: app_profile_name
esg: esg_name
subject_label: esg_subject_label
subject_type: consumer
state: present
delegate_to: localhost
- name: Add a Subject Label on a EPG
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
ap: app_profile_name
epg: epg_name
subject_label: epg_subject_label
subject_type: consumer
state: present
delegate_to: localhost
- name: Add a Subject Label on a EPG Contract
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
ap: app_profile_name
epg: epg_name
contract: web
subject_label: epg_subject_label
subject_type: consumer
state: present
delegate_to: localhost
- name: Query a Subject Label on a Contract Subject
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web
subject: web_subject
subject_label: web_subject_label
subject_type: consumer
state: query
delegate_to: localhost
register: query_result
- name: Query all Subject Labels
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
- name: Remove a Subject Label on a Contract Subject
cisco.aci.aci_subject_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web
subject: web_subject
subject_label: web_subject_label
subject_type: consumer
state: absent
delegate_to: localhost
Значения возврата
Общие значения возврата задокументированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
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_subject_label_module.html