Модуль cisco.aci.aci_aaa_security_default_settings — Управление кольцами AAA (pki:Ep)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_aaa_security_default_settings.

Краткое описание
Параметры
См. также
Примеры
Возвращаемые значения

Краткое описание

Управление кольцами AAA на Cisco ACI.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено имя файла `private_key`, оно по умолчанию устанавливается в имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, значение по умолчанию устанавливается в `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешимые хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`.
lockout словарь	Поведение блокировки после нескольких неудачных попыток входа (aaa:BlockLoginProfile).
duration целое число	Продолжительность блокировки в минутах. APIC по умолчанию устанавливает `60`, если значение не указано при создании.
enable булево	Включить поведение блокировки. Используйте `true`, чтобы включить и `false`, чтобы отключить. APIC по умолчанию устанавливает `false`, если значение не указано при создании. Выборы: `false` `true`
max_attempts псевдонимы: max_failed_attempts, failed_attempts, attempts целое число	Максимальное количество неудачных попыток перед блокировкой пользователя. APIC по умолчанию устанавливает `5`, если значение не указано при создании.
window псевдонимы: max_failed_attempts_window, failed_attempts_window целое число	Период времени в минутах, в течение которого последовательно происходили неудачные попытки. APIC по умолчанию устанавливает `5`, если значение не указано при создании.
name_alias строка	Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.
output_level строка	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Выборы: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
owner_key строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ для предоставления клиентам возможности владеть своими данными для корреляции сущностей. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OWNER_KEY`.
owner_tag строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег для предоставления клиентам возможности добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OWNER_TAG`.
password строка	Пароль для аутентификации. Этот параметр взаимно исключает `private_key`. Если также предоставлен `private_key`, он будет использован вместо него. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
password_change словарь	Интервал смены пароля (aaa:PwdProfile).
allowed_changes целое число	Количество разрешенных изменений в течение интервала смены. APIC по умолчанию устанавливает `2`, если значение не указано при создании.

END_OF_DOCUMENT_MARKER

enable boolean	Принудительно устанавливать интервал смены пароля. Используйте `true` для включения и `false` для выключения. APIC по умолчанию устанавливает `true` при отсутствии указания при создании. Варианты: `false` `true`
history_storage_amount псевдонимы: history, amount целое число	Количество хранящихся последних паролей пользователя. APIC по умолчанию устанавливает `5` при отсутствии указания при создании.
interval целое число	Интервал смены пароля в часах. APIC по умолчанию устанавливает `48` при отсутствии указания при создании.
minimum_period псевдонимы: minimum_period_between_password_changes, min_period целое число	Минимальный период между сменами паролей в часах. APIC по умолчанию устанавливает `24` при отсутствии указания при создании.
password_strength_check boolean	Включить проверку сложности пароля. Используйте `true` для включения и `false` для выключения. APIC по умолчанию устанавливает `true` при отсутствии указания при создании. Варианты: `false` `true`
password_strength_profile словарь	Профиль сложности пароля (aaa:PwdStrengthProfile).
class_flags псевдонимы: flags список / элементы=строка	Флаги класса профиля сложности пароля. Необходимо указать как минимум 3 флага класса. Этот атрибут применим только когда тип установлен на `password_strength_profile.type=custom`. APIC по умолчанию устанавливает `digits,lowercase,uppercase` при отсутствии указания при создании. Варианты: `"digits"` `"lowercase"` `"specialchars"` `"uppercase"`
enable boolean / обязательно	Включить или выключить профиль сложности пароля. Используйте `true` для включения и `false` для выключения. Варианты: `false` `true`
max_length псевдонимы: maximum_length, max целое число	Максимальная длина пароля. APIC по умолчанию устанавливает `64` при отсутствии указания при создании.
min_length псевдонимы: minimum_length, min целое число	Минимальная длина пароля. APIC по умолчанию устанавливает `8` при отсутствии указания при создании.
type строка	Тип профиля сложности пароля. APIC по умолчанию устанавливает `any_three` при отсутствии указания при создании. Варианты: `"custom"` `"any_three"`
port целое число	Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной окружения `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`. Этот параметр взаимоисключающий с `password`. Если `password` также указано, оно будет проигнорировано. Если значение не указано в задаче, используется значение переменной окружения `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Варианты: `"present"` ← (по умолчанию) `"query"`

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`
timeout integer	Таймаут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию: 30.
use_proxy boolean	Если `false`, прокси использоваться не будет, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию: true. Варианты: `false` `true`
use_ssl boolean	Если `false`, будет использоваться HTTP-соединение вместо соединения HTTPS по умолчанию. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию: true, когда соединение локальное. Варианты: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию: admin.
validate_certs boolean	Если `false`, SSL-сертификаты проверяться не будут. Это следует устанавливать в `false` только при использовании на лично контролируемых сайтах с самозаверяющими сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию: true. Варианты: `false` `true`
web_token dictionary	Конфигурация, связанная с веб-токеном (pki:WebTokenData).
idle_timeout aliases: session_idle_timeout integer	Таймаут бездействия сессии веб/консоли (SSH/Telnet) в секундах. APIC использует значение по умолчанию `1200` при отсутствии значения во время создания.
refresh boolean	Включать обновление в записи сессии. Использовать `true` для включения и `false` для отключения. APIC использует значение по умолчанию `false` при отсутствии значения во время создания. Варианты: `false` `true`
timeout integer	Таймаут веб-токена в секундах. APIC использует значение по умолчанию `600` при отсутствии значения во время создания.
validity_period aliases: maximum_validity_period integer	Максимальный срок действия в часах. APIC использует значение по умолчанию `24` при отсутствии значения во время создания.

См. также

Справочник по модели информации управления APIC: Дополнительная информация о внутреннем классе APIC pki:Ep.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Set AAA Security Default Settings
  cisco.aci.aci_aaa_security_default_settings:
    host: apic
    username: admin
    password: SomeSecretPassword
    password_strength_check: true
    password_strength_profile:
      enable: true
      type: custom
      min_length: 10
      max_length: 60
      class_flags:
        - digits
        - lowercase
        - specialchars
        - uppercase
    password_change:
      enable: true
      interval: 49
      allowed_changes: 6
      minimum_period_between_password_changes: 25
      history_storage_amount: 6
    lockout:
      enable: true
      max_attempts: 6
      window: 6
      duration: 61
    web_token:
      timeout: 601
      idle_timeout: 1201
      validity_period: 23
      refresh: true
    state: present
  delegate_to: localhost

- name: Set AAA Security Default Settings to Default Values
  cisco.aci.aci_aaa_security_default_settings:
    host: apic
    username: admin
    password: SomeSecretPassword
    password_strength_check: true
    password_strength_profile:
      enable: false
    password_change:
      enable: true
      interval: 48
      allowed_changes: 2
      minimum_period_between_password_changes: 24
      history_storage_amount: 5
    lockout:
      enable: false
      max_attempts: 5
      window: 5
      duration: 60
    web_token:
      timeout: 600
      idle_timeout: 1200
      validity_period: 24
      refresh: false
    state: present
  delegate_to: localhost

- name: Query AAA Security Default Settings
  cisco.aci.aci_aaa_security_default_settings:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
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"`

Авторы

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_aaa_security_default_settings_module.html