модуль cisco.aci.aci_subject_label — управление метками субъекта (vz:ConsSubjLbl и vz:ProvSubjLbl)

annotation

string

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

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

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

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

ap

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

string

Имя профиля приложения.

certificate_name

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

string

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

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

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

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

complement

boolean

Определяет, включено ли дополнение для метки субъекта.

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

Варианты:

• false
• true

contract

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

string

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

description

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

string

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

epg

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

string

Имя группы конечных точек.

esg

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

string

Имя группы безопасности конечных точек.

external_epg

псевдонимы: extepg, extepg_name, external_epg_name

string

Имя внешней группы конечных точек.

host

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

string

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

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

l2out

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

string

Имя L2Out.

l3out

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

string

Имя L3Out.

name_alias

string

Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.

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

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

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды 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.

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"

subject

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

string

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

subject_label

псевдонимы: subject_label_name, name, label

string

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

subject_label_type

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

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

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

Варианты:

• "consumer"
• "provider"

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

tag

string

Цвет метки политики метки субъекта.

При создании 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

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

string

Имя арендатора.

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

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"