FirewallGroup

An OPNsense firewall interface group (Firewall > Groups; model ifgroups/ifgroupentry). Keyed by the server-assigned FirewallGroupId (the searchItem row uuid).

public record FirewallGroup : IEquatable<FirewallGroup>

1. Constructors

1.1. FirewallGroup(FirewallGroupId, string, string, int, bool, string)

An OPNsense firewall interface group (Firewall > Groups; model ifgroups/ifgroupentry). Keyed by the server-assigned FirewallGroupId (the searchItem row uuid).

public FirewallGroup(FirewallGroupId Id, string IfName, string Members, int Sequence = 0, bool NoGroup = false, string Description = null)
Table 1. Parameters
Name Type Description

Id

FirewallGroupId

Server identity (row uuid). Empty on a not-yet-persisted group.

IfName

string

Unique group name (the OPNsense ifname).

Members

string

Member interfaces as the OPNsense comma-separated string (wire format); CSV keeps record value-equality.

Sequence

int

Sort order (0-9999).

NoGroup

bool

When true, the group is hidden from the Groups rules tab.

Description

string

Optional description.

2. Properties

2.1. Description

Optional description.

public string Description { get; init; }

2.2. Id

Server identity (row uuid). Empty on a not-yet-persisted group.

public FirewallGroupId Id { get; init; }

2.3. IfName

Unique group name (the OPNsense ifname).

public string IfName { get; init; }

2.4. Members

Member interfaces as the OPNsense comma-separated string (wire format); CSV keeps record value-equality.

public string Members { get; init; }

2.5. NoGroup

When true, the group is hidden from the Groups rules tab.

public bool NoGroup { get; init; }

2.6. Sequence

Sort order (0-9999).

public int Sequence { get; init; }

3. Operators

3.1. operator !=(FirewallGroup, FirewallGroup)

public static bool operator !=(FirewallGroup left, FirewallGroup right)
Table 2. Parameters
Name Type Description

left

FirewallGroup

right

FirewallGroup

Returns: bool

3.2. operator ==(FirewallGroup, FirewallGroup)

public static bool operator ==(FirewallGroup left, FirewallGroup right)
Table 3. Parameters
Name Type Description

left

FirewallGroup

right

FirewallGroup

Returns: bool