UnrealIRCd BanInstall

Summary

Add a new server ban exception (E-line) on an UnrealIRCd server specifying the ban mask, type, and optional parameters such as reason, duration, and who set the ban.

Inputs

• Ban Name/Mask (required) — The ban mask or name used to specify which clients the ban exception applies to.
• Ban Type (required) — The type of ban exception to add (G-line, K-line, Z-line, or Q-line).
• Ban Options — Optional details for the ban exception including reason for the ban, ban duration (e.g. '1h', '1d', '1w'), and the identity of who set the ban.
• Redaction Options — Options to redact sensitive data in the response, including whether to redact IP addresses and other sensitive information.

Output shape

a single item with keys 'resource', 'operation', 'success', and 'result'

The 'result' field contains the response from the server confirming the added ban exception. The output includes success status and any data returned by the server RPC call.

Examples

Example 1: Add a server ban exception with a mask and type, including a reason and duration

Set 'Ban Name/Mask' to '@.example.com', 'Ban Type' to 'gline', provide a reason like 'Trusted admin IP', and duration '1d'.