pmg_who_object_add
Add an email, domain, IP, network, regex, or LDAP object to a PMG RuleDB 'who' object group. Dry-run by default; set confirm=True to apply immediately.
Instructions
MUTATION (LOW): add an object to a PMG RuleDB 'who' object group. Dry-run by default.
To create the group first use pmg_who_group_create; list its objects with pmg_who_group_objects. If the group is already attached to a rule, the new object affects mail matching immediately. confirm=True executes and returns {"status": "ok", "result": <PMG's raw API response>}.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ip | No | IP address to match; required when type_='ip'. | |
| cidr | No | CIDR network to match; required when type_='network'. | |
| mode | No | LDAP lookup mode; used when type_='ldap'. | |
| No | Email address to match; required when type_='email'. | ||
| group | No | LDAP group name; used when type_='ldap'. | |
| regex | No | Regex pattern to match; required when type_='regex'. | |
| type_ | Yes | Object type: email|domain|regex|ip|network|ldap — selects which sub-path/fields apply. | |
| domain | No | Domain to match; required when type_='domain'. | |
| ogroup | Yes | Numeric 'who' object group ID (e.g. '2') from pmg_who_groups_list. | |
| confirm | No | False (default) returns a dry-run PLAN; True executes the mutation. | |
| profile | No | LDAP profile name; used when type_='ldap'. | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |