ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Fix nxos provider transport warning issue (#30610)

Browse source 
* Fix nxos provider transport warning issue

*  Add default value of transport arg in provider spec
*  Remove default value if transport arg in top level spec
   This ensure deprecation warning is seen only in case transport
   is given as a top level arg in task
*  Refactor nxos modules to reference transport value from provider
   spec

* Fix unit test

* Remove transport arg assignment in nxos action plugin

* As assigning transport value is handled in provider spec
  top level task arg assignment is no longer required
This commit is contained in:
Ganesh Nalawade 2017-09-22 10:32:25 +05:30 committed by GitHub
parent 118d2cda24
commit d72eb08902
13 changed files with 33 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
lib/ansible/module_utils/nxos.py
View file

@ -49,6 +49,7 @@ nxos_provider_spec = {
'use_ssl': dict(type='bool'),
'validate_certs': dict(type='bool'),
'timeout': dict(type='int'),
'transport': dict(default='cli', choices=['cli', 'nxapi'])
@ -68,7 +69,7 @@ nxos_top_spec = {
'validate_certs': dict(removed_in_version=2.9, type='bool'),
'timeout': dict(removed_in_version=2.9, type='int'),
'transport': dict(removed_in_version=2.9, default='cli', choices=['cli', 'nxapi'])
'transport': dict(removed_in_version=2.9, choices=['cli', 'nxapi'])
}
nxos_argument_spec.update(nxos_top_spec)
@ -84,7 +85,7 @@ def check_args(module, warnings):
def load_params(module):
provider = module.params.get('provider') or dict()
for key, value in iteritems(provider):
if key in nxos_argument_spec:
if key in nxos_provider_spec:
if module.params.get(key) is None and value is not None:
module.params[key] = value

5
lib/ansible/modules/network/nxos/nxos_aaa_server_host.py
View file

@ -161,12 +161,13 @@ from ansible.module_utils.basic import AnsibleModule
def execute_show_command(command, module, command_type='cli_show'):
if module.params['transport'] == 'cli':
provider = module.params['provider']
if provider['transport'] == 'cli':
if 'show run' not in command:
command += ' | json'
cmds = [command]
body = run_commands(module, cmds)
elif module.params['transport'] == 'nxapi':
elif provider['transport'] == 'nxapi':
cmds = {'command': command, 'output': 'text'}
body = run_commands(module, cmds)

5
lib/ansible/modules/network/nxos/nxos_gir.py
View file

@ -170,9 +170,10 @@ from ansible.module_utils.basic import AnsibleModule
def execute_show_command(command, module, command_type='cli_show_ascii'):
cmds = [command]
if module.params['transport'] == 'cli':
provider = module.params['provider']
if provider['transport'] == 'cli':
body = run_commands(module, cmds)
elif module.params['transport'] == 'nxapi':
elif provider['transport'] == 'nxapi':
body = run_commands(module, cmds)
return body

7
lib/ansible/modules/network/nxos/nxos_hsrp.py
View file

@ -129,11 +129,12 @@ from ansible.module_utils.basic import AnsibleModule
def execute_show_command(command, module):
if module.params['transport'] == 'cli':
provider = module.params['provider']
if provider['transport'] == 'cli':
command += ' | json'
cmds = [command]
body = run_commands(module, cmds)
elif module.params['transport'] == 'nxapi':
elif provider['transport'] == 'nxapi':
cmds = [command]
body = run_commands(module, cmds)
@ -394,7 +395,7 @@ def main():
auth_type = module.params['auth_type']
auth_string = module.params['auth_string']
transport = module.params['transport']
transport = module.params['provider']['transport']
if state == 'present' and not vip:
module.fail_json(msg='the "vip" param is required when state=present')

2
lib/ansible/modules/network/nxos/nxos_ip_interface.py
View file

@ -425,7 +425,7 @@ def validate_params(addr, interface, mask, tag, allow_secondary, version, state,
module.fail_json(msg="IPv6 address and mask must be provided when "
"state=absent.")
if intf_type != "ethernet" and module.params["transport"] == "cli":
if intf_type != "ethernet" and module.params["provider"]["transport"] == "cli":
if is_default(interface, module) == "DNE":
module.fail_json(msg="That interface does not exist yet. Create "
"it first.", interface=interface)

10
lib/ansible/modules/network/nxos/nxos_nxapi.py
View file

@ -131,10 +131,9 @@ from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.six import iteritems
def check_args(module, warnings):
transport = module.params['transport']
provider_transport = (module.params['provider'] or {}).get('transport')
if 'nxapi' in (transport, provider_transport):
module.fail_json(msg='transport=nxapi is not supporting when configuring nxapi')
provider = module.params['provider']
if provider['transport'] == 'nxapi':
module.fail_json(msg='module not supported over nxapi transport')
nxos_check_args(module, warnings)
@ -149,9 +148,6 @@ def check_args(module, warnings):
warnings.append('state=stopped is deprecated and will be removed in a '
'a future release. Please use state=absent instead')
if module.params['transport'] == 'nxapi':
module.fail_json(msg='module not supported over nxapi transport')
for key in ['config']:
if module.params[key]:
warnings.append('argument %s is deprecated and will be ignored' % key)

5
lib/ansible/modules/network/nxos/nxos_portchannel.py
View file

@ -142,12 +142,13 @@ def get_custom_value(arg, config, module):
def execute_show_command(command, module):
if module.params['transport'] == 'cli':
provider = module.params['provider']
if provider['transport'] == 'cli':
if 'show port-channel summary' in command:
command += ' | json'
cmds = [command]
body = run_commands(module, cmds)
elif module.params['transport'] == 'nxapi':
elif provider['transport'] == 'nxapi':
cmds = [command]
body = run_commands(module, cmds)

5
lib/ansible/modules/network/nxos/nxos_switchport.py
View file

@ -434,11 +434,12 @@ def apply_value_map(value_map, resource):
def execute_show_command(command, module, command_type='cli_show'):
if module.params['transport'] == 'cli':
provider = module.params['provider']
if provider['transport'] == 'cli':
command += ' | json'
cmds = [command]
body = run_commands(module, cmds)
elif module.params['transport'] == 'nxapi':
elif provider['transport'] == 'nxapi':
cmds = [command]
body = run_commands(module, cmds)

5
lib/ansible/modules/network/nxos/nxos_udld.py
View file

@ -121,12 +121,13 @@ import re
def execute_show_command(command, module, command_type='cli_show'):
if module.params['transport'] == 'cli':
provider = module.params['provider']
if provider['transport'] == 'cli':
if 'show run' not in command:
command += ' | json'
cmds = [command]
body = run_commands(module, cmds)
elif module.params['transport'] == 'nxapi':
elif provider['transport'] == 'nxapi':
cmds = [command]
body = run_commands(module, cmds)

5
lib/ansible/modules/network/nxos/nxos_udld_interface.py
View file

@ -116,12 +116,13 @@ from ansible.module_utils.basic import AnsibleModule
def execute_show_command(command, module, command_type='cli_show'):
if module.params['transport'] == 'cli':
provider = module.params['provider']
if provider['transport'] == 'cli':
if 'show run' not in command:
command += ' | json'
cmds = [command]
body = run_commands(module, cmds)
elif module.params['transport'] == 'nxapi':
elif provider['transport'] == 'nxapi':
cmds = [command]
body = run_commands(module, cmds)

2
lib/ansible/modules/network/nxos/nxos_vrf_interface.py
View file

@ -204,7 +204,7 @@ def main():
"Use nxos_vrf to fix this.")
intf_type = get_interface_type(interface)
if (intf_type != 'ethernet' and module.params['transport'] == 'cli'):
if (intf_type != 'ethernet' and module.params['provider']['transport'] == 'cli'):
if is_default(interface, module) == 'DNE':
module.fail_json(msg="interface does not exist on switch. Verify "
"switch platform or create it first with "

3
lib/ansible/plugins/action/nxos.py
View file

@ -107,8 +107,5 @@ class ActionModule(_ActionModule):
self._task.args['provider'] = provider
# make sure a transport value is set in args
self._task.args['transport'] = transport
result = super(ActionModule, self).run(tmp, task_vars)
return result

3
test/units/modules/network/nxos/nxos_module.py
View file

@ -29,6 +29,9 @@ from ansible.module_utils._text import to_bytes
def set_module_args(args):
if 'provider' not in args:
args['provider'] = {'transport': args.get('transport') or 'cli'}
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
basic._ANSIBLE_ARGS = to_bytes(args)