cisco.intersight.intersight_ntp_policy 模块 – 用于 Cisco Intersight 的 NTP 策略配置

注意

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

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

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

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

概要

  • 用于 Cisco Intersight 的 NTP 策略配置。

  • 用于在 Cisco Intersight 管理的设备上配置 NTP 服务器和时区设置。

  • 有关更多信息，请参阅 Cisco Intersight。

参数

参数

注释

api_key_id

字符串 / 必需

与私钥关联的公共 API 密钥 ID。

如果未设置，则使用 INTERSIGHT_API_KEY_ID 环境变量的值。

api_private_key

路径 / 必需

用于 Intersight API 身份验证的 PEM 格式私钥数据的文件名（绝对路径）或字符串。

如果使用字符串，则应使用 Ansible Vault 对字符串数据进行加密。

例如：ansible-vault encrypt_string --vault-id [email protected]/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

字符串

用户定义的 NTP 策略描述。

描述可以包含字母 (a-z, A-Z)、数字 (0-9)、连字符 (-)、句点 (.)、冒号 (:) 或下划线 (_)。

enable

布尔值

启用或禁用 NTP。

选择

  • false

  • true ←（默认）

name

字符串 / 必需

分配给 NTP 策略的名称。

名称必须介于 1 到 62 个字母数字字符之间，允许特殊字符 :-_。

ntp_servers

列表 / 元素=字符串

在端点上配置的 NTP 服务器列表。

organization

字符串

此资源分配到的组织的名称。

在自定义组织中创建的配置文件和策略仅适用于同一组织中的设备。

默认值： "default"

state

字符串

如果为 present，将验证资源是否存在，如果需要则会创建。

如果为 absent，将验证资源是否不存在，如果需要则会删除。

选择

  • "present" ←（默认）

  • "absent"

tags

列表 / 元素=字典

键：<用户定义的键> 值：<用户定义的值> 格式的标记列表。

timezone

字符串

端点上服务的时区。

use_proxy

布尔值

如果为 no，则即使目标主机上的环境变量中定义了代理，也不会使用代理。

选择

  • false

  • true ←（默认）

validate_certs

布尔值

用于验证 api_uri TLS 证书的布尔控制

选择

  • false

  • true ←（默认）

示例

- name: Configure NTP Policy
  cisco.intersight.intersight_ntp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-ntp
    description: NTP policy for lab use
    tags:
      - Key: Site
        Value: RCDN
    ntp_servers:
      - ntp.esl.cisco.com
    timezone: America/Chicago

- name: Delete NTP Policy
  cisco.intersight.intersight_ntp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-ntp
    state: absent

返回值

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

键

描述

api_repsonse

字典

指定资源返回的 API 响应输出。

返回值： 始终

示例： {"api_response": {"Name": "lab-ntp", "ObjectType": "ntp.Policy", "Tags": [{"Key": "Site", "Value": "RCDN"}]}}

作者

  • David Soper (@dsoper2)