dellemc.enterprise_sonic.sonic_login_lockout 模块 – 管理 SONiC 上的全局登录锁定配置

注意

此模块是 dellemc.enterprise_sonic 集合(版本 2.5.1)的一部分。

如果您正在使用 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install dellemc.enterprise_sonic

要在 playbook 中使用它,请指定:dellemc.enterprise_sonic.sonic_login_lockout

dellemc.enterprise_sonic 2.5.0 中的新功能

概要

  • 此模块提供登录锁定参数的配置管理。

  • 登录锁定功能是在最大重试失败次数后,将用户帐户锁定 user-lockout-period。可以启用控制台豁免选项,以跳过控制台用户的登录锁定验证。

参数

参数

注释

config

字典

登录锁定属性配置的集合

console_exempt

布尔值

从帐户锁定中豁免控制台登录。

选择

  • false

  • true

max_retries

整数

最大密码重试次数。

范围为 0 到 16

period

整数

帐户锁定时间(以分钟为单位)

范围为 0 到 43200

state

字符串

指定要在设备上配置的登录属性上执行的操作。

如果状态为“merged”,则将指定的属性与现有的已配置登录属性合并。

对于“deleted”,则从现有配置中删除指定的登录属性。

对于“overridden”,则使用提供的配置覆盖设备上的所有登录锁定配置。

对于“replaced”,则使用提供的配置替换设备上的登录锁定配置。

选择

  • "merged" ←(默认)

  • "deleted"

  • "overridden"

  • "replaced"

示例

# Using deleted
#
# Before State:
# -------------
#
# sonic# show running-configuration | grep lockout
# !
# login lockout period 12
# login lockout max-retries 5
# login lockout console-exempt
# !

  - name: Delete Login Lockout configurations
    dellemc.enterprise_sonic.sonic_login_lockout:
      config:
        period: 12
        max_retries : 5
      state: deleted

# After State:
# ------------
# sonic# show running-configuration | grep lockout
# !
# login lockout console-exempt
# !
# sonic#


# Using merged
#
# Before State:
# -------------
#
# sonic# show running-configuration | grep lockout
# sonic#

  - name: Modify Login Lockout configurations
    dellemc.enterprise_sonic.sonic_login_lockout:
      config:
        console_exempt: true
        period: 12
        max_retries : 5
      state: merged

# After State:
# ------------
# sonic# show running-configuration | grep lockout
# !
# login lockout period 12
# login lockout max-retries 5
# login lockout console-exempt
# !

# Using overridden
#
# Before State:
# -------------
#
# sonic# show running-configuration | grep lockout
# !
# login lockout period 10
# login lockout max-retries 2
# !
# sonic#

  - name: Override Login Lockout configurations
    dellemc.enterprise_sonic.sonic_login_lockout:
      config:
        console_exempt: true
        period: 11
        max_retries : 3
      state: overridden

# After State:
# ------------
# sonic# show running-configuration | grep lockout
# !
# login lockout period 11
# login lockout max-retries 3
# login lockout console-exempt
# !

# Using replaced
#
# Before State:
# -------------
#
# sonic# show running-configuration | grep lockout
# !
# login lockout period 10
# login lockout max-retries 2
# !
# sonic#

  - name: Replace Login Lockout configurations
    dellemc.enterprise_sonic.sonic_login_lockout:
      config:
        period: 15
      state: replaced

# After State:
# ------------
# sonic# show running-configuration | grep lockout
# !
# login lockout period 15
# !

返回值

常见的返回值记录在这里,以下是此模块特有的字段

描述

after

字典

生成的配置模块调用。

返回:当更改时

示例: "返回的 配置将始终与上面的参数格式相同。\n"

before

字典

模块调用之前的配置。

返回:始终

示例: "返回的 配置将始终与上面的参数格式相同。\n"

commands

列表 / 元素=字符串

推送到远程设备的命令集。

返回:始终

示例: ["命令 1", "命令 2", "命令 3"]

作者

  • Arul Kumar Shankara Narayanan(@arulkumar9690)