// Module included in the following assemblies:
//
// * installing/install_config/configuring-firewall.adoc

:_mod-docs-content-type: REFERENCE
[id="commatrix-plugin-reference_{context}"]
= Reference flags for the `commatrix` plugin

[role="_abstract"]
The following table describes the flags for the `commatrix` plugin.

[cols="2,1,3", options="header"]
|===
|Flag |Type |Description

|`--customEntriesFormat` |string |Define the format of a custom entries file. The plugin appends the entries in this file to the generated data. Supported values are `json`, `yaml`, or `csv`.

|`--customEntriesPath` |string |Define the file path to a custom entries file. The plugin appends the entries in this file to the generated data.

|`--debug` |boolean |Enable verbose logging for debugging. The default value is `false`.

|`--destDir` |string |Define the directory for output files. The default value is `communication-matrix`.

|`--custom-node-group` |string |Assign nodes matching a label selector to a custom group for separate firewall rule generation. Specify in `<group_name>=<label_selector>` format. You can specify this flag multiple times to define multiple custom groups. This flag applies only to `nft`, `butane`, and `mc` output formats. A `MachineConfigPool` custom group matching the custom group name must exist before you apply the generated `MachineConfig` resources.

|`--format` |string |Define the output format. Supported values are `json`, `yaml`, `csv`, `nft`, `butane`, or `mc`. The `butane` format generates Butane YAML configs containing nftables firewall rules. The `mc` format generates `MachineConfig` custom resources containing nftables firewall rules. The default value is `csv`.

|`--host-open-ports` |boolean |Generate the expected communication data for the cluster environment. Identify the actual open ports on the cluster node to compare the difference between the expected open ports and the actual open ports. You can view the differences in the generated `matrix-diff-ss` file in the destination directory. For `nft`, `butane`, and `mc` formats, host open ports are merged into the communication matrix instead of generating a separate diff file.

|`-h` |boolean |Display the plugin help information.
|===
