Spec-Zone.ru › Ansible

Модуль 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

строка

Пользовательская строка для аннотирования объекта.

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

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

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

ap

псевдонимы: app_profile, app_profile_name, application_profile, application_profile_name

строка

Название профиля приложения.

certificate_name

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

строка

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

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

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

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

complement

логическое

Включен ли complement для метки объекта.

APIC по умолчанию использует значение false при создании, если не задано.

Варианты:

  • false
  • true

contract

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

строка

Имя контракта.

description

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

строка

Описание метки объекта.

...

password

string

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

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

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

port

integer

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

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

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

private_key

aliases: cert_key

string

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

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

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

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

state

string

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

Используйте query для получения списка объекта или нескольких объектов.

Варианты:

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

subject

aliases: subject_name

string

Имя субъекта.

subject_label

aliases: subject_label_name, name, label

string

Имя метки субъекта.

subject_label_type

aliases: type

string / обязательно

Определяет тип метки субъекта.

Варианты:

  • "consumer"
  • "provider"

suppress_previous

aliases: no_previous, ignore_previous

boolean

Если 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, проверка GET не будет отправлена после обновления POST в APIC.

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

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

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

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

Варианты:

  • false
  • true

tag

string

Цвет метки политики Subject Label.

APIC по умолчанию использует yellow-green, если значение не задано при создании.

Возможные значения:

  • "alice_blue"
  • "antique_white"
  • "aqua"
  • "aquamarine"
  • "azure"
  • "beige"
  • "bisque"
  • "black"
  • "blanched_almond"
  • "blue"
  • "blue_violet"
  • "brown"
  • "burlywood"
  • "cadet_blue"
  • "chartreuse"
  • "chocolate"
  • "coral"
  • "cornflower_blue"
  • "cornsilk"
  • "crimson"
  • "cyan"
  • "dark_blue"
  • "dark_cyan"
  • "dark_goldenrod"
  • "dark_gray"
  • "dark_green"
  • "dark_khaki"
  • "dark_magenta"
  • "dark_olive_green"
  • "dark_orange"
  • "dark_orchid"
  • "dark_red"
  • "dark_salmon"
  • "dark_sea_green"
  • "dark_slate_blue"
  • "dark_slate_gray"
  • "dark_turquoise"
  • "dark_violet"
  • "deep_pink"
  • "deep_sky_blue"
  • "dim_gray"
  • "dodger_blue"
  • "fire_brick"
  • "floral_white"
  • "forest_green"
  • "fuchsia"
  • "gainsboro"
  • "ghost_white"
  • "gold"
  • "goldenrod"
  • "gray"
  • "green"
  • "green_yellow"
  • "honeydew"
  • "hot_pink"
  • "indian_red"
  • "indigo"
  • "ivory"
  • "khaki"
  • "lavender"
  • "lavender_blush"
  • "lawn_green"
  • "lemon_chiffon"
  • "light_blue"
  • "light_coral"
  • "light_cyan"
  • "light_goldenrod_yellow"
  • "light_gray"
  • "light_green"
  • "light_pink"
  • "light_salmon"
  • "light_sea_green"
  • "light_sky_blue"
  • "light_slate_gray"
  • "light_steel_blue"
  • "light_yellow"
  • "lime"
  • "lime_green"
  • "linen"
  • "magenta"
  • "maroon"
  • "medium_aquamarine"
  • "medium_blue"
  • "medium_orchid"
  • "medium_purple"
  • "medium_sea_green"
  • "medium_slate_blue"
  • "medium_spring_green"
  • "medium_turquoise"
  • "medium_violet_red"
  • "midnight_blue"
  • "mint_cream"
  • "misty_rose"
  • "moccasin"
  • "navajo_white"
  • "navy"
  • "old_lace"
  • "olive"
  • "olive_drab"
  • "orange"
  • "orange_red"
  • "orchid"
  • "pale_goldenrod"
  • "pale_green"
  • "pale_turquoise"
  • "pale_violet_red"
  • "papaya_whip"
  • "peachpuff"
  • "peru"
  • "pink"
  • "plum"
  • "powder_blue"
  • "purple"
  • "red"
  • "rosy_brown"
  • "royal_blue"
  • "saddle_brown"
  • "salmon"
  • "sandy_brown"
  • "sea_green"
  • "seashell"
  • "sienna"
  • "silver"
  • "sky_blue"
  • "slate_blue"
  • "slate_gray"
  • "snow"
  • "spring_green"
  • "steel_blue"
  • "tan"
  • "teal"
  • "thistle"
  • "tomato"
  • "turquoise"
  • "violet"
  • "wheat"
  • "white"
  • "white_smoke"
  • "yellow"
  • "yellow_green"

tenant

aliases: tenant_name

string

Имя Tenant.

timeout

integer

Таймаут уровня сокета в секундах.

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

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

use_proxy

boolean

Если false, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.

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

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

Возможные значения:

  • false
  • 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 после завершения модуля

Возвращено: успех

Пример: [{"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

строка

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

Авторы

  • Mark Ciecior (@markciecior)
  • Akini Ross (@akinross)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 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

Spec-Zone.ru

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