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。

概要

• 管理 Cisco ACI 结构上的 AAA 密钥环。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将改用环境变量 ACI_ANNOTATION 的值。 如果任务和环境变量 ACI_ANNOTATION 中均未指定此值，则将使用默认值。 默认值： "orchestrator:ansible"
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将改用环境变量 ACI_CERTIFICATE_NAME 的值。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改用环境变量 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 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
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 字符串	ACI 对象 ownerKey 属性的用户定义字符串。 此属性表示用于启用客户端拥有其数据以进行实体关联的密钥。 如果任务中未指定值，则将改用环境变量 ACI_OWNER_KEY 的值。
owner_tag 字符串	ACI 对象 ownerTag 属性的用户定义字符串。 此属性表示用于启用客户端添加其自身数据的标签。 例如，指示谁创建了此对象。 如果任务中未指定值，则将改用环境变量 ACI_OWNER_TAG 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将改用它。 如果任务中未指定值，则将改用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
password_change 字典	密码更改间隔 (aaa:PwdProfile)。
allowed_changes 整数	在更改间隔内允许的更改次数。 在创建期间未设置时，APIC 默认值为 2。
enable 布尔值	强制执行密码更改间隔。 使用 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 布尔值	启用密码强度检查。 使用 true 启用，使用 false 禁用。 在创建期间未设置时，APIC 默认值为 true。 选项 false true
password_strength_profile 字典	密码强度配置文件 (aaa:PwdStrengthProfile)。
class_flags 别名：flags 列表 / 元素=字符串	密码强度配置文件的类标志。 必须指定至少 3 个类标志。 此属性仅在 type 设置为 password_strength_profile.type=custom 时适用。 在创建期间未设置时，APIC 默认值为 digits,lowercase,uppercase。 选项 "digits" "lowercase" "specialchars" "uppercase"
enable 布尔值 / 必需	启用或禁用密码强度配置文件。 使用 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 别名：no_previous，ignore_previous 布尔值	如果为 true，则在向 APIC 发送 POST 更新之前，不会发送 GET 来检查先前状态。 如果任务中未指定值，则将改用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致先前的返回值为空。 不会检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false true
suppress_verification 别名：no_verification，no_verify，suppress_verify，ignore_verify，ignore_verification 布尔值	如果为 true，则在向 APIC 发送 POST 更新后，不会发送验证性 GET。 如果任务中未指定值，则将改用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议值。 包含默认值的当前对象在一个任务中将无法验证。 选项 false true
timeout 整数	套接字级别超时（以秒为单位）。 如果任务中未指定值，则将改用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
use_proxy 布尔值	如果为 false，则即使目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定值，则将改用环境变量 ACI_USE_PROXY 的值。 默认值为 true。 选项 false true
use_ssl 布尔值	如果为 false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定值，则将改用环境变量 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
web_token 字典	相关的 Web 令牌配置 (pki:WebTokenData)。
idle_timeout 别名：session_idle_timeout 整数	Web/控制台（SSH/Telnet）会话空闲超时（以秒为单位）。 在创建期间未设置时，APIC 默认值为 1200。
refresh 布尔值	在会话记录中包含刷新。 使用 true 包含，使用 false 排除。 在创建期间未设置时，APIC 默认为 false。 选项 false true
timeout 整数	Web 令牌超时（以秒为单位）。 在创建期间未设置时，APIC 默认值为 600。
validity_period 别名：maximum_validity_period 整数	最大有效期（以小时为单位）。 在创建期间未设置时，APIC 默认值为 24。

另请参阅

另请参阅

APIC 管理信息模型参考

有关内部 APIC 类 pki:Ep 的更多信息。

Cisco ACI 指南

使用 Ansible 管理 ACI 基础设施的详细信息。

开发 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 字符串	用于向 APIC 发出请求的 HTTP 方法 返回：失败或调试 示例： "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 字符串	APIC REST API 返回的原始输出（xml 或 json） 返回：解析错误 示例： "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
response 字符串	APIC 的 HTTP 响应 返回：失败或调试 示例： "OK (30 bytes)"
sent 列表 / 元素=字符串	实际/最小推送到 APIC 的配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "Production environment"}}}
status 整数	APIC 的 HTTP 状态 返回：失败或调试 示例： 200
url 字符串	用于向 APIC 发出请求的 HTTP url 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Akini Ross (@akinross)

集合链接

• 问题跟踪器
• 代码库（源代码）