mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
nxos_pim_interface (#26367)
* Add unit tests to nxos_pim_interface * Update tests to match module * Update nxos_pim_interface * Address pep8 issues
This commit is contained in:
parent
c711754924
commit
5cfdd5df0f
5 changed files with 384 additions and 235 deletions
|
@ -28,96 +28,93 @@ extends_documentation_fragment: nxos
|
||||||
version_added: "2.2"
|
version_added: "2.2"
|
||||||
short_description: Manages PIM interface configuration.
|
short_description: Manages PIM interface configuration.
|
||||||
description:
|
description:
|
||||||
- Manages PIM interface configuration settings.
|
- Manages PIM interface configuration settings.
|
||||||
author:
|
author:
|
||||||
- Jason Edelman (@jedelman8)
|
- Jason Edelman (@jedelman8)
|
||||||
notes:
|
notes:
|
||||||
- When C(state=default), supported params will be reset to a default state.
|
- When C(state=default), supported params will be reset to a default state.
|
||||||
These include C(dr_prio), C(hello_auth_key), C(hello_interval), C(jp_policy_out),
|
These include C(dr_prio), C(hello_auth_key), C(hello_interval), C(jp_policy_out),
|
||||||
C(jp_policy_in), C(jp_type_in), C(jp_type_out), C(border), C(neighbor_policy),
|
C(jp_policy_in), C(jp_type_in), C(jp_type_out), C(border), C(neighbor_policy),
|
||||||
C(neighbor_type).
|
C(neighbor_type).
|
||||||
- The C(hello_auth_key) param is not idempotent.
|
- The C(hello_auth_key) param is not idempotent.
|
||||||
- C(hello_auth_key) only supports clear text passwords.
|
- C(hello_auth_key) only supports clear text passwords.
|
||||||
- When C(state=absent), pim interface configuration will be set to defaults and pim-sm
|
- When C(state=absent), pim interface configuration will be set to defaults and pim-sm
|
||||||
will be disabled on the interface.
|
will be disabled on the interface.
|
||||||
- PIM must be enabled on the device to use this module.
|
- PIM must be enabled on the device to use this module.
|
||||||
- This module is for Layer 3 interfaces.
|
- This module is for Layer 3 interfaces.
|
||||||
options:
|
options:
|
||||||
interface:
|
interface:
|
||||||
description:
|
description:
|
||||||
- Full name of the interface such as Ethernet1/33.
|
- Full name of the interface such as Ethernet1/33.
|
||||||
required: true
|
required: true
|
||||||
sparse:
|
sparse:
|
||||||
description:
|
description:
|
||||||
- Enable/disable sparse-mode on the interface.
|
- Enable/disable sparse-mode on the interface.
|
||||||
required: false
|
required: false
|
||||||
default: true
|
default: true
|
||||||
choices: ['true', 'false']
|
choices: ['true', 'false']
|
||||||
hello_auth_key:
|
hello_auth_key:
|
||||||
description:
|
description:
|
||||||
- Authentication for hellos on this interface.
|
- Authentication for hellos on this interface.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
hello_interval:
|
hello_interval:
|
||||||
description:
|
description:
|
||||||
- Hello interval in milliseconds for this interface.
|
- Hello interval in milliseconds for this interface.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
choices: ['true', 'false']
|
choices: ['true', 'false']
|
||||||
jp_policy_out:
|
jp_policy_out:
|
||||||
description:
|
description:
|
||||||
- Policy for join-prune messages (outbound).
|
- Policy for join-prune messages (outbound).
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
jp_policy_in:
|
jp_policy_in:
|
||||||
description:
|
description:
|
||||||
- Policy for join-prune messages (inbound).
|
- Policy for join-prune messages (inbound).
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
jp_type_out:
|
jp_type_out:
|
||||||
description:
|
description:
|
||||||
- Type of policy mapped to C(jp_policy_out).
|
- Type of policy mapped to C(jp_policy_out).
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
choices: ['prefix', 'routemap']
|
choices: ['prefix', 'routemap']
|
||||||
jp_type_in:
|
jp_type_in:
|
||||||
description:
|
description:
|
||||||
- Type of policy mapped to C(jp_policy_in).
|
- Type of policy mapped to C(jp_policy_in).
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
choices: ['prefix', 'routemap']
|
choices: ['prefix', 'routemap']
|
||||||
border:
|
border:
|
||||||
description:
|
description:
|
||||||
- Configures interface to be a boundary of a PIM domain.
|
- Configures interface to be a boundary of a PIM domain.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
choices: ['true', 'false']
|
choices: ['true', 'false']
|
||||||
neighbor_policy:
|
neighbor_policy:
|
||||||
description:
|
description:
|
||||||
- Configures a neighbor policy for filtering adjacencies.
|
- Configures a neighbor policy for filtering adjacencies.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
neighbor_type:
|
neighbor_type:
|
||||||
description:
|
description:
|
||||||
- Type of policy mapped to neighbor_policy.
|
- Type of policy mapped to neighbor_policy.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
choices: ['prefix', 'routemap']
|
choices: ['prefix', 'routemap']
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Manages desired state of the resource.
|
- Manages desired state of the resource.
|
||||||
required: false
|
required: false
|
||||||
default: present
|
default: present
|
||||||
choices: ['present', 'default']
|
choices: ['present', 'default']
|
||||||
'''
|
'''
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
# ensure PIM is not running on the interface
|
# ensure PIM is not running on the interface
|
||||||
- nxos_pim_interface:
|
- nxos_pim_interface:
|
||||||
interface: eth1/33
|
interface: eth1/33
|
||||||
state: absent
|
state: absent
|
||||||
host: "{{ inventory_hostname }}"
|
|
||||||
username: "{{ un }}"
|
|
||||||
password: "{{ pwd }}"
|
|
||||||
|
|
||||||
# ensure the interface has pim-sm enabled with the appropriate priority and hello interval
|
# ensure the interface has pim-sm enabled with the appropriate priority and hello interval
|
||||||
- nxos_pim_interface:
|
- nxos_pim_interface:
|
||||||
|
@ -125,9 +122,6 @@ EXAMPLES = '''
|
||||||
dr_prio: 10
|
dr_prio: 10
|
||||||
hello_interval: 40
|
hello_interval: 40
|
||||||
state: present
|
state: present
|
||||||
host: "{{ inventory_hostname }}"
|
|
||||||
username: "{{ un }}"
|
|
||||||
password: "{{ pwd }}"
|
|
||||||
|
|
||||||
# ensure join-prune policies exist
|
# ensure join-prune policies exist
|
||||||
- nxos_pim_interface:
|
- nxos_pim_interface:
|
||||||
|
@ -136,56 +130,20 @@ EXAMPLES = '''
|
||||||
jp_policy_out: JPOUT
|
jp_policy_out: JPOUT
|
||||||
jp_type_in: routemap
|
jp_type_in: routemap
|
||||||
jp_type_out: routemap
|
jp_type_out: routemap
|
||||||
host: "{{ inventory_hostname }}"
|
|
||||||
username: "{{ un }}"
|
|
||||||
password: "{{ pwd }}"
|
|
||||||
|
|
||||||
# ensure defaults are in place
|
# ensure defaults are in place
|
||||||
- nxos_pim_interface:
|
- nxos_pim_interface:
|
||||||
interface: eth1/33
|
interface: eth1/33
|
||||||
state: default
|
state: default
|
||||||
host: "{{ inventory_hostname }}"
|
|
||||||
username: "{{ un }}"
|
|
||||||
password: "{{ pwd }}"
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
proposed:
|
commands:
|
||||||
description: k/v pairs of parameters passed into module
|
|
||||||
returned: always
|
|
||||||
type: dict
|
|
||||||
sample: {"interface": "eth1/33", "neighbor_policy": "test",
|
|
||||||
"neighbor_type": "routemap", "sparse": true}
|
|
||||||
existing:
|
|
||||||
description:
|
|
||||||
- k/v pairs of existing configuration
|
|
||||||
returned: always
|
|
||||||
type: dict
|
|
||||||
sample: {"border": false, "dr_prio": "1", "hello_interval": "30000",
|
|
||||||
"isauth": false, "jp_bidir": false, "jp_policy_in": "JPIN",
|
|
||||||
"jp_policy_out": "1", "jp_type_in": "routemap",
|
|
||||||
"jp_type_out": null, "neighbor_policy": "test1",
|
|
||||||
"neighbor_type": "prefix", "sparse": true}
|
|
||||||
end_state:
|
|
||||||
description: k/v pairs of configuration after module execution
|
|
||||||
returned: always
|
|
||||||
type: dict
|
|
||||||
sample: {"border": false, "dr_prio": "1", "hello_interval": "30000",
|
|
||||||
"isauth": false, "jp_bidir": false, "jp_policy_in": "JPIN",
|
|
||||||
"jp_policy_out": "1", "jp_type_in": "routemap",
|
|
||||||
"jp_type_out": null, "neighbor_policy": "test",
|
|
||||||
"neighbor_type": "routemap", "sparse": true}
|
|
||||||
updates:
|
|
||||||
description: command sent to the device
|
description: command sent to the device
|
||||||
returned: always
|
returned: always
|
||||||
type: list
|
type: list
|
||||||
sample: ["interface eth1/33", "ip pim neighbor-policy test",
|
sample: ["interface eth1/33", "ip pim neighbor-policy test",
|
||||||
"ip pim neighbor-policy test"]
|
"ip pim neighbor-policy test"]
|
||||||
changed:
|
|
||||||
description: check to see if a change was made on the device
|
|
||||||
returned: always
|
|
||||||
type: boolean
|
|
||||||
sample: true
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
@ -193,23 +151,29 @@ from ansible.module_utils.nxos import get_config, load_config, run_commands
|
||||||
from ansible.module_utils.nxos import nxos_argument_spec, check_args
|
from ansible.module_utils.nxos import nxos_argument_spec, check_args
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
||||||
import time
|
|
||||||
|
|
||||||
import re
|
PARAM_TO_COMMAND_KEYMAP = {
|
||||||
import re
|
'interface': '',
|
||||||
|
'sparse': 'ip pim sparse-mode',
|
||||||
|
'dr_prio': 'ip pim dr-priority {0}',
|
||||||
|
'hello_interval': 'ip pim hello-interval {0}',
|
||||||
|
'hello_auth_key': 'ip pim hello-authentication ah-md5 {0}',
|
||||||
|
'border': 'ip pim border',
|
||||||
|
'jp_policy_out': 'ip pim jp-policy prefix-list {0} out',
|
||||||
|
'jp_policy_in': 'ip pim jp-policy prefix-list {0} in',
|
||||||
|
'jp_type_in': '',
|
||||||
|
'jp_type_out': '',
|
||||||
|
'neighbor_policy': 'ip pim neighbor-policy prefix-list {0}',
|
||||||
|
'neighbor_type': '',
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
def execute_show_command(command, module, command_type='cli_show', text=False):
|
def execute_show_command(command, module, text=False):
|
||||||
if module.params['transport'] == 'cli':
|
if text is False:
|
||||||
if 'show run' not in command and text is False:
|
command += ' | json'
|
||||||
command += ' | json'
|
|
||||||
cmds = [command]
|
|
||||||
body = run_commands(module, cmds)
|
|
||||||
elif module.params['transport'] == 'nxapi':
|
|
||||||
cmds = [command]
|
|
||||||
body = run_commands(module, cmds)
|
|
||||||
|
|
||||||
return body
|
cmds = [command]
|
||||||
|
return run_commands(module, cmds)
|
||||||
|
|
||||||
|
|
||||||
def flatten_list(command_lists):
|
def flatten_list(command_lists):
|
||||||
|
@ -254,10 +218,9 @@ def get_interface_type(interface):
|
||||||
|
|
||||||
|
|
||||||
def get_interface_mode(interface, intf_type, module):
|
def get_interface_mode(interface, intf_type, module):
|
||||||
command = 'show interface {0}'.format(interface)
|
command = 'show interface {0} | json'.format(interface)
|
||||||
mode = 'unknown'
|
mode = 'unknown'
|
||||||
interface_table = {}
|
body = run_commands(module, [command])
|
||||||
body = execute_show_command(command, module)
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
interface_table = body[0]['TABLE_interface']['ROW_interface']
|
interface_table = body[0]['TABLE_interface']['ROW_interface']
|
||||||
|
@ -279,8 +242,7 @@ def get_pim_interface(module, interface):
|
||||||
pim_interface = {}
|
pim_interface = {}
|
||||||
command = 'show ip pim interface {0}'.format(interface)
|
command = 'show ip pim interface {0}'.format(interface)
|
||||||
|
|
||||||
body = execute_show_command(command, module,
|
body = execute_show_command(command, module, text=True)
|
||||||
command_type='cli_show_ascii', text=True)
|
|
||||||
|
|
||||||
if body:
|
if body:
|
||||||
if 'not running' not in body[0]:
|
if 'not running' not in body[0]:
|
||||||
|
@ -297,7 +259,7 @@ def get_pim_interface(module, interface):
|
||||||
|
|
||||||
hello_interval = get_data.get('hello-interval-sec')
|
hello_interval = get_data.get('hello-interval-sec')
|
||||||
if hello_interval:
|
if hello_interval:
|
||||||
hello_interval_msec = int(get_data.get('hello-interval-sec'))*1000
|
hello_interval_msec = int(get_data.get('hello-interval-sec')) * 1000
|
||||||
pim_interface['hello_interval'] = str(hello_interval_msec)
|
pim_interface['hello_interval'] = str(hello_interval_msec)
|
||||||
border = get_data.get('is-border')
|
border = get_data.get('is-border')
|
||||||
|
|
||||||
|
@ -334,9 +296,7 @@ def get_pim_interface(module, interface):
|
||||||
except (KeyError, AttributeError, TypeError, IndexError):
|
except (KeyError, AttributeError, TypeError, IndexError):
|
||||||
return {}
|
return {}
|
||||||
|
|
||||||
command = 'show run interface {0}'.format(interface)
|
body = get_config(module, flags=['interface {0}'.format(interface)])
|
||||||
|
|
||||||
body = execute_show_command(command, module, command_type='cli_show_ascii')
|
|
||||||
|
|
||||||
jp_configs = []
|
jp_configs = []
|
||||||
neigh = None
|
neigh = None
|
||||||
|
@ -417,30 +377,12 @@ def config_pim_interface(delta, existing, jp_bidir, isauth):
|
||||||
|
|
||||||
delta = fix_delta(delta, existing)
|
delta = fix_delta(delta, existing)
|
||||||
|
|
||||||
CMDS = {
|
|
||||||
'sparse': 'ip pim sparse-mode',
|
|
||||||
'dr_prio': 'ip pim dr-priority {0}',
|
|
||||||
'hello_interval': 'ip pim hello-interval {0}',
|
|
||||||
'hello_auth_key': 'ip pim hello-authentication ah-md5 {0}',
|
|
||||||
'border': 'ip pim border',
|
|
||||||
'jp_policy_out': 'ip pim jp-policy prefix-list {0} out',
|
|
||||||
'jp_policy_in': 'ip pim jp-policy prefix-list {0} in',
|
|
||||||
'jp_type_in': '',
|
|
||||||
'jp_type_out': '',
|
|
||||||
'neighbor_policy': 'ip pim neighbor-policy prefix-list {0}',
|
|
||||||
'neighbor_type': ''
|
|
||||||
}
|
|
||||||
|
|
||||||
if jp_bidir:
|
if jp_bidir:
|
||||||
if delta.get('jp_policy_in') or delta.get('jp_policy_out'):
|
if delta.get('jp_policy_in') or delta.get('jp_policy_out'):
|
||||||
if existing.get('jp_type_in') == 'prefix':
|
if existing.get('jp_type_in') == 'prefix':
|
||||||
command = 'no ip pim jp-policy prefix-list {0}'.format(
|
command = 'no ip pim jp-policy prefix-list {0}'.format(existing.get('jp_policy_in'))
|
||||||
existing.get('jp_policy_in')
|
|
||||||
)
|
|
||||||
else:
|
else:
|
||||||
command = 'no ip pim jp-policy {0}'.format(
|
command = 'no ip pim jp-policy {0}'.format(existing.get('jp_policy_in'))
|
||||||
existing.get('jp_policy_in')
|
|
||||||
)
|
|
||||||
if command:
|
if command:
|
||||||
commands.append(command)
|
commands.append(command)
|
||||||
|
|
||||||
|
@ -448,12 +390,12 @@ def config_pim_interface(delta, existing, jp_bidir, isauth):
|
||||||
if k in ['dr_prio', 'hello_interval', 'hello_auth_key', 'border',
|
if k in ['dr_prio', 'hello_interval', 'hello_auth_key', 'border',
|
||||||
'sparse']:
|
'sparse']:
|
||||||
if v:
|
if v:
|
||||||
command = CMDS.get(k).format(v)
|
command = PARAM_TO_COMMAND_KEYMAP.get(k).format(v)
|
||||||
elif k == 'hello_auth_key':
|
elif k == 'hello_auth_key':
|
||||||
if isauth:
|
if isauth:
|
||||||
command = 'no ip pim hello-authentication ah-md5'
|
command = 'no ip pim hello-authentication ah-md5'
|
||||||
else:
|
else:
|
||||||
command = 'no ' + CMDS.get(k).format(v)
|
command = 'no ' + PARAM_TO_COMMAND_KEYMAP.get(k).format(v)
|
||||||
|
|
||||||
if command:
|
if command:
|
||||||
commands.append(command)
|
commands.append(command)
|
||||||
|
@ -463,33 +405,33 @@ def config_pim_interface(delta, existing, jp_bidir, isauth):
|
||||||
temp = delta.get('neighbor_policy') or existing.get(
|
temp = delta.get('neighbor_policy') or existing.get(
|
||||||
'neighbor_policy')
|
'neighbor_policy')
|
||||||
if delta.get('neighbor_type') == 'prefix':
|
if delta.get('neighbor_type') == 'prefix':
|
||||||
command = CMDS.get(k).format(temp)
|
command = PARAM_TO_COMMAND_KEYMAP.get(k).format(temp)
|
||||||
elif delta.get('neighbor_type') == 'routemap':
|
elif delta.get('neighbor_type') == 'routemap':
|
||||||
command = 'ip pim neighbor-policy {0}'.format(temp)
|
command = 'ip pim neighbor-policy {0}'.format(temp)
|
||||||
elif existing.get('neighbor_type') == 'prefix':
|
elif existing.get('neighbor_type') == 'prefix':
|
||||||
command = CMDS.get(k).format(temp)
|
command = PARAM_TO_COMMAND_KEYMAP.get(k).format(temp)
|
||||||
elif existing.get('neighbor_type') == 'routemap':
|
elif existing.get('neighbor_type') == 'routemap':
|
||||||
command = 'ip pim neighbor-policy {0}'.format(temp)
|
command = 'ip pim neighbor-policy {0}'.format(temp)
|
||||||
elif k in ['jp_policy_in', 'jp_type_in']:
|
elif k in ['jp_policy_in', 'jp_type_in']:
|
||||||
temp = delta.get('jp_policy_in') or existing.get(
|
temp = delta.get('jp_policy_in') or existing.get(
|
||||||
'jp_policy_in')
|
'jp_policy_in')
|
||||||
if delta.get('jp_type_in') == 'prefix':
|
if delta.get('jp_type_in') == 'prefix':
|
||||||
command = CMDS.get(k).format(temp)
|
command = PARAM_TO_COMMAND_KEYMAP.get(k).format(temp)
|
||||||
elif delta.get('jp_type_in') == 'routemap':
|
elif delta.get('jp_type_in') == 'routemap':
|
||||||
command = 'ip pim jp-policy {0} in'.format(temp)
|
command = 'ip pim jp-policy {0} in'.format(temp)
|
||||||
elif existing.get('jp_type_in') == 'prefix':
|
elif existing.get('jp_type_in') == 'prefix':
|
||||||
command = CMDS.get(k).format(temp)
|
command = PARAM_TO_COMMAND_KEYMAP.get(k).format(temp)
|
||||||
elif existing.get('jp_type_in') == 'routemap':
|
elif existing.get('jp_type_in') == 'routemap':
|
||||||
command = 'ip pim jp-policy {0} in'.format(temp)
|
command = 'ip pim jp-policy {0} in'.format(temp)
|
||||||
elif k in ['jp_policy_out', 'jp_type_out']:
|
elif k in ['jp_policy_out', 'jp_type_out']:
|
||||||
temp = delta.get('jp_policy_out') or existing.get(
|
temp = delta.get('jp_policy_out') or existing.get(
|
||||||
'jp_policy_out')
|
'jp_policy_out')
|
||||||
if delta.get('jp_type_out') == 'prefix':
|
if delta.get('jp_type_out') == 'prefix':
|
||||||
command = CMDS.get(k).format(temp)
|
command = PARAM_TO_COMMAND_KEYMAP.get(k).format(temp)
|
||||||
elif delta.get('jp_type_out') == 'routemap':
|
elif delta.get('jp_type_out') == 'routemap':
|
||||||
command = 'ip pim jp-policy {0} out'.format(temp)
|
command = 'ip pim jp-policy {0} out'.format(temp)
|
||||||
elif existing.get('jp_type_out') == 'prefix':
|
elif existing.get('jp_type_out') == 'prefix':
|
||||||
command = CMDS.get(k).format(temp)
|
command = PARAM_TO_COMMAND_KEYMAP.get(k).format(temp)
|
||||||
elif existing.get('jp_type_out') == 'routemap':
|
elif existing.get('jp_type_out') == 'routemap':
|
||||||
command = 'ip pim jp-policy {0} out'.format(temp)
|
command = 'ip pim jp-policy {0} out'.format(temp)
|
||||||
if command:
|
if command:
|
||||||
|
@ -521,35 +463,33 @@ def default_pim_interface_policies(existing, jp_bidir):
|
||||||
if jp_bidir:
|
if jp_bidir:
|
||||||
if existing.get('jp_policy_in') or existing.get('jp_policy_out'):
|
if existing.get('jp_policy_in') or existing.get('jp_policy_out'):
|
||||||
if existing.get('jp_type_in') == 'prefix':
|
if existing.get('jp_type_in') == 'prefix':
|
||||||
command = 'no ip pim jp-policy prefix-list {0}'.format(
|
command = 'no ip pim jp-policy prefix-list {0}'.format(existing.get('jp_policy_in'))
|
||||||
existing.get('jp_policy_in')
|
|
||||||
)
|
|
||||||
if command:
|
if command:
|
||||||
commands.append(command)
|
commands.append(command)
|
||||||
|
|
||||||
elif not jp_bidir:
|
elif not jp_bidir:
|
||||||
command = None
|
command = None
|
||||||
for k, v in existing.items():
|
for k in existing:
|
||||||
if k == 'jp_policy_in':
|
if k == 'jp_policy_in':
|
||||||
if existing.get('jp_policy_in'):
|
if existing.get('jp_policy_in'):
|
||||||
if existing.get('jp_type_in') == 'prefix':
|
if existing.get('jp_type_in') == 'prefix':
|
||||||
command = 'no ip pim jp-policy prefix-list {0} in'.format(
|
command = 'no ip pim jp-policy prefix-list {0} in'.format(
|
||||||
existing.get('jp_policy_in')
|
existing.get('jp_policy_in')
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
command = 'no ip pim jp-policy {0} in'.format(
|
command = 'no ip pim jp-policy {0} in'.format(
|
||||||
existing.get('jp_policy_in')
|
existing.get('jp_policy_in')
|
||||||
)
|
)
|
||||||
elif k == 'jp_policy_out':
|
elif k == 'jp_policy_out':
|
||||||
if existing.get('jp_policy_out'):
|
if existing.get('jp_policy_out'):
|
||||||
if existing.get('jp_type_out') == 'prefix':
|
if existing.get('jp_type_out') == 'prefix':
|
||||||
command = 'no ip pim jp-policy prefix-list {0} out'.format(
|
command = 'no ip pim jp-policy prefix-list {0} out'.format(
|
||||||
existing.get('jp_policy_out')
|
existing.get('jp_policy_out')
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
command = 'no ip pim jp-policy {0} out'.format(
|
command = 'no ip pim jp-policy {0} out'.format(
|
||||||
existing.get('jp_policy_out')
|
existing.get('jp_policy_out')
|
||||||
)
|
)
|
||||||
if command:
|
if command:
|
||||||
commands.append(command)
|
commands.append(command)
|
||||||
command = None
|
command = None
|
||||||
|
@ -581,7 +521,7 @@ def config_pim_interface_defaults(existing, jp_bidir, isauth):
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
argument_spec=dict(
|
argument_spec = dict(
|
||||||
interface=dict(required=True),
|
interface=dict(required=True),
|
||||||
sparse=dict(type='bool', default=True),
|
sparse=dict(type='bool', default=True),
|
||||||
dr_prio=dict(type='str'),
|
dr_prio=dict(type='str'),
|
||||||
|
@ -594,22 +534,17 @@ def main():
|
||||||
border=dict(type='bool'),
|
border=dict(type='bool'),
|
||||||
neighbor_policy=dict(type='str'),
|
neighbor_policy=dict(type='str'),
|
||||||
neighbor_type=dict(choices=['prefix', 'routemap']),
|
neighbor_type=dict(choices=['prefix', 'routemap']),
|
||||||
state=dict(choices=['present', 'absent', 'default'],
|
state=dict(choices=['present', 'absent', 'default'], default='present'),
|
||||||
default='present'),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
argument_spec.update(nxos_argument_spec)
|
argument_spec.update(nxos_argument_spec)
|
||||||
|
|
||||||
module = AnsibleModule(argument_spec=argument_spec,
|
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
|
||||||
supports_check_mode=True)
|
|
||||||
|
|
||||||
warnings = list()
|
warnings = list()
|
||||||
check_args(module, warnings)
|
check_args(module, warnings)
|
||||||
|
results = {'changed': False, 'commands': [], 'warnings': warnings}
|
||||||
|
|
||||||
state = module.params['state']
|
state = module.params['state']
|
||||||
|
|
||||||
sparse = module.params['sparse']
|
|
||||||
interface = module.params['interface']
|
interface = module.params['interface']
|
||||||
jp_type_in = module.params['jp_type_in']
|
jp_type_in = module.params['jp_type_in']
|
||||||
jp_type_out = module.params['jp_type_out']
|
jp_type_out = module.params['jp_type_out']
|
||||||
|
@ -628,49 +563,24 @@ def main():
|
||||||
module.fail_json(msg='jp_type_in required when using jp_policy_in.')
|
module.fail_json(msg='jp_type_in required when using jp_policy_in.')
|
||||||
if jp_policy_out:
|
if jp_policy_out:
|
||||||
if not jp_type_out:
|
if not jp_type_out:
|
||||||
module.fail_json(msg='jp_type_out required when using '
|
module.fail_json(msg='jp_type_out required when using jp_policy_out.')
|
||||||
' jp_policy_out.')
|
|
||||||
if neighbor_policy:
|
if neighbor_policy:
|
||||||
if not neighbor_type:
|
if not neighbor_type:
|
||||||
module.fail_json(msg='neighbor_type required when using '
|
module.fail_json(msg='neighbor_type required when using neighbor_policy.')
|
||||||
'neighbor_policy.')
|
|
||||||
|
|
||||||
get_existing = get_pim_interface(module, interface)
|
get_existing = get_pim_interface(module, interface)
|
||||||
existing, jp_bidir, isauth = local_existing(get_existing)
|
existing, jp_bidir, isauth = local_existing(get_existing)
|
||||||
end_state = existing
|
|
||||||
changed = False
|
|
||||||
|
|
||||||
commands = []
|
args = PARAM_TO_COMMAND_KEYMAP.keys()
|
||||||
|
|
||||||
args = [
|
|
||||||
'interface',
|
|
||||||
'sparse',
|
|
||||||
'dr_prio',
|
|
||||||
'hello_auth_key',
|
|
||||||
'hello_interval',
|
|
||||||
'jp_policy_out',
|
|
||||||
'jp_type_out',
|
|
||||||
'jp_type_in',
|
|
||||||
'jp_policy_in',
|
|
||||||
'border',
|
|
||||||
'neighbor_type',
|
|
||||||
'neighbor_policy'
|
|
||||||
]
|
|
||||||
proposed = dict((k, v) for k, v in module.params.items()
|
proposed = dict((k, v) for k, v in module.params.items()
|
||||||
if v is not None and k in args)
|
if v is not None and k in args)
|
||||||
|
|
||||||
'''
|
|
||||||
CANNOT_ABSENT = ['dr_prio', 'hello_interval',
|
|
||||||
'hello_auth_key', 'jp_policy_out', 'jp_policy_in',
|
|
||||||
'jp_type_out', 'jp_type_in', 'border', 'neighbor_type',
|
|
||||||
'neighbor_policy']
|
|
||||||
'''
|
|
||||||
|
|
||||||
if hello_interval:
|
if hello_interval:
|
||||||
proposed['hello_interval'] = str(proposed['hello_interval'] * 1000)
|
proposed['hello_interval'] = str(proposed['hello_interval'] * 1000)
|
||||||
|
|
||||||
delta = dict(set(proposed.items()).difference(existing.items()))
|
delta = dict(set(proposed.items()).difference(existing.items()))
|
||||||
|
|
||||||
|
commands = []
|
||||||
if state == 'present':
|
if state == 'present':
|
||||||
if delta:
|
if delta:
|
||||||
command = config_pim_interface(delta, existing, jp_bidir, isauth)
|
command = config_pim_interface(delta, existing, jp_bidir, isauth)
|
||||||
|
@ -696,29 +606,17 @@ def main():
|
||||||
commands.insert(0, ['interface {0}'.format(interface)])
|
commands.insert(0, ['interface {0}'.format(interface)])
|
||||||
|
|
||||||
cmds = flatten_list(commands)
|
cmds = flatten_list(commands)
|
||||||
results = {}
|
|
||||||
if cmds:
|
if cmds:
|
||||||
if module.check_mode:
|
results['changed'] = True
|
||||||
module.exit_json(changed=True, commands=cmds)
|
if not module.check_mode:
|
||||||
else:
|
|
||||||
changed = True
|
|
||||||
load_config(module, cmds)
|
load_config(module, cmds)
|
||||||
time.sleep(1)
|
if 'configure' in cmds:
|
||||||
get_existing = get_pim_interface(module, interface)
|
cmds.pop(0)
|
||||||
end_state, jp_bidir, isauth = local_existing(get_existing)
|
|
||||||
if 'configure' in cmds:
|
|
||||||
cmds.pop(0)
|
|
||||||
|
|
||||||
results['proposed'] = proposed
|
results['commands'] = cmds
|
||||||
results['existing'] = existing
|
|
||||||
results['updates'] = cmds
|
|
||||||
results['changed'] = changed
|
|
||||||
results['warnings'] = warnings
|
|
||||||
results['end_state'] = end_state
|
|
||||||
|
|
||||||
module.exit_json(**results)
|
module.exit_json(**results)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
main()
|
main()
|
||||||
|
|
||||||
|
|
|
@ -363,7 +363,6 @@ lib/ansible/modules/network/nxos/nxos_ntp_auth.py
|
||||||
lib/ansible/modules/network/nxos/nxos_ntp_options.py
|
lib/ansible/modules/network/nxos/nxos_ntp_options.py
|
||||||
lib/ansible/modules/network/nxos/nxos_nxapi.py
|
lib/ansible/modules/network/nxos/nxos_nxapi.py
|
||||||
lib/ansible/modules/network/nxos/nxos_overlay_global.py
|
lib/ansible/modules/network/nxos/nxos_overlay_global.py
|
||||||
lib/ansible/modules/network/nxos/nxos_pim_interface.py
|
|
||||||
lib/ansible/modules/network/nxos/nxos_ping.py
|
lib/ansible/modules/network/nxos/nxos_ping.py
|
||||||
lib/ansible/modules/network/nxos/nxos_smu.py
|
lib/ansible/modules/network/nxos/nxos_smu.py
|
||||||
lib/ansible/modules/network/nxos/nxos_snapshot.py
|
lib/ansible/modules/network/nxos/nxos_snapshot.py
|
||||||
|
|
|
@ -0,0 +1,96 @@
|
||||||
|
{
|
||||||
|
"TABLE_interface": {
|
||||||
|
"ROW_interface": {
|
||||||
|
"interface": "Ethernet2/1",
|
||||||
|
"state": "up",
|
||||||
|
"admin_state": "up",
|
||||||
|
"share_state": "Dedicated",
|
||||||
|
"eth_hw_desc": "Ethernet",
|
||||||
|
"eth_hw_addr": "fa16.3e00.0001",
|
||||||
|
"eth_bia_addr": "fa16.3e27.f279",
|
||||||
|
"desc": "to nxos03",
|
||||||
|
"eth_ip_addr": "10.0.0.45",
|
||||||
|
"eth_ip_mask": 30,
|
||||||
|
"eth_ip_prefix": "10.0.0.44",
|
||||||
|
"eth_mtu": "1500",
|
||||||
|
"eth_bw": 1000000,
|
||||||
|
"eth_dly": 10,
|
||||||
|
"eth_reliability": "255",
|
||||||
|
"eth_txload": "1",
|
||||||
|
"eth_rxload": "1",
|
||||||
|
"medium": "broadcast",
|
||||||
|
"eth_mode": "routed",
|
||||||
|
"eth_duplex": "full",
|
||||||
|
"eth_speed": "1000 Mb/s",
|
||||||
|
"eth_beacon": "off",
|
||||||
|
"eth_autoneg": "off",
|
||||||
|
"eth_in_flowctrl": "off",
|
||||||
|
"eth_out_flowctrl": "off",
|
||||||
|
"eth_mdix": "off",
|
||||||
|
"eth_swt_monitor": "off",
|
||||||
|
"eth_ethertype": "0x8100",
|
||||||
|
"eth_eee_state": "n/a",
|
||||||
|
"eth_link_flapped": "14week(s) 0day(s)",
|
||||||
|
"eth_clear_counters": "never",
|
||||||
|
"eth_reset_cntr": 1,
|
||||||
|
"eth_load_interval1_rx": 0,
|
||||||
|
"eth_inrate1_bits": 0,
|
||||||
|
"eth_inrate1_pkts": 0,
|
||||||
|
"eth_load_interval1_tx": 0,
|
||||||
|
"eth_outrate1_bits": 0,
|
||||||
|
"eth_outrate1_pkts": 0,
|
||||||
|
"eth_inrate1_summary_bits": "0 bps",
|
||||||
|
"eth_inrate1_summary_pkts": "0 pps",
|
||||||
|
"eth_outrate1_summary_bits": "0 bps",
|
||||||
|
"eth_outrate1_summary_pkts": "0 pps",
|
||||||
|
"eth_load_interval2_rx": 0,
|
||||||
|
"eth_inrate2_bits": 0,
|
||||||
|
"eth_inrate2_pkts": 0,
|
||||||
|
"eth_load_interval2_tx": 0,
|
||||||
|
"eth_outrate2_bits": 0,
|
||||||
|
"eth_outrate2_pkts": 0,
|
||||||
|
"eth_inrate2_summary_bits": "0 bps",
|
||||||
|
"eth_inrate2_summary_pkts": "0 pps",
|
||||||
|
"eth_outrate2_summary_bits": "0 bps",
|
||||||
|
"eth_outrate2_summary_pkts": "0 pps",
|
||||||
|
"eth_inucast": 0,
|
||||||
|
"eth_inmcast": 0,
|
||||||
|
"eth_inbcast": 0,
|
||||||
|
"eth_inpkts": 0,
|
||||||
|
"eth_inbytes": 0,
|
||||||
|
"eth_jumbo_inpkts": 0,
|
||||||
|
"eth_storm_supp": 0,
|
||||||
|
"eth_runts": 0,
|
||||||
|
"eth_giants": 0,
|
||||||
|
"eth_crc": 0,
|
||||||
|
"eth_nobuf": 0,
|
||||||
|
"eth_inerr": 0,
|
||||||
|
"eth_frame": 0,
|
||||||
|
"eth_overrun": 0,
|
||||||
|
"eth_underrun": 0,
|
||||||
|
"eth_ignored": 0,
|
||||||
|
"eth_watchdog": 0,
|
||||||
|
"eth_bad_eth": 0,
|
||||||
|
"eth_bad_proto": 0,
|
||||||
|
"eth_in_ifdown_drops": 0,
|
||||||
|
"eth_dribble": 0,
|
||||||
|
"eth_indiscard": 0,
|
||||||
|
"eth_inpause": 0,
|
||||||
|
"eth_outucast": 0,
|
||||||
|
"eth_outmcast": 0,
|
||||||
|
"eth_outbcast": 0,
|
||||||
|
"eth_outpkts": 0,
|
||||||
|
"eth_outbytes": 0,
|
||||||
|
"eth_jumbo_outpkts": 0,
|
||||||
|
"eth_outerr": 0,
|
||||||
|
"eth_coll": 0,
|
||||||
|
"eth_deferred": 0,
|
||||||
|
"eth_latecoll": 0,
|
||||||
|
"eth_lostcarrier": 0,
|
||||||
|
"eth_nocarrier": 0,
|
||||||
|
"eth_babbles": 0,
|
||||||
|
"eth_outdiscard": 0,
|
||||||
|
"eth_outpause": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,70 @@
|
||||||
|
{
|
||||||
|
"TABLE_vrf": {
|
||||||
|
"ROW_vrf": {
|
||||||
|
"vrf-name": "default",
|
||||||
|
"TABLE_iod": {
|
||||||
|
"ROW_iod": {
|
||||||
|
"if-name": "Ethernet2/1",
|
||||||
|
"if-status": "protocol-up/link-up/admin-up",
|
||||||
|
"if-addr-summary": "IP address: 10.0.0.45, IP subnet: 10.0.0.44/30",
|
||||||
|
"pim-dr-address": "10.0.0.45",
|
||||||
|
"dr-priority": 1,
|
||||||
|
"nbr-cnt": 0,
|
||||||
|
"hello-interval-sec": 30,
|
||||||
|
"hello-timer": "PT3S",
|
||||||
|
"holdtime-sec": 105,
|
||||||
|
"if-conf-dr-priority": 1,
|
||||||
|
"if-conf-delay": 3,
|
||||||
|
"is-border": "false",
|
||||||
|
"genid": "38c4b959",
|
||||||
|
"isauth-config": "false",
|
||||||
|
"nbr-policy-name": "none configured",
|
||||||
|
"jp-in-policy-name": "JPIN",
|
||||||
|
"jp-out-policy-name": "JPOUT",
|
||||||
|
"jp-interval": 1,
|
||||||
|
"jp-next-send": 1,
|
||||||
|
"pim-bfd-enabled": "no",
|
||||||
|
"is-passive": "false",
|
||||||
|
"is-pim-vpc-svi": "no",
|
||||||
|
"is-auto-enabled": "no",
|
||||||
|
"last-cleared": "PT0S",
|
||||||
|
"hello-sent": 23,
|
||||||
|
"hello-rcvd": 0,
|
||||||
|
"hello-early-sent": 0,
|
||||||
|
"jp-sent": 0,
|
||||||
|
"jp-rcvd": 0,
|
||||||
|
"assert-sent": 0,
|
||||||
|
"assert-rcvd": 0,
|
||||||
|
"graft-sent": 0,
|
||||||
|
"graft-rcvd": 0,
|
||||||
|
"graft-ack-sent": 0,
|
||||||
|
"graft-ack-rcvd": 0,
|
||||||
|
"df-offer-sent": 0,
|
||||||
|
"df-offer-rcvd": 0,
|
||||||
|
"df-winner-sent": 0,
|
||||||
|
"df-winner-rcvd": 0,
|
||||||
|
"df-backoff-sent": 0,
|
||||||
|
"df-backoff-rcvd": 0,
|
||||||
|
"pass-sent": 0,
|
||||||
|
"pass-rcvd": 0,
|
||||||
|
"cksum-errors": 0,
|
||||||
|
"invalid-errors": 0,
|
||||||
|
"invalid-df-errors": 0,
|
||||||
|
"auth-failed": 0,
|
||||||
|
"pak-len-errors": 0,
|
||||||
|
"ver-errors": 0,
|
||||||
|
"pkts-self": 0,
|
||||||
|
"pkts-non-nbr": 0,
|
||||||
|
"pkts-on-passive": 0,
|
||||||
|
"jp-rcvd-on-rpf": 0,
|
||||||
|
"jp-rcvd-no-rp": 0,
|
||||||
|
"jp-rcvd-wrong-rp": 0,
|
||||||
|
"jp-rcvd-for-ssm": 0,
|
||||||
|
"jp-rcvd-for-bidir": 0,
|
||||||
|
"jp-in-policy-filter": 0,
|
||||||
|
"jp-out-policy-filter": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
86
test/units/modules/network/nxos/test_nxos_pim_interface.py
Normal file
86
test/units/modules/network/nxos/test_nxos_pim_interface.py
Normal file
|
@ -0,0 +1,86 @@
|
||||||
|
# (c) 2016 Red Hat Inc.
|
||||||
|
#
|
||||||
|
# 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/>.
|
||||||
|
|
||||||
|
# Make coding more python3-ish
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
from ansible.compat.tests.mock import patch
|
||||||
|
from ansible.modules.network.nxos import nxos_pim_interface
|
||||||
|
from .nxos_module import TestNxosModule, load_fixture, set_module_args
|
||||||
|
|
||||||
|
|
||||||
|
class TestNxosIPInterfaceModule(TestNxosModule):
|
||||||
|
|
||||||
|
module = nxos_pim_interface
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.mock_load_config = patch('ansible.modules.network.nxos.nxos_pim_interface.load_config')
|
||||||
|
self.load_config = self.mock_load_config.start()
|
||||||
|
|
||||||
|
self.mock_run_commands = patch('ansible.modules.network.nxos.nxos_pim_interface.run_commands')
|
||||||
|
self.run_commands = self.mock_run_commands.start()
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.mock_load_config.stop()
|
||||||
|
self.mock_run_commands.stop()
|
||||||
|
|
||||||
|
def load_fixtures(self, commands=None, device=''):
|
||||||
|
module_name = self.module.__name__.rsplit('.', 1)[1]
|
||||||
|
|
||||||
|
def load_from_file(*args, **kwargs):
|
||||||
|
module, commands = args
|
||||||
|
output = list()
|
||||||
|
|
||||||
|
for command in commands:
|
||||||
|
filename = str(command).split(' | ')[0].replace(' ', '_').replace('/', '_')
|
||||||
|
output.append(load_fixture(module_name, filename))
|
||||||
|
return output
|
||||||
|
|
||||||
|
self.load_config.return_value = None
|
||||||
|
self.run_commands.side_effect = load_from_file
|
||||||
|
|
||||||
|
def test_nxos_pim_interface_present(self):
|
||||||
|
set_module_args(dict(interface='eth2/1', dr_prio=10, hello_interval=40))
|
||||||
|
self.execute_module(
|
||||||
|
changed=True,
|
||||||
|
commands=['interface eth2/1', 'ip pim dr-priority 10',
|
||||||
|
'ip pim hello-interval 40000', 'ip pim sparse-mode']
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_nxos_pim_interface_jp(self):
|
||||||
|
set_module_args(dict(
|
||||||
|
interface='eth2/1', jp_policy_in='JPIN', jp_policy_out='JPOUT',
|
||||||
|
jp_type_in='routemap', jp_type_out='routemap',
|
||||||
|
))
|
||||||
|
self.execute_module(
|
||||||
|
changed=True,
|
||||||
|
commands=['interface eth2/1', 'ip pim jp-policy JPOUT out',
|
||||||
|
'ip pim jp-policy JPIN in', 'ip pim sparse-mode']
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_nxos_pim_interface_default(self):
|
||||||
|
set_module_args(dict(interface='eth2/1', state='default'))
|
||||||
|
self.execute_module(
|
||||||
|
changed=True,
|
||||||
|
commands=['interface eth2/1', 'ip pim dr-priority 1',
|
||||||
|
'no ip pim border', 'ip pim hello-interval 30000']
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_nxos_pim_interface_ip_absent(self):
|
||||||
|
set_module_args(dict(interface='eth2/1', state='absent'))
|
||||||
|
self.execute_module(changed=False, commands=[])
|
Loading…
Reference in a new issue