cisco.nxos.nxos_hostname module – Hostname resource module.
Note
This module is part of the cisco.nxos collection (version 3.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_hostname
.
New in cisco.nxos 2.9.0
Synopsis
This module manages hostname configuration on devices running Cisco NX-OS.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
A dictionary of hostname configuration. |
|
Hostname of the device. |
|
This option is used only with state parsed. The value of this option should be the output received from the NX-OS device by executing the command show running-config | section hostname. The state parsed reads the configuration from |
|
The state the configuration should be left in. The states merged, replaced and overridden have identical behaviour for this module. Refer to examples for more details. Choices:
|
Notes
Note
Tested against NX-OS 9.3.6.
This module works with connection
network_cli
andhttpapi
.
Examples
# 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The resulting configuration after module execution. Returned: when changed Sample: |
|
The configuration prior to the module execution. Returned: when state is Sample: |
|
The set of commands pushed to the remote device. Returned: when state is Sample: |
|
Facts about the network resource gathered from the remote device as structured data. Returned: when state is Sample: |
|
The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is Sample: |
|
The provided configuration in the task rendered in device-native format (offline). Returned: when state is Sample: |