About

This is a simple PowerShell command to parse NSX firewall rules.

Execution

Use PowerShell commandlet Parse-NSXRules.ps1 to parse NSX XML export or connect to the NSX Manager and collect firewall rules.

Parse-NSXRules.ps1 -FilePath <string> [-ResultPath <string>] [-Property <string>] [-Format <string>]

Parameters:

• -ResultPath <string> - (mandatory) Specify path to export results to the file.
• -FilePath <string> - (optional) Specify path to the XML file.
• -Property <string> - (optional) Select properties to display, separated by commas.
• -Format <string> - (optional) Specify the report format. Supported values are: CSV, HTML or XML. By default data is saved in the HTML format.
• -NSXManager <string> - (optional) Specify the NSX Manager IP or DNS name.
• -Username <string> - (optional) Specify the NSX Manager username.
• -Password <string> - (optional) Specify the NSX Manager password.

Examples:

#Parse XML file and export result as a HTML file

.\parse-nsxrules.ps1 -FilePath C:\Temp\NSX_rules.xml -Format HTML -ResultPath C:\Temp\parsed_rules.html

#Parse XML file and export result as a CSV file, select only id,name,source and action columns

.\parse-nsxrules.ps1 -FilePath C:\Temp\NSX_rules.xml -Format CSV -ResultPath C:\Temp\parsed_rules.csv -Property "id,name,source,action"

#Connect to the NSX Manager, collect firewall rules and save result in XML format

.\parse-nsxrules.ps1 -Format XML -ResultPath C:\Temp\parsed_rules.xml -NSXManager 192.168.1.10 -Username admin -Password VMware1!

Releases

v1.0 - Initial release.

Known issues

1. Current version does not parse L2 firewall rules.

Licensing

The MIT License

Copyright 2018 https://blog.vmpress.org

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.