Home
Help
Search
Login
Register
OPNsense Forum
»
Archive
»
22.7 Legacy Series
»
[SOLVED] Using System "Aliases" in API Created Firewall Rules
« previous
next »
Print
Pages: [
1
]
Author
Topic: [SOLVED] Using System "Aliases" in API Created Firewall Rules (Read 1285 times)
utkonos
Newbie
Posts: 32
Karma: 3
[SOLVED] Using System "Aliases" in API Created Firewall Rules
«
on:
October 11, 2022, 09:22:19 pm »
I am trying to create firewall rules via API. I am able to create rules using CIDR, but the system aliases like "OPT1 net" or "WireGuard (Group)" or "WireGuard (Group) net" in the source_net or destination_net fields in the POST'ed JSON. Also, I'm unable to refer to the interface "WireGuard (Group)" in the interface field.
Are these strings usable in the API at all?
On a side note, when the rule is created (using CIDR and interface ID), and you look in the web console listing of "Automatically generated rules", the created rule appears to be wide open with "*" in every column on that view. However, when editing that same rule as listed under "Automation -> Filter", everything looks correct.
Is the web UI not able to display the details of the rule correctly? Or is showing all "*" in each column by design and the expected way for the rule to be displayed?
«
Last Edit: October 12, 2022, 12:02:06 am by utkonos
»
Logged
utkonos
Newbie
Posts: 32
Karma: 3
Re: Using System "Aliases" in API Created Firewall Rules
«
Reply #1 on:
October 11, 2022, 11:50:52 pm »
I figured out part of the answer to the first question:
"WireGuard (Group)" when referring to it via API is called "wireguard". I'm not sure if any other plugins work in the same way, but the string that the API needs is found in the config.xml section for the interface in the "if" field:
<if>wireguard</if>
Logged
utkonos
Newbie
Posts: 32
Karma: 3
Re: Using System "Aliases" in API Created Firewall Rules
«
Reply #2 on:
October 12, 2022, 12:01:27 am »
And the rest of the answer to the first question: strings like "WireGuard (Group) net" and "OPT1 net" are from the descriptions and are used in the GUI to display these nets. To refer to these same entities in the API, the string to use is found in the "Name" field in the alias listings. They are listed as type "Internal (automatic)". So, the following are the translation for the two I listed with my question:
"OPT1 net" -> "__opt1_network"
"WireGuard (Group) net" -> "__wireguard_network"
and so on. As for the second question: meh. It's probably by design and is just cosmetic so it doesn't matter if it displays the correct information.
Logged
franco
Administrator
Hero Member
Posts: 17661
Karma: 1611
Re: [SOLVED] Using System "Aliases" in API Created Firewall Rules
«
Reply #3 on:
October 12, 2022, 09:35:54 am »
I think that traditionally the values are without the "__" underscores so that these values are directly used, not redirected over the alias which was created later for visibility (and that's why it has a double underscore to avoid clashing with existing ones).
Cheers,
Franco
Logged
Print
Pages: [
1
]
« previous
next »
OPNsense Forum
»
Archive
»
22.7 Legacy Series
»
[SOLVED] Using System "Aliases" in API Created Firewall Rules