cisco.meraki.organizations_login_security 模块 – 用于组织 _loginsecurity 的资源模块
注意
此模块是 cisco.meraki 集合(版本 2.18.3)的一部分。
如果您正在使用 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.meraki
。您需要进一步的要求才能使用此模块,请参阅 要求 获取详细信息。
要在 playbook 中使用它,请指定:cisco.meraki.organizations_login_security
。
cisco.meraki 2.16.0 中的新功能
概要
管理资源组织 _loginsecurity 的操作更新。
更新组织的登录安全设置。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
用户帐户被锁定之前连续失败的登录尝试次数。 |
|
用于指示组织是否将对 API(而不是仪表板)的访问限制为特定 IP 地址的详细信息。 |
|
仅限 API 的 IP 限制的详细信息。 |
|
布尔值,指示组织是否将 API 密钥(而不是仪表板 GUI)的使用限制为特定的 IP 地址或 CIDR 范围列表。 选择
|
|
可接受的 IP 范围列表。条目可以是单个 IP 地址、IP 地址范围和 CIDR 子网。 |
|
布尔值,指示用户的仪表板帐户在指定的连续登录尝试失败次数后是否会被锁定。 选择
|
|
布尔值,指示用户在设置新密码时,是否会被强制选择与任何过去的密码都不同的新密码。 选择
|
|
布尔值,指示用户在空闲指定分钟数后是否会被注销。 选择
|
|
布尔值,指示组织是否将限制从某些 IP 地址访问仪表板(包括 API)。 选择
|
|
布尔值,指示是否强制用户每 X 天更改一次密码。 选择
|
|
布尔值,指示是否强制用户为其帐户选择强密码。强密码是至少包含以下数字、大写字母、小写字母和符号中的 3 个字符的 8 个字符。 选择
|
|
布尔值,指示此组织中的用户在登录仪表板时是否需要使用额外的验证码。此代码将通过 SMS 发送到他们的手机,或者可以由身份验证器应用程序生成。 选择
|
|
用户在帐户注销之前可以保持空闲的分钟数。 |
|
可接受的 IP 范围列表。条目可以是单个 IP 地址、IP 地址范围和 CIDR 子网。 |
|
meraki_action_batch_retry_wait_time (整数),操作批处理并发错误重试等待时间 默认值: |
|
meraki_api_key (字符串),在仪表板中生成的 API 密钥;也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (字符串),所有端点资源的前缀 默认值: |
|
meraki_be_geo_id (字符串),用于 API 使用跟踪的可选合作伙伴标识符;也可以设置为环境变量 BE_GEO_ID 默认值: |
|
meraki_caller (字符串),用于 API 使用跟踪的可选标识符;也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值: |
|
meraki_certificate_path (字符串),如果位于本地代理后面,则用于 TLS/SSL 证书验证的路径 默认值: |
|
meraki_inherit_logging_config (布尔值),继承您自己的日志记录器实例 选择
|
|
meraki_log_file_prefix (字符串),附加了日期和时间戳的日志文件名 默认值: |
|
log_path (字符串),输出日志的路径;默认情况下,如果未指定,则为脚本的工作目录 默认值: |
|
meraki_maximum_retries (整数),遇到 429 或其他服务器端错误时最多重试此次数 默认值: |
|
meraki_nginx_429_retry_wait_time (整数),Nginx 429 重试等待时间 默认值: |
|
meraki_output_log (布尔值),创建输出日志文件? 选择
|
|
meraki_print_console (布尔值),将日志输出打印到控制台? 选择
|
|
meraki_requests_proxy (字符串),如果需要,用于 HTTPS 的代理服务器和端口 默认值: |
|
meraki_retry_4xx_error (布尔值),如果遇到其他 4XX 错误(除了 429)是否重试? 选择
|
|
meraki_retry_4xx_error_wait_time (整数),其他 4XX 错误重试等待时间 默认值: |
|
meraki_simulate (布尔值),模拟 POST/PUT/DELETE 调用以防止更改? 选择
|
|
meraki_single_request_timeout (整数),每次 API 调用的最大秒数 默认值: |
|
meraki_suppress_logging (布尔值),禁用所有日志记录?那你只能靠自己了! 选择
|
|
meraki_use_iterator_for_get_pages (布尔值),list* 方法将返回一个迭代器,其中包含每个对象,而不是包含所有项的完整列表 选择
|
|
meraki_wait_on_rate_limit (布尔值),如果遇到 429 速率限制错误,是否重试? 选择
|
|
新密码必须与最近多少个密码不同。 |
|
OrganizationId 路径参数。组织 ID。 |
|
用户将被强制更改密码的天数。 |
注释
注意
使用的 SDK 方法是 organizations.Organizations.update_organization_login_security,
使用的路径是 put /organizations/{organizationId}/loginSecurity,
不支持
check_mode
该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中嵌入的连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 关于 organizations updateOrganizationLoginSecurity 的文档
updateOrganizationLoginSecurity API 的完整参考。
示例
- name: Update all
cisco.meraki.organizations_login_security:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
accountLockoutAttempts: 3
apiAuthentication:
ipRestrictionsForKeys:
enabled: true
ranges:
- 192.195.83.1
- 192.168.33.33
enforceAccountLockout: true
enforceDifferentPasswords: true
enforceIdleTimeout: true
enforceLoginIpRanges: true
enforcePasswordExpiration: true
enforceStrongPasswords: true
enforceTwoFactorAuth: true
idleTimeoutMinutes: 30
loginIpRanges:
- 192.195.83.1
- 192.195.83.255
numDifferentPasswords: 3
organizationId: string
passwordExpirationDays: 90
返回值
常用返回值在此处记录 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
包含 Cisco Meraki Python SDK 返回的响应的字典或列表 返回: 始终 示例: |