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

Move networking provider options to subspec (#28894)

Browse source 
* Add EOS provider options as subspec

* Add IOS provider options as subspec

* Add IOS XR provider options as subspec

* Add Junos provider options as subspec

* Add NX-OS provider options as subspec

* Add Vyos provider options as subspec

* Remove password checks from check_args

* Do the same to aireos, aruba, ce, dellos*, & sros, as they work the same way

* VyOS does not support `transport`
This commit is contained in:
Nathaniel Case 2017-09-01 11:53:51 -04:00 committed by GitHub
parent 3334407c71
commit de2096e3d0
14 changed files with 66 additions and 101 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
lib/ansible/module_utils/aireos.py
View file

@ -32,15 +32,18 @@ from ansible.module_utils.connection import exec_command
_DEVICE_CONFIGS = {}
aireos_argument_spec = {
aireos_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
'password': dict(fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD']), no_log=True),
'ssh_keyfile': dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
'timeout': dict(type='int'),
'provider': dict(type='dict')
}
aireos_argument_spec = {
'provider': dict(type='dict', options=aireos_provider_spec)
}
aireos_argument_spec.update(aireos_provider_spec)
# Add argument's default value here
ARGS_DEFAULT_VALUE = {}
@ -61,7 +64,6 @@ def get_argspec():
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in aireos_argument_spec:
if key not in ['provider', 'authorize'] and module.params[key]:
warnings.append('argument %s has been deprecated and will be removed in a future version' % key)
@ -73,11 +75,6 @@ def check_args(module, warnings):
if not module.params.get(key, None):
module.params[key] = ARGS_DEFAULT_VALUE[key]
if provider:
for param in ('auth_pass', 'password'):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def get_config(module, flags=[]):
cmd = 'show run-config commands '

13
lib/ansible/module_utils/aruba.py
View file

@ -32,15 +32,18 @@ from ansible.module_utils.connection import exec_command
_DEVICE_CONFIGS = {}
aruba_argument_spec = {
aruba_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
'password': dict(fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD']), no_log=True),
'ssh_keyfile': dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
'timeout': dict(type='int'),
'provider': dict(type='dict')
}
aruba_argument_spec = {
'provider': dict(type='dict', options=aruba_provider_spec)
}
aruba_argument_spec.update(aruba_provider_spec)
# Add argument's default value here
ARGS_DEFAULT_VALUE = {}
@ -51,7 +54,6 @@ def get_argspec():
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in aruba_argument_spec:
if key not in ['provider', 'authorize'] and module.params[key]:
warnings.append('argument %s has been deprecated and will be removed in a future version' % key)
@ -63,11 +65,6 @@ def check_args(module, warnings):
if not module.params.get(key, None):
module.params[key] = ARGS_DEFAULT_VALUE[key]
if provider:
for param in ('auth_pass', 'password'):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def get_config(module, flags=[]):
cmd = 'show running-config '

9
lib/ansible/module_utils/ce.py
View file

@ -53,7 +53,7 @@ except ImportError:
_DEVICE_CLI_CONNECTION = None
_DEVICE_NC_CONNECTION = None
ce_argument_spec = {
ce_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
@ -61,9 +61,12 @@ ce_argument_spec = {
'use_ssl': dict(type='bool'),
'validate_certs': dict(type='bool'),
'timeout': dict(type='int'),
'provider': dict(type='dict', no_log=True),
'transport': dict(choices=['cli'])
'transport': dict(choices=['cli']),
}
ce_argument_spec = {
'provider': dict(type='dict', options=ce_provider_spec),
}
ce_argument_spec.update(ce_provider_spec)
def check_args(module, warnings):

13
lib/ansible/module_utils/dellos10.py
View file

@ -45,7 +45,7 @@ WARNING_PROMPTS_RE = [
r"[\r\n]?\[yes/no\]:\s?$"
]
dellos10_argument_spec = {
dellos10_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
@ -54,22 +54,19 @@ dellos10_argument_spec = {
'authorize': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTHORIZE']), type='bool'),
'auth_pass': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTH_PASS']), no_log=True),
'timeout': dict(type='int'),
'provider': dict(type='dict'),
}
dellos10_argument_spec = {
'provider': dict(type='dict', options=dellos10_provider_spec),
}
dellos10_argument_spec.update(dellos10_provider_spec)
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in dellos10_argument_spec:
if key != 'provider' and module.params[key]:
warnings.append('argument %s has been deprecated and will be '
'removed in a future version' % key)
if provider:
for param in ('auth_pass', 'password'):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def get_config(module, flags=[]):
cmd = 'show running-config '

13
lib/ansible/module_utils/dellos6.py
View file

@ -44,7 +44,7 @@ WARNING_PROMPTS_RE = [
r"[\r\n]?\[yes/no\]:\s?$"
]
dellos6_argument_spec = {
dellos6_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
@ -53,22 +53,19 @@ dellos6_argument_spec = {
'authorize': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTHORIZE']), type='bool'),
'auth_pass': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTH_PASS']), no_log=True),
'timeout': dict(type='int'),
'provider': dict(type='dict'),
}
dellos6_argument_spec = {
'provider': dict(type='dict', options=dellos6_provider_spec),
}
dellos6_argument_spec.update(dellos6_provider_spec)
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in dellos6_argument_spec:
if key != 'provider' and module.params[key]:
warnings.append('argument %s has been deprecated and will be '
'removed in a future version' % key)
if provider:
for param in ('auth_pass', 'password'):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def get_config(module, flags=[]):
cmd = 'show running-config '

13
lib/ansible/module_utils/dellos9.py
View file

@ -45,7 +45,7 @@ WARNING_PROMPTS_RE = [
r"[\r\n]?\[yes/no\]:\s?$"
]
dellos9_argument_spec = {
dellos9_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
@ -54,22 +54,19 @@ dellos9_argument_spec = {
'authorize': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTHORIZE']), type='bool'),
'auth_pass': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTH_PASS']), no_log=True),
'timeout': dict(type='int'),
'provider': dict(type='dict'),
}
dellos9_argument_spec = {
'provider': dict(type='dict', options=dellos9_provider_spec),
}
dellos9_argument_spec.update(dellos9_provider_spec)
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in dellos9_argument_spec:
if key != 'provider' and module.params[key]:
warnings.append('argument %s has been deprecated and will be '
'removed in a future version' % key)
if provider:
for param in ('auth_pass', 'password'):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def get_config(module, flags=[]):
cmd = 'show running-config '

14
lib/ansible/module_utils/eos.py
View file

@ -39,14 +39,13 @@ from ansible.module_utils.urls import fetch_url
_DEVICE_CONNECTION = None
eos_argument_spec = {
eos_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
'password': dict(fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD']), no_log=True),
'ssh_keyfile': dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
'authorize': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTHORIZE']), type='bool'),
'auth_pass': dict(no_log=True, fallback=(env_fallback, ['ANSIBLE_NET_AUTH_PASS'])),
@ -54,9 +53,12 @@ eos_argument_spec = {
'validate_certs': dict(type='bool'),
'timeout': dict(type='int'),
'provider': dict(type='dict'),
'transport': dict(choices=['cli', 'eapi'])
}
eos_argument_spec = {
'provider': dict(type='dict', options=eos_provider_spec),
}
eos_argument_spec.update(eos_provider_spec)
# Add argument's default value here
ARGS_DEFAULT_VALUE = {
@ -71,7 +73,6 @@ def get_argspec():
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in eos_argument_spec:
if module._name == 'eos_user':
if (key not in ['username', 'password', 'provider', 'transport', 'authorize'] and
@ -88,11 +89,6 @@ def check_args(module, warnings):
if not module.params.get(key, None):
module.params[key] = ARGS_DEFAULT_VALUE[key]
if provider:
for param in ('auth_pass', 'password'):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def load_params(module):
provider = module.params.get('provider') or dict()

13
lib/ansible/module_utils/ios.py
View file

@ -32,7 +32,7 @@ from ansible.module_utils.connection import exec_command
_DEVICE_CONFIGS = {}
ios_argument_spec = {
ios_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
@ -41,8 +41,11 @@ ios_argument_spec = {
'authorize': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTHORIZE']), type='bool'),
'auth_pass': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTH_PASS']), no_log=True),
'timeout': dict(type='int'),
'provider': dict(type='dict'),
}
ios_argument_spec = {
'provider': dict(type='dict', options=ios_provider_spec),
}
ios_argument_spec.update(ios_provider_spec)
def get_argspec():
@ -50,7 +53,6 @@ def get_argspec():
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in ios_argument_spec:
if module._name == 'ios_user':
if key not in ['password', 'provider', 'authorize'] and module.params[key]:
@ -59,11 +61,6 @@ def check_args(module, warnings):
if key not in ['provider', 'authorize'] and module.params[key]:
warnings.append('argument %s has been deprecated and will be removed in a future version' % key)
if provider:
for param in ('auth_pass', 'password'):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def get_defaults_flag(module):
rc, out, err = exec_command(module, 'show running-config ?')

13
lib/ansible/module_utils/iosxr.py
View file

@ -33,15 +33,18 @@ from ansible.module_utils.connection import exec_command
_DEVICE_CONFIGS = {}
iosxr_argument_spec = {
iosxr_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
'password': dict(fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD']), no_log=True),
'ssh_keyfile': dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
'timeout': dict(type='int'),
'provider': dict(type='dict')
}
iosxr_argument_spec = {
'provider': dict(type='dict', options=iosxr_provider_spec)
}
iosxr_argument_spec.update(iosxr_provider_spec)
def get_argspec():
@ -49,7 +52,6 @@ def get_argspec():
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in iosxr_argument_spec:
if module._name == 'iosxr_user':
if key not in ['password', 'provider'] and module.params[key]:
@ -58,11 +60,6 @@ def check_args(module, warnings):
if key != 'provider' and module.params[key]:
warnings.append('argument %s has been deprecated and will be removed in a future version' % key)
if provider:
for param in ('password',):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def get_config(module, flags=[]):
cmd = 'show running-config '

13
lib/ansible/module_utils/junos.py
View file

@ -38,16 +38,19 @@ JSON_ACTIONS = frozenset(['merge', 'override', 'update'])
FORMATS = frozenset(['xml', 'text', 'json'])
CONFIG_FORMATS = frozenset(['xml', 'text', 'json', 'set'])
junos_argument_spec = {
junos_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
'password': dict(fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD']), no_log=True),
'ssh_keyfile': dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
'timeout': dict(type='int'),
'provider': dict(type='dict'),
'transport': dict()
}
junos_argument_spec = {
'provider': dict(type='dict', options=junos_provider_spec),
}
junos_argument_spec.update(junos_provider_spec)
# Add argument's default value here
ARGS_DEFAULT_VALUE = {}
@ -58,7 +61,6 @@ def get_argspec():
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in junos_argument_spec:
if key not in ('provider',) and module.params[key]:
warnings.append('argument %s has been deprecated and will be '
@ -71,11 +73,6 @@ def check_args(module, warnings):
if not module.params.get(key, None):
module.params[key] = ARGS_DEFAULT_VALUE[key]
if provider:
for param in ('password',):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def _validate_rollback_id(module, value):
try:

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

@ -39,7 +39,7 @@ from ansible.module_utils.urls import fetch_url
_DEVICE_CONNECTION = None
nxos_argument_spec = {
nxos_provider_spec = {
'host': dict(),
'port': dict(type='int'),
@ -51,9 +51,12 @@ nxos_argument_spec = {
'validate_certs': dict(type='bool'),
'timeout': dict(type='int'),
'provider': dict(type='dict'),
'transport': dict(choices=['cli', 'nxapi'])
}
nxos_argument_spec = {
'provider': dict(type='dict', options=nxos_provider_spec),
}
nxos_argument_spec.update(nxos_provider_spec)
# Add argument's default value here
ARGS_DEFAULT_VALUE = {
@ -66,7 +69,6 @@ def get_argspec():
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in nxos_argument_spec:
if module._name == 'nxos_user':
if key not in ['password', 'provider', 'transport'] and module.params[key]:
@ -82,11 +84,6 @@ def check_args(module, warnings):
if not module.params.get(key, None):
module.params[key] = ARGS_DEFAULT_VALUE[key]
if provider:
for param in ('password',):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def load_params(module):
provider = module.params.get('provider') or dict()

13
lib/ansible/module_utils/sros.py
View file

@ -38,28 +38,25 @@ from ansible.module_utils.connection import exec_command
_DEVICE_CONFIGS = {}
sros_argument_spec = {
sros_provider_spec = {
'host': dict(),
'port': dict(type='int'),
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
'password': dict(fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD']), no_log=True),
'ssh_keyfile': dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
'timeout': dict(type='int'),
'provider': dict(type='dict')
}
sros_argument_spec = {
'provider': dict(type='dict', options=sros_provider_spec),
}
sros_argument_spec.update(sros_provider_spec)
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in sros_argument_spec:
if key != 'provider' and module.params[key]:
warnings.append('argument %s has been deprecated and will be removed in a future version' % key)
if provider:
for param in ('password',):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def get_config(module, flags=[]):
cmd = 'admin display-config '

13
lib/ansible/module_utils/vyos.py
View file

@ -32,7 +32,7 @@ from ansible.module_utils.connection import exec_command
_DEVICE_CONFIGS = {}
vyos_argument_spec = {
vyos_provider_spec = {
'host': dict(),
'port': dict(type='int'),
@ -41,8 +41,11 @@ vyos_argument_spec = {
'ssh_keyfile': dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
'timeout': dict(type='int'),
'provider': dict(type='dict'),
}
vyos_argument_spec = {
'provider': dict(type='dict', options=vyos_provider_spec),
}
vyos_argument_spec.update(vyos_provider_spec)
def get_argspec():
@ -50,7 +53,6 @@ def get_argspec():
def check_args(module, warnings):
provider = module.params['provider'] or {}
for key in vyos_argument_spec:
if module._name == 'vyos_user':
if key not in ['password', 'provider'] and module.params[key]:
@ -59,11 +61,6 @@ def check_args(module, warnings):
if key != 'provider' and module.params[key]:
warnings.append('argument %s has been deprecated and will be removed in a future version' % key)
if provider:
for param in ('password',):
if provider.get(param):
module.no_log_values.update(return_values(provider[param]))
def get_config(module, target='commands'):
cmd = ' '.join(['show configuration', target])

1
test/integration/group_vars/vyos.yaml
View file

@ -3,4 +3,3 @@ cli:
host: "{{ ansible_ssh_host }}"
# username: "{{ vyos_cli_user | default('ansible-admin') }}"
# password: "{{ vyos_cli_pass | default('adminpw') }}"
transport: cli