mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 13:52:54 +00:00
nxos_bfd_global / NxosCmdRef initial commit (#56317)
* nxos_bfd_global: initial commit This is an initial POC with just a few commands included. The code has been written somewhat generically so that it can act as a best practices template for re-use in future modules. The implementation follows the yaml cmd_ref style to define each command's getter/setter/type/default. It supports platform-specific defaults. The basic logic is to collect all relevant data in a `cmd_ref` dict and pass that around to various methods. In the BFD case the devices don't provide JSON output so we have to screen-scrape with show runs. BFD does not support present/absent states so there is no state param. BFD has three different property types to handle. We can add add'l types as needed: - int - int_list (list of ints) - str (needs support for 'no' keyword) * Use get_capabilities to find platform type * PR comment fixes, round 1 * Minor cleanups * nxos_bfd_global: create NxosCmdRef in module_utils This commit just takes the latest bfd global code and moves the bulk of the code into new `class NxosCmdRef` in `module_utils/nxos/nxos.py`. The only remaining code in `nxos_bfd_global.py` are the calls from `main()`. * Add remaining command properties and documentation * update argument_spec * Add check for _exclude; add sanity test * Add targets files for bfd * Context and state absent updates * Add dict support to cmd_ref * Changed remaining list commands to dict usage * Add idempotence check for dict * Fix existing overwrite bug * Move pattern matching logic into its own method * add support for 'command: absent' * Add `get_platform_shortname`; update BFD platform-specific settings * /absent/deleted/ * /sh/show/ in prepare_nxos_tests * add dict check to get_platform_shortname * Add normalize_defaults() * UTs for bfd_global * support yaml for both py2/py3 * update cmd_ref doc header * Fix python2.6 incompatibility with dict comprehensions * Fix bfd_global doc header (yaml syntax fail) * more shippable fixes * yet more shippable fixes * shippable: remove r' ' wrappers * docfix - remove ':' * escape regex ctl chars in yaml table * remove extra blank lines * Fix str(None) issue * Command context updates * import PY2,PY3 instead of import sys * fix ordereddict import & parent_context * try/except for yaml import * fix import issue for ordereddict * remove epdb * nxosCmdRef_import_check() workaround for shippable * fix PEP ws errors
This commit is contained in:
Chris Van Heuveln
committed by
Trishna Guha
Trishna Guha
parent
f65ac2cf23
commit
7aa0d26fda
315
lib/ansible/modules/network/nxos/nxos_bfd_global.py
Normal file
315
lib/ansible/modules/network/nxos/nxos_bfd_global.py
Normal file
@@ -0,0 +1,315 @@
|
||||
#!/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/>.
|
||||
#
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'network'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: nxos_bfd_global
|
||||
extends_documentation_fragment: nxos
|
||||
version_added: "2.9"
|
||||
short_description: Bidirectional Forwarding Detection (BFD) global-level configuration
|
||||
description:
|
||||
- Manages Bidirectional Forwarding Detection (BFD) global-level configuration.
|
||||
author:
|
||||
- Chris Van Heuveln (@chrisvanheuveln)
|
||||
notes:
|
||||
- Tested against NXOSv 9.2(2)
|
||||
- BFD global will automatically enable 'feature bfd' if it is disabled.
|
||||
- BFD global does not have a 'state' parameter. All of the BFD commands are unique and are defined if 'feature bfd' is enabled.
|
||||
options:
|
||||
# Top-level commands
|
||||
echo_interface:
|
||||
description:
|
||||
- Loopback interface used for echo frames.
|
||||
- Valid values are loopback interface name or 'deleted'.
|
||||
- Not supported on N5K/N6K
|
||||
required: false
|
||||
type: str
|
||||
echo_rx_interval:
|
||||
description:
|
||||
- BFD Echo receive interval in milliseconds.
|
||||
required: false
|
||||
type: int
|
||||
interval:
|
||||
description:
|
||||
- BFD interval timer values.
|
||||
- Value must be a dict defining values for keys (tx, min_rx, and multiplier)
|
||||
required: false
|
||||
type: dict
|
||||
slow_timer:
|
||||
description:
|
||||
- BFD slow rate timer in milliseconds.
|
||||
required: false
|
||||
type: int
|
||||
startup_timer:
|
||||
description:
|
||||
- BFD delayed startup timer in seconds.
|
||||
- Not supported on N5K/N6K/N7K
|
||||
required: false
|
||||
type: int
|
||||
|
||||
# IPv4/IPv6 specific commands
|
||||
ipv4_echo_rx_interval:
|
||||
description:
|
||||
- BFD IPv4 session echo receive interval in milliseconds.
|
||||
required: false
|
||||
type: int
|
||||
ipv4_interval:
|
||||
description:
|
||||
- BFD IPv4 interval timer values.
|
||||
- Value must be a dict defining values for keys (tx, min_rx, and multiplier).
|
||||
required: false
|
||||
type: dict
|
||||
ipv4_slow_timer:
|
||||
description:
|
||||
- BFD IPv4 slow rate timer in milliseconds.
|
||||
required: false
|
||||
type: int
|
||||
ipv6_echo_rx_interval:
|
||||
description:
|
||||
- BFD IPv6 session echo receive interval in milliseconds.
|
||||
required: false
|
||||
type: int
|
||||
ipv6_interval:
|
||||
description:
|
||||
- BFD IPv6 interval timer values.
|
||||
- Value must be a dict defining values for keys (tx, min_rx, and multiplier).
|
||||
required: false
|
||||
type: dict
|
||||
ipv6_slow_timer:
|
||||
description:
|
||||
- BFD IPv6 slow rate timer in milliseconds.
|
||||
required: false
|
||||
type: int
|
||||
|
||||
# Fabricpath commands
|
||||
fabricpath_interval:
|
||||
description:
|
||||
- BFD fabricpath interval timer values.
|
||||
- Value must be a dict defining values for keys (tx, min_rx, and multiplier).
|
||||
required: false
|
||||
type: dict
|
||||
fabricpath_slow_timer:
|
||||
description:
|
||||
- BFD fabricpath slow rate timer in milliseconds.
|
||||
required: false
|
||||
type: int
|
||||
fabricpath_vlan:
|
||||
description:
|
||||
- BFD fabricpath control vlan.
|
||||
required: false
|
||||
type: int
|
||||
|
||||
'''
|
||||
EXAMPLES = '''
|
||||
- nxos_bfd_global:
|
||||
echo_interface: Ethernet1/2
|
||||
echo_rx_interval: 50
|
||||
interval:
|
||||
tx: 50
|
||||
min_rx: 50
|
||||
multiplier: 4
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
cmds:
|
||||
description: commands sent to the device
|
||||
returned: always
|
||||
type: list
|
||||
sample: ["bfd echo-interface loopback1", "bfd slow-timer 2000"]
|
||||
'''
|
||||
|
||||
|
||||
import re
|
||||
from ansible.module_utils.network.nxos.nxos import NxosCmdRef
|
||||
from ansible.module_utils.network.nxos.nxos import nxos_argument_spec, check_args
|
||||
from ansible.module_utils.network.nxos.nxos import load_config, run_commands
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.network.common.config import CustomNetworkConfig
|
||||
|
||||
BFD_CMD_REF = """
|
||||
# The cmd_ref is a yaml formatted list of module commands.
|
||||
# A leading underscore denotes a non-command variable; e.g. _template.
|
||||
# BFD does not have convenient json data so this cmd_ref uses raw cli configs.
|
||||
---
|
||||
_template: # _template holds common settings for all commands
|
||||
# Enable feature bfd if disabled
|
||||
feature: bfd
|
||||
# Common get syntax for BFD commands
|
||||
get_command: show run bfd all | incl '^(no )*bfd'
|
||||
|
||||
echo_interface:
|
||||
kind: str
|
||||
getval: (no )*bfd echo-interface *(\\S+)*$
|
||||
setval: 'bfd echo-interface {0}'
|
||||
default: ~
|
||||
|
||||
echo_rx_interval:
|
||||
_exclude: ['N5K', 'N6K']
|
||||
kind: int
|
||||
getval: bfd echo-rx-interval (\\d+)$
|
||||
setval: bfd echo-rx-interval {0}
|
||||
default: 50
|
||||
N3K:
|
||||
default: 250
|
||||
|
||||
interval:
|
||||
kind: dict
|
||||
getval: bfd interval (?P<tx>\\d+) min_rx (?P<min_rx>\\d+) multiplier (?P<multiplier>\\d+)
|
||||
setval: bfd interval {tx} min_rx {min_rx} multiplier {multiplier}
|
||||
default: &def_interval
|
||||
tx: 50
|
||||
min_rx: 50
|
||||
multiplier: 3
|
||||
N3K:
|
||||
default: &n3k_def_interval
|
||||
tx: 250
|
||||
min_rx: 250
|
||||
multiplier: 3
|
||||
|
||||
slow_timer:
|
||||
kind: int
|
||||
getval: bfd slow-timer (\\d+)$
|
||||
setval: bfd slow-timer {0}
|
||||
default: 2000
|
||||
|
||||
startup_timer:
|
||||
_exclude: ['N5K', 'N6K', 'N7K']
|
||||
kind: int
|
||||
getval: bfd startup-timer (\\d+)$
|
||||
setval: bfd startup-timer {0}
|
||||
default: 5
|
||||
|
||||
# IPv4/IPv6 specific commands
|
||||
ipv4_echo_rx_interval:
|
||||
_exclude: ['N5K', 'N6K']
|
||||
kind: int
|
||||
getval: bfd ipv4 echo-rx-interval (\\d+)$
|
||||
setval: bfd ipv4 echo-rx-interval {0}
|
||||
default: 50
|
||||
N3K:
|
||||
default: 250
|
||||
|
||||
ipv4_interval:
|
||||
_exclude: ['N5K', 'N6K']
|
||||
kind: dict
|
||||
getval: bfd ipv4 interval (?P<tx>\\d+) min_rx (?P<min_rx>\\d+) multiplier (?P<multiplier>\\d+)
|
||||
setval: bfd ipv4 interval {tx} min_rx {min_rx} multiplier {multiplier}
|
||||
default: *def_interval
|
||||
N3K:
|
||||
default: *n3k_def_interval
|
||||
|
||||
ipv4_slow_timer:
|
||||
_exclude: ['N5K', 'N6K']
|
||||
kind: int
|
||||
getval: bfd ipv4 slow-timer (\\d+)$
|
||||
setval: bfd ipv4 slow-timer {0}
|
||||
default: 2000
|
||||
|
||||
ipv6_echo_rx_interval:
|
||||
_exclude: ['N35', 'N5K', 'N6K']
|
||||
kind: int
|
||||
getval: bfd ipv6 echo-rx-interval (\\d+)$
|
||||
setval: bfd ipv6 echo-rx-interval {0}
|
||||
default: 50
|
||||
N3K:
|
||||
default: 250
|
||||
|
||||
ipv6_interval:
|
||||
_exclude: ['N35', 'N5K', 'N6K']
|
||||
kind: dict
|
||||
getval: bfd ipv6 interval (?P<tx>\\d+) min_rx (?P<min_rx>\\d+) multiplier (?P<multiplier>\\d+)
|
||||
setval: bfd ipv6 interval {tx} min_rx {min_rx} multiplier {multiplier}
|
||||
default: *def_interval
|
||||
N3K:
|
||||
default: *n3k_def_interval
|
||||
|
||||
ipv6_slow_timer:
|
||||
_exclude: ['N35', 'N5K', 'N6K']
|
||||
kind: int
|
||||
getval: bfd ipv6 slow-timer (\\d+)$
|
||||
setval: bfd ipv6 slow-timer {0}
|
||||
default: 2000
|
||||
|
||||
# Fabricpath Commands
|
||||
fabricpath_interval:
|
||||
_exclude: ['N35', 'N3K', 'N9K']
|
||||
kind: dict
|
||||
getval: bfd fabricpath interval (?P<tx>\\d+) min_rx (?P<min_rx>\\d+) multiplier (?P<multiplier>\\d+)
|
||||
setval: bfd fabricpath interval {tx} min_rx {min_rx} multiplier {multiplier}
|
||||
default: *def_interval
|
||||
|
||||
fabricpath_slow_timer:
|
||||
_exclude: ['N35', 'N3K', 'N9K']
|
||||
kind: int
|
||||
getval: bfd fabricpath slow-timer (\\d+)$
|
||||
setval: bfd fabricpath slow-timer {0}
|
||||
default: 2000
|
||||
|
||||
fabricpath_vlan:
|
||||
_exclude: ['N35', 'N3K', 'N9K']
|
||||
kind: int
|
||||
getval: bfd fabricpath vlan (\\d+)$
|
||||
setval: bfd fabricpath vlan {0}
|
||||
default: 1
|
||||
"""
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = dict(
|
||||
echo_interface=dict(required=False, type='str'),
|
||||
echo_rx_interval=dict(required=False, type='int'),
|
||||
interval=dict(required=False, type='dict'),
|
||||
slow_timer=dict(required=False, type='int'),
|
||||
startup_timer=dict(required=False, type='int'),
|
||||
ipv4_echo_rx_interval=dict(required=False, type='int'),
|
||||
ipv4_interval=dict(required=False, type='dict'),
|
||||
ipv4_slow_timer=dict(required=False, type='int'),
|
||||
ipv6_echo_rx_interval=dict(required=False, type='int'),
|
||||
ipv6_interval=dict(required=False, type='dict'),
|
||||
ipv6_slow_timer=dict(required=False, type='int'),
|
||||
fabricpath_interval=dict(required=False, type='dict'),
|
||||
fabricpath_slow_timer=dict(required=False, type='int'),
|
||||
fabricpath_vlan=dict(required=False, type='int'),
|
||||
)
|
||||
argument_spec.update(nxos_argument_spec)
|
||||
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
|
||||
warnings = list()
|
||||
check_args(module, warnings)
|
||||
|
||||
cmd_ref = NxosCmdRef(module, BFD_CMD_REF)
|
||||
cmd_ref.get_existing()
|
||||
cmd_ref.get_playvals()
|
||||
cmds = cmd_ref.get_proposed()
|
||||
|
||||
result = {'changed': False, 'commands': cmds, 'warnings': warnings,
|
||||
'check_mode': module.check_mode}
|
||||
if cmds:
|
||||
result['changed'] = True
|
||||
if not module.check_mode:
|
||||
load_config(module, cmds)
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Reference in New Issue
Block a user