Feature: path monitoring route

[kevinhuy]

Feature / Add ability to enable Path Monitoring in Virtual Router -> Static Route

Enabled the check box "Path Monitoring" under Virtual Router -> Static Route

This is done by adding 3 new params in the existing class StaticRoute.

Add "Path Monitoring Destination" under Virtual Router -> Static Route -> Path Monitoring

This is done by creating an new class PathMonitorDestination in network.py

Motivation and Context

Adds a new functionality.

How Has This Been Tested?

This has been tested in a physical firewall 5220 version 9.0.10 with python 3.6
The python script that i used for the test.

fw = firewall.Firewall(HOSTNAME, USERNAME, api_key=KEY)

router = fw.add(network.VirtualRouter(name='VR2'))

static_route = {
    'name': 'route2',
    'destination': '1.1.1.1/32',
    'nexthop_type': 'ip-address',
    'nexthop': '169.254.255.103',
'enable_path_monitor': True,
'failure_condition' : 'any',
'preemptive_holdtime' : 4
}

static = router.add(network.StaticRoute(**static_route))
static.create()

monitor_destination1 = {
'name': 'test',
'enable': True,
'source': '10.212.100.14/29',
'destination': '1.1.1.1'
}

monitor = static.add(network.PathMonitorDestination(**monitor_destination1))
monitor.create()

monitor_destination2 = {
    'name': 'test2',
    'enable': True,
    'source': '10.212.100.14/29',
    'destination': '2.2.2.2'
}

monitor2 = static.add(network.PathMonitorDestination(**monitor_destination2))
monitor2.create()

the result below.

              route2 {
                destination 1.1.1.1/32;
                nexthop {
                  ip-address 169.254.255.103;
                }
                metric 10;
                path-monitor {
                  enable yes;
                  failure-condition any;
                  hold-time 4;
                  monitor-destinations {
                    test {
                      enable yes;
                      source 10.212.100.14/29;
                      destination 1.1.1.1;
                      interval 3;
                      count 5;
                    }
                    test2 {
                      enable yes;
                      source 10.212.100.14/29;
                      destination 2.2.2.2;
                      interval 3;
                      count 5;
                    }
                  }
                }
              }
             }
           }

Types of changes

• New feature (non-breaking change which adds functionality)

Checklist

• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes if appropriate.
• All new and existing tests passed.

[welcome-to-palo-alto-networks]

🎉 Thanks for opening this pull request! We really appreciate contributors like you! 🙌

[shinmog]

Very nice!

Besides the comments I've given I have three other pieces of global feedback to give:

First is that all of your path= in the params start with a forward slash - that forward slash needs to be removed.

The second is that there's lots of empty lines between params. There are typically only empty lines between the start of param specification:

params = []

...and the end:

self._params = tuple(params)

The exception to this rule is when you're going to do programatic param initialization (read: looping), so the extra space is there to bring attention to this fact.

The final piece of feedback is that the path monitoring for IPv6 static routes seems to match this exactly. So could you also add your class as a CHILDTYPES to the StaticRouteV6 as well?

Solid work all around!

[shinmog]

Please change preemptive_holdtime to preemptive_hold_time (and in the docstring as well).

[shinmog]

Seems to be enable not enabled down below, just need to tweak this docstring.

[shinmog]

Just missing the (str) type in this docstring.

[kevinhuy]

@shinmog thanks a lots for your comment and tips, i will check and make the appropriate change 👍 have a good night :)

[kevinhuy]

Hi / Bonjour

@shinmog can you review the last change ? thanks

[shinmog]

lgtm!

[welcome-to-palo-alto-networks]

🎉 Congrats on getting your first pull request merged! We here at Palo Alto Networks are so grateful! ❤️