cisco.nxos.nxos_ntp_global 模块 – NTP 全局资源模块。

注意

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

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

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

要在 playbook 中使用它，请指定： cisco.nxos.nxos_ntp_global。

cisco.nxos 2.6.0 中的新增功能

概要

  • 此模块管理运行 Cisco NX-OS 的设备上的 NTP 配置。

参数

参数

注释

config

字典

NTP 配置的字典。

access_group

字典

NTP 访问组。

MDS 交换机不支持此选项。

match_all

布尔值

扫描所有 ntp 访问组中存在的 ACL。

选择

  • false

  • true

peer

列表 / 元素=字典

访问组对等方。

access_list

字符串

访问列表的名称。

query_only

列表 / 元素=字典

访问组仅查询。

access_list

字符串

访问列表的名称。

serve

列表 / 元素=字典

访问组服务。

access_list

字符串

访问列表的名称。

serve_only

列表 / 元素=字典

访问组仅服务。

access_list

字符串

访问列表的名称。

allow

字典

启用/禁用数据包。

control

字典

控制模式数据包。

rate_limit

整数

速率限制延迟。

private

布尔值

启用/禁用私有模式数据包。

选择

  • false

  • true

authenticate

布尔值

启用/禁用身份验证。

选择

  • false

  • true

authentication_keys

列表 / 元素=字典

NTP 身份验证密钥。

encryption

整数

0 表示明文

7 表示加密

id

整数

身份验证密钥号（范围 1-65535）。

key

字符串

身份验证密钥。

logging

布尔值

启用/禁用 NTPD 事件日志记录。

选择

  • false

  • true

master

字典

充当 NTP 主时钟。

MDS 交换机不支持此选项。

stratum

整数

层号。

passive

布尔值

NTP 被动命令。

MDS 交换机不支持此选项。

选择

  • false

  • true

peers

列表 / 元素=字典

NTP 对等方。

key_id

整数

与此服务器通信时要使用的密钥 ID。

maxpoll

整数

轮询对等方的最大间隔。

轮询间隔（以秒为单位，为 2 的幂）。

minpoll

整数

轮询对等方的最小间隔。

轮询间隔（以秒为单位，为 2 的幂）。

peer

字符串

NTP 对等方的主机名/IP 地址。

prefer

布尔值

首选服务器。

选择

  • false

  • true

vrf

别名：use_vrf

字符串

显示每个 VRF 的信息。

MDS 交换机不支持此选项。

servers

列表 / 元素=字典

NTP 服务器。

key_id

整数

与此服务器通信时要使用的密钥 ID。

maxpoll

整数

轮询对等方的最大间隔。

轮询间隔（以秒为单位，为 2 的幂）。

minpoll

整数

轮询对等方的最小间隔。

轮询间隔（以秒为单位，为 2 的幂）。

prefer

布尔值

首选服务器。

选择

  • false

  • true

server

字符串

NTP 对等方的主机名/IP 地址。

vrf

别名：use_vrf

字符串

显示每个 VRF 的信息。

此选项不适用于 MDS 交换机。

source

字符串

NTP 数据包的来源。

MDS 交换机不支持此选项。

source_interface

字符串

发送 NTP 数据包的源接口。

trusted_keys

列表 / 元素=字典

NTP 信任密钥号。

key_id

整数

信任密钥号。

running_config

字符串

此选项仅与状态 parsed 一起使用。

此选项的值应是通过执行命令 **show running-config ntp** 从 NX-OS 设备收到的输出。

状态 parsed 从 running_config 选项读取配置，并根据资源模块的 argspec 将其转换为 Ansible 结构化数据，然后该值将返回到结果中的 parsed 键中。

state

字符串

配置应保留的状态。

状态 replaced 和 overridden 对于此模块具有相同的行为。

请参阅示例以了解更多详细信息。

选择

  • "merged" ← (默认)

  • "replaced"

  • "overridden"

  • "deleted"

  • "parsed"

  • "gathered"

  • "rendered"

说明

注意

  • 已在 Cisco Nexus 交换机上针对 NX-OS 9.3.6 进行了测试。

  • 此模块适用于连接 network_cli 和 httpapi。

  • 已针对连接 network_cli 的 Cisco MDS NX-OS 9.2(2) 进行了测试。

示例

# Using merged

# Before state:
# -------------
# nxos-9k-rdo# show running-config ntp
# nxos-9k-rdo#

- name: Merge the provided configuration with the existing running configuration
  cisco.nxos.nxos_ntp_global: &id001
    config:
      access_group:
        peer:
          - access_list: PeerAcl1
        serve:
          - access_list: ServeAcl1
      authenticate: true
      authentication_keys:
        - id: 1001
          key: vagwwtKfkv
          encryption: 7
        - id: 1002
          key: vagwwtKfkvgthz
          encryption: 7
      logging: true
      master:
        stratum: 2
      peers:
        - peer: 192.0.2.1
          key_id: 1
          maxpoll: 15
          minpoll: 5
          vrf: default
        - peer: 192.0.2.2
          key_id: 2
          prefer: true
          vrf: siteA
      servers:
        - server: 198.51.100.1
          key_id: 2
          vrf: default
        - server: 203.0.113.1
          key_id: 1
          vrf: siteB

# Task output
# -------------
#  before: {}
#
#  commands:
#    - "ntp authenticate"
#    - "ntp logging"
#    - "ntp master 2"
#    - "ntp authentication-keys 1001 md5 vagwwtKfkv 7"
#    - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7"
#    - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15"
#    - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2"
#    - "ntp server 198.51.100.1 use-vrf default key 2"
#    - "ntp server 203.0.113.1 use-vrf siteB key 1"
#    - "ntp access-group peer PeerAcl1"
#    - "ntp access-group serve ServeAcl1"
#
#  after:
#    access_group:
#      peer:
#        - access_list: PeerAcl1
#      serve:
#       - access_list: ServeAcl1
#    authenticate: true
#    authentication_keys:
#      - id: 1001
#        key: vagwwtKfkv
#        encryption: 7
#      - id: 1002
#        key: vagwwtKfkvgthz
#        encryption: 7
#    logging: true
#    master:
#     stratum: 2
#    peers:
#      - peer: 192.0.2.1
#        key_id: 1
#        maxpoll: 15
#        minpoll: 5
#        vrf: default
#      - peer: 192.0.2.2
#        key_id: 2
#        prefer: true
#        vrf: siteA
#    servers:
#      - server: 198.51.100.1
#        key_id: 2
#        vrf: default
#      - server: 203.0.113.1
#        key_id: 1
#        vrf: siteB

# After state:
# ------------
# nxos-9k-rdo# show running-config ntp
# ntp authenticate
# ntp logging
# ntp master 2
# ntp authentication-keys 1001 md5 vagwwtKfkv 7
# ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7
# ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15
# ntp peer 192.0.2.2 prefer use-vrf siteA key 2
# ntp server 198.51.100.1 use-vrf default key 2
# ntp server 203.0.113.1 use-vrf siteB key 1
# ntp access-group peer PeerAcl1
# ntp access-group serve ServeAcl1

# Using replaced

# Before state:
# ------------
# nxos-9k-rdo# show running-config ntp
# ntp authenticate
# ntp logging
# ntp master 2
# ntp authentication-keys 1001 md5 vagwwtKfkv 7
# ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7
# ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15
# ntp peer 192.0.2.2 prefer use-vrf siteA key 2
# ntp server 198.51.100.1 use-vrf default key 2
# ntp server 203.0.113.1 use-vrf siteB key 1
# ntp access-group peer PeerAcl1
# ntp access-group serve ServeAcl1

- name: Replace logging global configurations of listed logging global with provided configurations
  cisco.nxos.nxos_ntp_global:
    config:
      access_group:
        peer:
          - access_list: PeerAcl2
        serve:
          - access_list: ServeAcl2
      logging: true
      master:
        stratum: 2
      peers:
        - peer: 192.0.2.1
          key_id: 1
          maxpoll: 15
          minpoll: 5
          vrf: default
        - peer: 192.0.2.5
          key_id: 2
          prefer: true
          vrf: siteA
      servers:
        - server: 198.51.100.1
          key_id: 2
          vrf: default
    state: replaced

# Task output
# -------------
#  before:
#    access_group:
#      peer:
#        - access_list: PeerAcl1
#      serve:
#       - access_list: ServeAcl1
#    authenticate: true
#    authentication_keys:
#      - id: 1001
#        key: vagwwtKfkv
#        encryption: 7
#      - id: 1002
#        key: vagwwtKfkvgthz
#        encryption: 7
#    logging: true
#    master:
#     stratum: 2
#    peers:
#      - peer: 192.0.2.1
#        key_id: 1
#        maxpoll: 15
#        minpoll: 5
#        vrf: default
#      - peer: 192.0.2.2
#        key_id: 2
#        prefer: true
#        vrf: siteA
#    servers:
#      - server: 198.51.100.1
#        key_id: 2
#        vrf: default
#      - server: 203.0.113.1
#        key_id: 1
#        vrf: siteB
#
#  commands:
#    - "no ntp authenticate"
#    - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7"
#    - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7"
#    - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2"
#    - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2"
#    - "no ntp server 203.0.113.1 use-vrf siteB key 1"
#    - "ntp access-group peer PeerAcl2"
#    - "no ntp access-group peer PeerAcl1"
#    - "ntp access-group serve ServeAcl2"
#    - "no ntp access-group serve ServeAcl1"
#
#  after:
#    access_group:
#      peer:
#        - access_list: PeerAcl2
#      serve:
#        - access_list: ServeAcl2
#    logging: true
#    master:
#      stratum: 2
#    peers:
#      - peer: 192.0.2.1
#        key_id: 1
#        maxpoll: 15
#        minpoll: 5
#        vrf: default
#      - peer: 192.0.2.5
#        key_id: 2
#        prefer: true
#        vrf: siteA
#    servers:
#      - server: 198.51.100.1
#        key_id: 2
#        vrf: default

# After state:
# ------------
# nxos-9k-rdo# show running-config ntp
# ntp logging
# ntp master 2
# ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15
# ntp peer 192.0.2.5 prefer use-vrf siteA key 2
# ntp server 198.51.100.1 use-vrf default key 2
# ntp access-group peer PeerAcl2
# ntp access-group serve ServeAcl2

# Using deleted to delete all logging configurations

# Before state:
# ------------
# nxos-9k-rdo# show running-config ntp

- name: Delete all logging configuration
  cisco.nxos.nxos_ntp_global:
    state: deleted

# Task output
# -------------
#  before:
#    access_group:
#      peer:
#        - access_list: PeerAcl1
#      serve:
#       - access_list: ServeAcl1
#    authenticate: true
#    authentication_keys:
#      - id: 1001
#        key: vagwwtKfkv
#        encryption: 7
#      - id: 1002
#        key: vagwwtKfkvgthz
#        encryption: 7
#    logging: true
#    master:
#     stratum: 2
#    peers:
#      - peer: 192.0.2.1
#        key_id: 1
#        maxpoll: 15
#        minpoll: 5
#        vrf: default
#      - peer: 192.0.2.2
#        key_id: 2
#        prefer: true
#        vrf: siteA
#    servers:
#      - server: 198.51.100.1
#        key_id: 2
#        vrf: default
#      - server: 203.0.113.1
#        key_id: 1
#        vrf: siteB
#
#  commands:
#    - "no ntp authenticate"
#    - "no ntp logging"
#    - "no ntp master 2"
#    - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7"
#    - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7"
#    - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15"
#    - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2"
#    - "no ntp server 198.51.100.1 use-vrf default key 2"
#    - "no ntp server 203.0.113.1 use-vrf siteB key 1"
#    - "no ntp access-group peer PeerAcl1"
#    - "no ntp access-group serve ServeAcl1"
#
#  after: {}

# After state:
# ------------
# nxos-9k-rdo# show running-config ntp
# nxos-9k-rdo#

# Using rendered

- name: Render platform specific configuration lines with state rendered (without connecting to the device)
  cisco.nxos.nxos_ntp_global:
    config:
      access_group:
        peer:
          - access_list: PeerAcl1
        serve:
          - access_list: ServeAcl1
      authenticate: true
      authentication_keys:
        - id: 1001
          key: vagwwtKfkv
          encryption: 7
        - id: 1002
          key: vagwwtKfkvgthz
          encryption: 7
      logging: true
      master:
        stratum: 2
      peers:
        - peer: 192.0.2.1
          key_id: 1
          maxpoll: 15
          minpoll: 5
          vrf: default
        - peer: 192.0.2.2
          key_id: 2
          prefer: true
          vrf: siteA
      servers:
        - server: 198.51.100.1
          key_id: 2
          vrf: default
        - server: 203.0.113.1
          key_id: 1
          vrf: siteB
    state: rendered

# Task Output (redacted)
# -----------------------
#  rendered:
#    - "ntp authenticate"
#    - "ntp logging"
#    - "ntp master 2"
#    - "ntp authentication-keys 1001 md5 vagwwtKfkv 7"
#    - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7"
#    - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15"
#    - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2"
#    - "ntp server 198.51.100.1 use-vrf default key 2"
#    - "ntp server 203.0.113.1 use-vrf siteB key 1"
#    - "ntp access-group peer PeerAcl1"
#    - "ntp access-group serve ServeAcl1"

# Using parsed

# parsed.cfg
# ------------
# ntp authenticate
# ntp logging
# ntp master 2
# ntp authentication-keys 1001 md5 vagwwtKfkv 7
# ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7
# ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15
# ntp peer 192.0.2.2 prefer use-vrf siteA key 2
# ntp server 198.51.100.1 use-vrf default key 2
# ntp server 203.0.113.1 use-vrf siteB key 1
# ntp access-group peer PeerAcl1
# ntp access-group serve ServeAcl1

- name: Parse externally provided ntp configuration
  cisco.nxos.nxos_ntp_global:
    running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}"
    state: parsed

# Task output (redacted)
# -----------------------
# parsed:
#    access_group:
#      peer:
#        - access_list: PeerAcl1
#      serve:
#       - access_list: ServeAcl1
#    authenticate: true
#    authentication_keys:
#      - id: 1001
#        key: vagwwtKfkv
#        encryption: 7
#      - id: 1002
#        key: vagwwtKfkvgthz
#        encryption: 7
#    logging: true
#    master:
#     stratum: 2
#    peers:
#      - peer: 192.0.2.1
#        key_id: 1
#        maxpoll: 15
#        minpoll: 5
#        vrf: default
#      - peer: 192.0.2.2
#        key_id: 2
#        prefer: true
#        vrf: siteA
#    servers:
#      - server: 198.51.100.1
#        key_id: 2
#        vrf: default
#      - server: 203.0.113.1
#        key_id: 1
#        vrf: siteB

返回值

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

键

描述

after

字典

模块执行后的最终配置。

返回：当更改时

示例： "此 输出 将始终 与 模块 argspec 的格式相同。\n"

before

字典

模块执行之前的配置。

返回：当 state 为 merged、replaced、overridden、deleted 或 purged 时

示例： "此 输出 将始终 与 模块 argspec 的格式相同。\n"

commands

列表 / 元素=字符串

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

返回：当 state 为 merged、replaced、overridden、deleted 或 purged 时

示例: ["ntp master stratum 2", "ntp peer 198.51.100.1 use-vrf test maxpoll 7", "ntp authentication-key 10 md5 wawyhanx2 7", "ntp access-group peer PeerAcl1", "ntp access-group peer PeerAcl2", "ntp access-group query-only QueryAcl1"]

已收集

列表 / 元素=字符串

从远程设备收集的关于网络资源的结构化数据的事实。

返回值: 当 state 为 gathered 时

示例: ["此输出将始终与模块的参数规范格式相同。\n"]

已解析

列表 / 元素=字符串

根据模块参数规范，将 running_config 选项中提供的设备本机配置解析为结构化数据。

返回值: 当 state 为 parsed 时

示例: ["此输出将始终与模块的参数规范格式相同。\n"]

已渲染

列表 / 元素=字符串

任务中提供的配置以设备原生格式渲染（离线）。

返回值: 当 state 为 rendered 时

示例: ["ntp master stratum 2", "ntp peer 198.51.100.1 use-vrf test maxpoll 7", "ntp authentication-key 10 md5 wawyhanx2 7", "ntp access-group peer PeerAcl1", "ntp access-group peer PeerAcl2", "ntp access-group query-only QueryAcl1"]

作者

  • Nilashish Chakraborty (@NilashishC)