Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_aaa_security_default_settings — управление связками ключей AAA (pki:Ep)

Примечание

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

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

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

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

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

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

  • Управление связками ключей AAA на фабриках Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

Строка, заданная пользователем для добавления аннотации к объекту.

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

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

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

certificate_name

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

string

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

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

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

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

host

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

string

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

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

lockout

dictionary

Поведение блокировки после нескольких неудачных попыток входа (aaa:BlockLoginProfile).

duration

integer

Продолжительность блокировки в минутах.

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

enable

boolean

Включить поведение блокировки.

Используйте true для включения и false для отключения.

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

Допустимые значения:

  • false
  • true

max_attempts

псевдонимы: max_failed_attempts, failed_attempts, attempts

integer

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

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

window

псевдонимы: max_failed_attempts_window, failed_attempts_window

integer

Период времени в минутах, в течение которого происходили последовательные неудачные попытки.

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

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.

password_change

dictionary

Интервал смены пароля (aaa:PwdProfile).

allowed_changes

integer

Количество смен пароля, разрешенных в течение интервала смены.

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

enable

boolean

Принудительно применять интервал смены пароля.

Используйте true для включения и false для отключения.

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

Допустимые значения:

  • false
  • true

history_storage_amount

псевдонимы: history, amount

integer

Количество последних паролей пользователя, которые следует хранить.

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

interval

integer

Интервал смены пароля в часах.

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

minimum_period

псевдонимы: minimum_period_between_password_changes, min_period

integer

Минимальный интервал между сменами пароля в часах.

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

password_strength_check

boolean

Включить проверку надежности пароля.

Используйте true для включения и false для отключения.

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

Допустимые значения:

  • false
  • true

password_strength_profile

dictionary

Профиль надежности пароля (aaa:PwdStrengthProfile).

class_flags

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

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

Флаги классов профиля надежности пароля.

Необходимо указать не менее 3 флагов классов.

Этот атрибут применяется только, если для параметра type задано значение password_strength_profile.type=custom.

При создании, если значение не задано, APIC использует digits,lowercase,uppercase.

Допустимые значения:

  • "digits"
  • "lowercase"
  • "specialchars"
  • "uppercase"

enable

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

Включить или отключить профиль надежности пароля.

Используйте true для включения и false для отключения.

Допустимые значения:

  • false
  • true

max_length

псевдонимы: maximum_length, max

integer

Максимальная длина пароля.

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

min_length

псевдонимы: minimum_length, min

integer

Минимальная длина пароля.

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

type

string

Тип профиля надежности пароля.

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

Допустимые значения:

  • "custom"
  • "any_three"

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 для вывода одного или нескольких объектов.

Допустимые значения:

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

suppress_previous

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

boolean

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

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

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

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

Предыдущее состояние объекта проверяться не будет, а 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

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

web_token

dictionary

Конфигурация, связанная с веб-токеном (pki:WebTokenData).

idle_timeout

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

integer

Тайм-аут бездействия веб-сеанса или сеанса консоли (SSH/Telnet) в секундах.

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

refresh

boolean

Добавлять refresh в записи сеансов.

Используйте 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

list / elements=string

Текущая конфигурация APIC после завершения работы модуля

Возвращается: при успешном выполнении

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Сведения об ошибке, возвращённые APIC

Возвращается: при ошибке

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная для запроса

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

Пример: "?rsp-prop-include=config-only"

method

string

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

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

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до начала работы модуля

Возвращается: при выводе информации

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Собранная конфигурация на основе параметров, предоставленных пользователем

Возвращается: при выводе информации

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

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

string

Ответ HTTP от APIC

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

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: при выводе информации

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP, возвращённый APIC

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

Пример: 200

url

string

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

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

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

Авторы

  • Akini Ross (@akinross)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_aaa_security_default_settings_module.html

Spec-Zone.ru

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