Модуль cisco.aci.aci_fabric_management_access — управление доступом к управлению фабрикой (comm:Pol)

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.

description

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

string

Описание политики доступа к управлению фабрикой.

host

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

string

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

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

http

dictionary

Параметры конфигурации HTTP (comm:Http).

admin_state

string

Административное состояние HTTP-подключения.

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

Варианты:

• "enabled"
• "disabled"

allow_credentials

string

Состояние разрешения учетных данных для HTTP-подключения.

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

Варианты:

• "enabled"
• "disabled"

allow_origins

string

Разрешенные источники для HTTP-подключения.

Пример формата: http://127.0.0.1:8000

port

integer

Порт HTTP-подключения.

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

redirect

string

Состояние службы перенаправления HTTP на HTTPS.

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

Варианты:

• "enabled"
• "disabled"
• "tested"

throttle

string

Состояние ограничения частоты запросов для HTTP-подключения.

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

Варианты:

• "enabled"
• "disabled"

throttle_rate

integer

Частота ограничения запросов.

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

throttle_unit

string

Единица измерения частоты ограничения запросов.

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

Варианты:

• "requests_per_second"
• "requests_per_minute"

https

dictionary

Параметры конфигурации HTTPS (comm:Https).

admin_key_ring

string

Административный набор ключей для HTTPS-подключения.

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

admin_state

string

Административное состояние HTTPS-подключения.

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

Варианты:

• "enabled"
• "disabled"

allow_credentials

string

Состояние разрешения учетных данных для HTTPS-подключения.

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

Варианты:

• "enabled"
• "disabled"

allow_origins

string

Разрешенные источники для HTTPS-подключения.

Пример формата: http://127.0.0.1:8000

client_certificate_authentication_state

псевдонимы: client_certificate_auth_state, auth_state, authentication_state

string

Состояние аутентификации по сертификату клиента для HTTPS-подключения.

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

Для состояния enabled требуется указать client_certificate_trustpoint.

Варианты:

• "enabled"
• "disabled"

client_certificate_trustpoint

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

string

Точка доверия сертификата клиента для HTTPS-подключения.

dh_param

string

Параметр Диффи — Хеллмана для HTTPS-подключения.

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

Варианты:

• "1024"
• "2048"
• "4096"
• "none"

port

integer

Порт HTTPS-подключения.

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

ssl

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

list / элементы=string

Протоколы SSL для HTTPS-подключения.

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

Варианты:

• "tls_v1.0"
• "tls_v1.1"
• "tls_v1.2"
• "tls_v1.3"

throttle

string

Состояние ограничения частоты запросов для HTTPS-подключения.

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

Варианты:

• "enabled"
• "disabled"

throttle_rate

integer

Частота ограничения запросов.

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

throttle_unit

string

Единица измерения частоты ограничения запросов.

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

Варианты:

• "requests_per_second"
• "requests_per_minute"

name

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

string

Имя политики доступа к управлению фабрикой.

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.

ssh

dictionary

Параметры конфигурации SSH (comm:Ssh).

admin_state

string

Административное состояние SSH-подключения.

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

Варианты:

• "enabled"
• "disabled"

ciphers

list / elements=string

Шифры SSH-подключения.

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

Варианты:

• "aes128_ctr"
• "aes192_ctr"
• "aes256_ctr"
• "aes128_gcm"
• "aes256_gcm"
• "chacha20"

kex

list / elements=string

Алгоритмы обмена ключами (KEX) для SSH-подключения.

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

Варианты:

• "dh_sha1"
• "dh_sha256"
• "dh_sha512"
• "curve_sha256"
• "curve_sha256_libssh"
• "ecdh_256"
• "ecdh_384"
• "ecdh_521"

macs

list / elements=string

Алгоритмы MAC для SSH-подключения.

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

Варианты:

• "sha1"
• "sha2_256"
• "sha2_512"
• "sha2_256_etm"
• "sha2_512_etm"

password_auth_state

string

Состояние аутентификации по паролю для SSH-подключения.

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

Варианты:

• "enabled"
• "disabled"

port

integer

Порт SSH-подключения.

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

ssh_web

dictionary

Параметры доступа по SSH через конфигурацию WEB (comm:Shellinabox).

admin_state

string

Административное состояние SSH-подключения через WEB.

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

Варианты:

• "enabled"
• "disabled"

state

string

Используйте present для обновления конфигурации.

Используйте query для просмотра текущей конфигурации.

Варианты:

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

suppress_previous

псевдонимы: no_previous, ignore_previous

логическое значение

Если true, перед POST-запросом на обновление к APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

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

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

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение previous будет пустым.

Предыдущее состояние объекта не будет проверено, а POST-запрос на обновление будет содержать все свойства.

Варианты:

• false
• true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

логическое значение

Если true, после POST-запроса на обновление к APIC не будет отправлен проверочный GET-запрос.

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

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

ПРЕДУПРЕЖДЕНИЕ — в результате для возвращаемого значения current будет задано предложенное значение.

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

Варианты:

• false
• true

telnet

словарь

Параметры конфигурации telnet (comm:Telnet).

admin_state

строка

Административное состояние telnet-подключения.

При создании APIC присваивает значение disabled, если параметр не задан.

Варианты:

• "enabled"
• "disabled"

port

целое число

Порт для telnet-подключения.

При создании APIC присваивает значение 23, если параметр не задан.

timeout

целое число

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

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

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

use_proxy

логическое значение

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

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

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

Варианты:

• false
• true

use_ssl

логическое значение

Если false, вместо HTTPS-подключения по умолчанию будет использоваться HTTP-подключение.

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

При локальном подключении значение по умолчанию — true.

Варианты:

• false
• true

username

псевдоним: user

строка

Имя пользователя для аутентификации.

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

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

validate_certs

логическое значение

Если false, SSL-сертификаты проверяться не будут.

Задавайте значение false, только если используете собственные сайты с самоподписанными сертификатами.

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

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

Варианты:

• false
• true

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

строка

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

строка

URL HTTP, использованный для запроса к APIC

Возвращается: при сбое или в режиме отладки

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"