cisco.nxos.nxos_hostname 模块 – 主机名资源模块。

注意

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

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

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

要在剧本中使用它，请指定： cisco.nxos.nxos_hostname。

cisco.nxos 2.9.0 中的新增功能

概要 

此模块管理运行 Cisco NX-OS 的设备上的主机名配置。

参数 

参数	注释
config 字典	主机名配置的字典。
hostname 字符串	设备的主机名。
running_config 字符串	此选项仅与 state parsed 一起使用。此选项的值应为通过执行命令 show running-config \| section hostname 从 NX-OS 设备接收到的输出。 state parsed 从 `running_config` 选项读取配置并将其转换为 Ansible 结构化数据，该数据符合资源模块的 argspec，然后该值将返回到结果中的 parsed 键中。
state 字符串	配置应保留的状态。对于此模块，状态 merged、replaced 和 overridden 的行为相同。有关更多详细信息，请参阅示例。选项 `"merged"` ← (默认) `"replaced"` `"overridden"` `"deleted"` `"parsed"` `"gathered"` `"rendered"`

备注 

注意

针对 NX-OS 9.3.6 进行测试。
此模块适用于连接 network_cli 和 httpapi。

示例 

# Using merged (replaced, overridden has the same behaviour)

# Before state:
# -------------
# nxos-9k-rdo# show running-config | section ^hostname
# nxos-9k-rdo#

- name: Merge the provided configuration with the existing running configuration
  cisco.nxos.nxos_hostname:
    config:
      hostname: NXOSv-9k

# Task output
# -------------
# before: {}
#
# commands:
#   - hostname NXOSv-9k
#
# after:
#   hostname: NXOSv-9k

# After state:
# ------------
# nxos-9k-rdo# show running-config | section ^hostname
# hostname NXOSv-9k
#

# Using deleted

# Before state:
# ------------
# nxos-9k-rdo# show running-config | section ^hostname
# hostname NXOSv-9k

- name: Delete hostname from running-config
  cisco.nxos.nxos_hostname:
    state: deleted

# Task output
# -------------
# before:
#   hostname: NXOSv-9k
#
# commands:
#   - no hostname NXOSv-9k
#
# after: {}

# Using gathered

- name: Gather hostname facts using gathered
  cisco.nxos.nxos_hostname:
    state: gathered

# Task output (redacted)
# -----------------------
#  gathered:
#    hostname: NXOSv-9k

# Using rendered

- name: Render platform specific configuration lines (without connecting to the device)
  cisco.nxos.nxos_hostname:
    config:
      hostname: NXOSv-9k

# Task Output (redacted)
# -----------------------
# rendered:
#   - hostname NXOSv-9k

# Using parsed

# parsed.cfg
# ------------
# hostname NXOSv-9k

- name: Parse externally provided hostname config
  cisco.nxos.nxos_hostname:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task output (redacted)
# -----------------------
# parsed:
#   hostname: NXOSv-9k

返回值 

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

键	描述
after 字典	模块执行后的结果配置。返回：发生更改时示例： `"This output will always be in the same format as the module argspec.\n"`
before 字典	模块执行之前的配置。返回：当 state 为 `merged`、`replaced`、`overridden`、`deleted` 或 `purged` 时示例： `"This output will always be in the same format as the module argspec.\n"`
commands 列表 / 元素=字符串	推送到远程设备的命令集。返回：当 state 为 `merged`、`replaced`、`overridden`、`deleted` 或 `purged` 时示例： `["hostname switch01"]`
gathered 列表 / 元素=字符串	从远程设备收集的关于网络资源的事实，作为结构化数据。返回：当 state 为 `gathered` 时示例： `["This output will always be in the same format as the module argspec.\n"]`
parsed 列表 / 元素=字符串	根据模块 argspec 将 running_config 选项中提供的设备原生配置解析为结构化数据。返回：当 state 为 `parsed` 时示例： `["This output will always be in the same format as the module argspec.\n"]`
rendered 列表 / 元素=字符串	以设备原生格式（脱机）呈现的任务中提供的配置。返回：当 state 为 `rendered` 时示例： `["hostname switch01"]`

作者

Nilashish Chakraborty (@NilashishC)