cisco.aci.aci_domain module – Управление профилями физических, виртуальных, мостовых, маршрутизируемых доменов или доменов FC (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP и fc:DomP)

access_mode

string

Режим доступа для доменов vmm

Этот параметр нельзя изменить после создания домена

Варианты:

• "read-only"
• "read-write"

add_infra_pg

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

boolean

Настройка групп портов для инфраструктурной VLAN (например, Virtual APIC).

Варианты:

• false
• true

annotation

string

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

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

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

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

certificate_name

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

string

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

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

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

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

domain

псевдонимы: domain_name, domain_profile, name

string

Имя профиля физического, виртуального, мостового, маршрутизируемого домена или домена FC.

domain_type

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

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

Тип профиля домена.

fc: профиль домена FC — это политика для одного домена управления FC

l2dom: профиль внешнего мостового домена — это политика управления инфраструктурой L2, мостом вынесенной за пределы фабрики.

l3dom: профиль внешнего маршрутизируемого домена — это политика управления маршрутизируемой инфраструктурой L3 за пределами фабрики.

phys: профиль физического домена хранит физические ресурсы и ресурсы инкапсуляции, которые следует использовать для EPG, связанных с этим доменом.

vmm: профиль домена VMM — это политика группировки контроллеров виртуальных машин с похожими требованиями к сетевым политикам.

Варианты:

• "fc"
• "l2dom"
• "l3dom"
• "phys"
• "vmm"

dscp

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

string

Целевое значение Differentiated Service (DSCP).

Если при создании значение не задано, APIC использует unspecified.

Варианты:

• "AF11"
• "AF12"
• "AF13"
• "AF21"
• "AF22"
• "AF23"
• "AF31"
• "AF32"
• "AF33"
• "AF41"
• "AF42"
• "AF43"
• "CS0"
• "CS1"
• "CS2"
• "CS3"
• "CS4"
• "CS5"
• "CS6"
• "CS7"
• "EF"
• "VA"
• "unspecified"

enable_vm_folder

boolean

Включить получение данных о папках виртуальных машин

Варианты:

• false
• true

encap_mode

string

Протокол инкапсуляции уровня 2, используемый виртуальным коммутатором.

Варианты:

• "unknown"
• "vlan"
• "vxlan"

host

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

string

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

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

multicast_address

string

IP-адрес многоадресной рассылки, используемый виртуальным коммутатором.

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"

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_collection

boolean

Разрешает Cisco APIC собирать сведения о виртуальных машинах, которым назначены теги в VMware vCenter, для микросегментации.

Варианты:

• false
• true

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

vm_provider

string

Платформа виртуальных машин для доменов VMM.

Поддержка Kubernetes появилась в ACI v3.0.

Поддержка CloudFoundry, OpenShift и Red Hat появилась в ACI v3.1.

Варианты:

• "cloudfoundry"
• "kubernetes"
• "microsoft"
• "openshift"
• "openstack"
• "redhat"
• "vmware"
• "nutanix"

vswitch

string

Виртуальный коммутатор, используемый для доменов vmm.

Если при создании значение не задано, APIC использует default.

Варианты:

• "avs"
• "default"
• "dvs"
• "unknown"

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"