446c7de239
* fixes exception thrown when sending commands to device * fixes exception thrown when retrieving current resource instance * fixes issue where netconf would be configured in some instances when state was set to absent * now returns the command string sent to the remote device * fixes argument name to be netconf_port with alias to listens_on
148 lines
4.5 KiB
Python
148 lines
4.5 KiB
Python
#!/usr/bin/python
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: junos_netconf
|
|
version_added: "2.1"
|
|
author: "Peter Sprygada (@privateip)"
|
|
short_description: Configures the Junos Netconf system service
|
|
description:
|
|
- 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.
|
|
extends_documentation_fragment: junos
|
|
options:
|
|
netconf_port:
|
|
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
|
|
default: 830
|
|
aliases: ['listens_on']
|
|
version_added: "2.2"
|
|
state:
|
|
description:
|
|
- Specifies the state of the M(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
|
|
default: present
|
|
choices: ['present', 'absent']
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
# Note: examples below use the following provider dict to handle
|
|
# transport and authentication to the node.
|
|
vars:
|
|
cli:
|
|
host: "{{ inventory_hostname }}"
|
|
username: ansible
|
|
password: Ansible
|
|
transport: cli
|
|
|
|
- name: enable netconf service on port 830
|
|
junos_netconf:
|
|
listens_on: 830
|
|
state: present
|
|
provider: "{{ cli }}"
|
|
|
|
- name: disable netconf service
|
|
junos_netconf:
|
|
state: absent
|
|
provider: "{{ cli }}"
|
|
"""
|
|
|
|
RETURN = """
|
|
commands:
|
|
description: Returns the command sent to the remote device
|
|
returned: when changed is True
|
|
type: str
|
|
sample: 'set system services netconf ssh port 830'
|
|
"""
|
|
import re
|
|
|
|
import ansible.module_utils.junos
|
|
|
|
from ansible.module_utils.basic import get_exception
|
|
from ansible.module_utils.network import NetworkModule, NetworkError
|
|
|
|
def parse_port(config):
|
|
match = re.search(r'port (\d+)', config)
|
|
if match:
|
|
return int(match.group(1))
|
|
|
|
def get_instance(module):
|
|
cmd = 'show configuration system services netconf'
|
|
cfg = module.cli(cmd)[0]
|
|
result = dict(state='absent')
|
|
if cfg:
|
|
result = dict(state='present')
|
|
result['port'] = parse_port(cfg)
|
|
return result
|
|
|
|
def main():
|
|
"""main entry point for module execution
|
|
"""
|
|
|
|
argument_spec = dict(
|
|
netconf_port=dict(type='int', default=830, aliases=['listens_on']),
|
|
state=dict(default='present', choices=['present', 'absent']),
|
|
transport=dict(default='cli', choices=['cli'])
|
|
)
|
|
|
|
module = NetworkModule(argument_spec=argument_spec,
|
|
supports_check_mode=True)
|
|
|
|
state = module.params['state']
|
|
port = module.params['netconf_port']
|
|
|
|
result = dict(changed=False)
|
|
|
|
instance = get_instance(module)
|
|
|
|
if state == 'present' and instance.get('state') == 'absent':
|
|
commands = 'set system services netconf ssh port %s' % port
|
|
elif state == 'present' and port != instance.get('port'):
|
|
commands = 'set system services netconf ssh port %s' % port
|
|
elif state == 'absent' and instance.get('state') == 'present':
|
|
commands = 'delete system services netconf'
|
|
else:
|
|
commands = None
|
|
|
|
if commands:
|
|
if not module.check_mode:
|
|
try:
|
|
comment = 'configuration updated by junos_netconf'
|
|
module.config(commands, comment=comment)
|
|
except NetworkError:
|
|
exc = get_exception()
|
|
module.fail_json(msg=str(exc), **exc.kwargs)
|
|
result['changed'] = True
|
|
result['commands'] = commands
|
|
|
|
module.exit_json(**result)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|