cisco.intersight.intersight_local_user_policy 模块 – Cisco Intersight 的本地用户策略配置

注意

此模块是 cisco.intersight 集合 (版本 2.0.20) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.intersight。

要在 playbook 中使用它，请指定： cisco.intersight.intersight_local_user_policy。

概要

• Cisco Intersight 的本地用户策略配置。

• 用于配置终端设备上的本地用户。

• 更多信息请参见 Cisco Intersight。

参数

参数	注释
always_update_password 布尔值	由于密码不会被 API 返回，并且在终端上被加密，因此此选项将指示模块何时更改密码。 如果为 true，则将始终更新策略中每个用户的密码。 如果为 false，则只有在创建用户时才会更新密码。 选项 false ← (默认) true
api_key_id 字符串 / 必需	与私钥关联的公共 API 密钥 ID。 如果未设置，则使用 INTERSIGHT_API_KEY_ID 环境变量的值。
api_private_key 路径 / 必需	用于 Intersight API 身份验证的 PEM 格式私钥数据的文件名（绝对路径）或字符串。 如果使用字符串，则应使用 Ansible vault 加密字符串数据。 例如：ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—– <您的私钥数据> —–END EC PRIVATE KEY—–’ 如果未设置，则使用 INTERSIGHT_API_PRIVATE_KEY 环境变量的值。
api_uri 字符串	用于访问 Intersight API 的 URI。 如果未设置，则使用 INTERSIGHT_API_URI 环境变量的值。 默认值： "https://intersight.com/api/v1"
description 别名：descr 字符串	本地用户策略的用户定义描述。 描述可以包含字母（az、AZ）、数字（0-9）、连字符（-）、句点（.）、冒号（:）或下划线（_）。
enable_password_expiry 布尔值	启用终端上的密码过期。 选项 false ← (默认) true
enforce_strong_password 布尔值	如果为 true，则启用强密码策略。 强密码要求： 密码必须至少包含 8 个字符，最多包含 20 个字符。 密码不能包含用户名。 密码必须包含以下四个类别中的三个类别的字符。 英文大写字母 (A 到 Z)。 英文小写字母 (a 到 z)。 基数 10 数字 (0 到 9)。 非字母字符 (! , @, ‘#’, $, %, ^, &, *, -, _, +, =)。 选项 false true ← (默认)
local_users 列表 / 元素=字典	终端上的本地用户列表。 终端上已存在 admin 用户。 仅当您想更改密码或启用或禁用用户时，才在此处添加 admin 用户。 要添加 admin 用户，请提供用户名“admin”，选择 admin 用户角色，然后继续。
enable 布尔值	启用或禁用用户。 选项 false true ← (默认)
password 字符串 / 必需	用户的有效登录密码。
role 字符串 / 必需	与终端上用户关联的角色。 选项 "admin" "readonly" "user"
username 字符串 / 必需	在终端上创建的用户名。
name 字符串 / 必需	分配给本地用户策略的名称。 名称必须在 1 到 62 个字母数字字符之间，允许使用特殊字符 :-_。
organization 字符串	此资源分配到的组织的名称。 在自定义组织内创建的配置文件和策略仅适用于同一组织中的设备。 默认值： "default"
password_history 整数	指定更改密码时密码不能重复的次数（值介于 0 和 5 之间）。 输入 0 将禁用此选项。 默认值： 5
purge 布尔值	purge 参数指示模块将资源定义视为绝对的。 如果为 true，则将从策略中删除以前配置的用户名，但不能删除 `admin` 用户。 选项 false ← (默认) true
state 字符串	如果为 present，将验证资源是否存在，如果需要则创建。 如果为 absent，将验证资源是否不存在，如果需要则删除。 选项 "present" ← (默认) "absent"
tags 列表 / 元素=字典	键值对格式的标签列表，格式为：键:<用户自定义键> 值:<用户自定义值>。
use_proxy 布尔值	如果为 no，即使在目标主机上的环境变量中定义了代理，也不会使用代理。 选项 false true ← (默认)
validate_certs 布尔值	用于验证 api_uri TLS 证书的布尔值控制。 选项 false true ← (默认)

示例

- name: Configure Local User policy
  intersight_local_user_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: guest-admin
    tags:
      - Key: username
        Value: guest
    description: User named guest with admin role
    local_users:
      - username: guest
        role: admin
        password: vault_guest_password
      - username: reader
        role: readonly
        password: vault_reader_password

- name: Delete Local User policy
  intersight_local_user_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: guest-admin
    state: absent

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段。

键	描述
api_repsonse 字典	指定资源返回的 API 响应输出。 返回： 始终 示例： {"api_response": {"Description": "User named guest with admin role", "EndPointUserRoles": [{"ChangePassword": true, "Enabled": true}]}}

作者

• David Soper (@dsoper2)

资源链接

• 问题跟踪器
• 代码仓库