ansible / ansible.builtin / v2.9.21 / module / junos_netconf Configures the Junos Netconf system service | "added in version" 2.1 of ansible.builtin" Authors: Peter Sprygada (@privateip) preview | supported by networkansible.builtin.junos_netconf (v2.9.21) — module
pip
Install with pip install ansible==2.9.21
This module provides an abstraction that enables and configures the netconf system service running on Junos devices. This module can be used to easily enable the Netconf API. Netconf provides a programmatic interface for working with configuration and state resources as defined in RFC 6242. If the C(netconf_port) is not mentioned in the task by default netconf will be enabled on port 830 only.
- name: enable netconf service on port 830 junos_netconf: listens_on: 830 state: present
- name: disable netconf service junos_netconf: state: absent
state: choices: - present - absent default: present description: - Specifies the state of the C(junos_netconf) resource on the remote device. If the I(state) argument is set to I(present) the netconf service will be configured. If the I(state) argument is set to I(absent) the netconf service will be removed from the configuration. required: false provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli) or C(connection: netconf).' - For more information please see the L(Junos OS Platform Options guide, ../network/user_guide/platform_junos.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: host: description: - Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: description: - Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for C(transport=cli)) or port 830 (for C(transport=netconf)) device. type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: path timeout: description: - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. type: int transport: choices: - cli - netconf default: netconf description: - Configures the transport connection to use when connecting to the remote device. type: str username: description: - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. type: str type: dict netconf_port: aliases: - listens_on default: 830 description: - This argument specifies the port the netconf service should listen on for SSH connections. The default port as defined in RFC 6242 is 830. required: false version_added: '2.2' version_added_collection: ansible.builtin
commands: description: Returns the command sent to the remote device returned: when changed is True sample: set system services netconf ssh port 830 type: str