junipernetworks.junos.junos_hostname module – Manage Hostname server configuration on Junos devices.
Note
This module is part of the junipernetworks.junos collection (version 5.3.1).
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 junipernetworks.junos.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: junipernetworks.junos.junos_hostname.
New in junipernetworks.junos 2.9.0
Synopsis
This module manages hostname configuration on devices running Junos.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ncclient (>=v0.6.4)
xmltodict (>=0.12.0)
Parameters
Parameter |
Comments |
|---|---|
A dictionary of system Hostname configuration. |
|
Specify the hostname. |
|
This option is used only with state parsed. The value of this option should be the output received from the Junos device by executing the command show system hostname. The state parsed reads the configuration from |
|
The state the configuration should be left in. The states rendered, gathered and parsed does not perform any change on the device. The state rendered will transform the configuration in The states merged, replaced and overridden have identical behaviour for this module. The state gathered will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the gathered key within the result. The state parsed reads the configuration from Choices:
|
Notes
Note
This module requires the netconf system service be enabled on the device being managed.
This module works with connection
netconf.Tested against JunOS v18.4R1
Examples
# Using merged
#
# Before state
# ------------
#
# vagrant@vsrx# show system hostname
#
# [edit]
- name: Merge provided HOSTNAME configuration into running configuration.
junipernetworks.junos.junos_hostname:
config:
hostname: 'vsrx-18.4R1'
state: merged
#
# -------------------------
# Module Execution Result
# -------------------------
# "after": {
# "hostname": "vsrx-18.4R1"
# },
# "before": {},
# "changed": true,
# "commands": [
# "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# "<nc:host-name>vsrx-18.4R1</nc:host-name></nc:system>"
# ]
# After state
# -----------
#
# [email protected]# show system host-name
# host-name vsrx-18.4R1;
#
# Using replaced
#
# Before state
# ------------
#
# [email protected]# show system host-name
# host-name vsrx-18.4R1;
#
# [edit]
- name: Replaced target config with provided config.
junipernetworks.junos.junos_hostname:
config:
hostname: 'vsrx-12'
state: replaced
#
# -------------------------
# Module Execution Result
# -------------------------
# "after": {
# "hostname": "vsrx-12"
# },
# "before": {
# "hostname": "vsrx-18.4R1"
# },
# "changed": true,
# "commands": [
# "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# "<nc:host-name>vsrx-12</nc:host-name></nc:system>"
# ]
# After state
# -----------
#
# [email protected]# show system host-name
# host-name vsrx-12;
#
# Using overridden
#
# Before state
# ------------
#
# [email protected]# show system host-name
# host-name vsrx-18.4R1;
#
# [edit]
- name: Replaced target config with provided config.
junipernetworks.junos.junos_hostname:
config:
hostname: 'vsrx-12'
state: overridden
#
# -------------------------
# Module Execution Result
# -------------------------
# "after": {
# "hostname": "vsrx-12"
# },
# "before": {
# "hostname": "vsrx-18.4R1"
# },
# "changed": true,
# "commands": [
# "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# "<nc:host-name>vsrx-12</nc:host-name></nc:system>"
# ]
# After state
# -----------
#
# [email protected]# show system host-name
# host-name vsrx-12;
#
# Using deleted
#
# Before state
# ------------
#
# [email protected]# show system host-name
# host-name vsrx-12;
#
- name: Delete running HOSTNAME global configuration
junipernetworks.junos.junos_hostname:
config:
state: deleted
#
# -------------------------
# Module Execution Result
# -------------------------
# "after": {},
# "before": {
# "hostname": "vsrx-12"
# },
# "changed": true,
# "commands": [
# "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# <nc:host-name delete="delete"/></nc:system>"
# ]
# After state
# -----------
#
# vagrant@vsrx# show system ntp
#
# [edit]
# Using gathered
#
# Before state
# ------------
#
# [email protected]# show system host-name
# host-name vsrx-12;
#
- name: Gather running HOSTNAME global configuration
junipernetworks.junos.junos_hostname:
state: gathered
#
# -------------------------
# Module Execution Result
# -------------------------
# "gathered": {
# "hostname": "vsrx-12",
# },
# "changed": false,
# Using rendered
#
# Before state
# ------------
#
- name: Render xml for provided facts.
junipernetworks.junos.junos_hostname:
config:
boot_server: '78.46.194.186'
state: rendered
#
# -------------------------
# Module Execution Result
# -------------------------
# "rendered": [
# "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">"
# "<nc:host-name>78.46.194.186</nc:host-name></nc:system>"
# ]
#
# Using parsed
# parsed.cfg
# ------------
# <?xml version="1.0" encoding="UTF-8"?>
# <rpc-reply message-id="urn:uuid:0cadb4e8-5bba-47f4-986e-72906227007f">
# <configuration changed-seconds="1590139550" changed-localtime="2020-05-22 09:25:50 UTC">
# <version>18.4R1-S2.4</version>
# <system xmlns="http://yang.juniper.net/junos-es/conf/system">
# <host-name>vsrx-18.4R1</host-name>
# </system>
# </configuration>
# </rpc-reply>
#
- name: Parse HOSTNAME running config
junipernetworks.junos.junos_hostname:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
#
# "parsed": {
# "hostname": "vsrx-18.4R1"
# }
#
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration model invocation. Returned: when changed Sample: |
|
The configuration prior to the model invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |