Add default gateway functionnality

[freeeflyer]

No description provided.

[freeeflyer]

Hi.
This PR adds the possibility to select the default gateway.

Here is my test playbook

#!/usr/bin/env ansible-playbook
- name: "pfSense test"
  hosts: pfsense


  tasks:
    - name: Debug coucou
      ansible.builtin.debug:
        msg: "test coucou"
      tags: never
        
  ############# READ
    - name: Read default GW 1
      pfsensible.core.pfsense_default_gateway:
        state: "read"
      register: out

    - name: Show default GW 1
      ansible.builtin.debug:
        msg: "defaultgw4:  {{ out.defaultgw4 }} |  defaultgw6:  {{ out.defaultgw6 }} |  debug:  {{ out.debug }}"

  ############# REMOVE
    - name: Remove default GW
      pfsensible.core.pfsense_default_gateway:
        state: "absent"
      register: out

    - name: Show output of remove GW 
      ansible.builtin.debug:
        var: out.commands

    - name: Read default GW 2
      pfsensible.core.pfsense_default_gateway:
        state: "read"
      register: out

    - name: Show default GW 2
      ansible.builtin.debug:
        msg: |
          defaultgw4:  {{ out.defaultgw4 }}
          defaultgw6:  {{ out.defaultgw6 }}

    - name: Pause
      ansible.builtin.pause:
        prompt: "Press enter to continue"

  ############# AUTOMATIC
    - name: Set default GW to Automatic
      pfsensible.core.pfsense_default_gateway:
        state: "present"
        name: "Automatic"

    - name: Read default GW 3
      pfsensible.core.pfsense_default_gateway:
        state: "read"
      register: out

    - name: Show default GW 3
      ansible.builtin.debug:
        msg: |
          defaultgw4:  {{ out.defaultgw4 }}
          defaultgw6:  {{ out.defaultgw6 }}

    - name: Pause
      ansible.builtin.pause:
        prompt: "Press enter to continue"

  ############# INTERNET_GW
    - name: Set default GW to INTERNET_GW
      pfsensible.core.pfsense_default_gateway:
        state: "present"
        name: "INTERNET_GW"
      register: out

    - name: Show output of set GW 
      ansible.builtin.debug:
        var: out.commands

    - name: Read default GW 3
      pfsensible.core.pfsense_default_gateway:
        state: "read"
      register: out

    - name: Show default GW 3
      ansible.builtin.debug:
        msg: |
          defaultgw4:  {{ out.defaultgw4 }}
          defaultgw6:  {{ out.defaultgw6 }}

    - name: Pause
      ansible.builtin.pause:
        prompt: "Press enter to continue"

  ############# Bogus gateway should fail
    - name: Set default GW to Bogus
      pfsensible.core.pfsense_default_gateway:
        state: "present"
        name: "BOGUS_GW"

I hope it helps.

Regards;

Nicolas

[opoplawski]

Thanks for the submission. Can you address the test failures and other review comments. Thanks.

[freeeflyer]

Sorry for the mistakes.. I don't PR often..

[opoplawski]

Sorry for the mistakes.. I don't PR often..

No need to apologize, everyone has to start somewhere. Thank you for working on this.

[opoplawski]

So, read is new, and not something I've seen used in ansible modules before. Can you point to any similar usage?

I'm also leaning more towards simply dropping state altogether and just using the None option to express that.

Finally, we generally go with lowercase options so lets use automatic and none.

[freeeflyer]

I wanted that too.. but what to do if you just want the current default gateway ?
Also I have to rework my code. I just realized there was an issue with dynamic gateways..

[opoplawski]

But that's just not really how ansible works. You declare the state that you want. If you don't want to change anything, don't use this task.

[freeeflyer]

So if I get it right..

• No more "state"
• just "name" with "none" for absent
• no read
• lowercase

I could implement the fact that it accepts no option at all and return both v4 and v6 default gateway..

I implemented a find_default_gateway method because I needed it.. I feel it would be better placed in the pfsense class .. thus I did it.

Ok done !

[opoplawski]

The checks also found some trailing whitespace to clean up. Otherwise I think we are close. Thanks for working on this.

[opoplawski]

Looks good. I have a couple fixes to add and then I'll merge. Thanks.

[freeeflyer]

Hello. Thanks.
What will you fix ? I'm curious :)
Happy new year !

[opoplawski]

Change "inet4" to "inet" and remove the unused debug return.