Update Group¶
The groups update command updates an existing group from inline parameters or a JSON file. Uses GROUP_ID if given, otherwise resolves by --name.
Modes¶
| Mode | When to Use |
|---|---|
| Inline | Quick field updates โ pass only the fields to change as CLI flags. |
File (--file) |
Bulk or complex updates โ provide a JSON file with fields to change. |
Both modes are mutually exclusive. If --file is provided, all inline parameters are ignored.
Parameters¶
Identification¶
| Parameter | Description |
|---|---|
GROUP_ID |
Group ID (optional positional). Omit to use --name resolution. |
--name, -n |
Group name โ used to look up the group ID when GROUP_ID is omitted. Can also update the name itself. |
File Mode¶
| Parameter | Description |
|---|---|
--file, -f |
JSON file with group updates. |
Inline Parameters (all optional โ only provided fields are updated)¶
| Parameter | Description |
|---|---|
--description, -d |
Group description. |
--active / --inactive |
Active status. |
--timezone, -z |
Timezone in IANA format. |
--trigger-times |
Comma-separated times in HH:MM format. Automatically deduplicated and sorted. |
--day-of-week |
7-character binary string for MTWTFSS (e.g. 1111100 = MonโFri). |
--ordinal-day |
Ordinal day description. |
--run-frequency |
Run frequency in HH:MM-HH:MM-freq format. |
--calendar |
Calendar name (must exist in the backend). |
--dependency |
Dependency string (e.g. S:groupname). |
--profile |
Profile name. |
Mutual Exclusivity
- Only one of
--trigger-timesor--run-frequencymay be provided (not both). - Only one of
--day-of-weekor--ordinal-daymay be provided (not both).
๐ฅ๏ธ Basic Usage¶
Usage: easytask groups update [OPTIONS] [GROUP_ID]
Update a group from inline parameters or a JSON file. Uses GROUP_ID if
given, otherwise looks up by name.
โญโ Arguments โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ group_id INTEGER Group ID (optional if using --name or --file) โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ --file -f PATH JSON file with group updates โ
โ --name -n TEXT Group name (also resolves ID if GROUP_ID โ
โ is omitted) โ
โ --description -d TEXT Group description โ
โ --active / --inactive Active status โ
โ --timezone -z TEXT Timezone โ
โ --trigger-times TEXT Comma-separated HH:MM โ
โ --day-of-week TEXT 7-char binary MTWTFSS โ
โ --ordinal-day TEXT Ordinal day โ
โ --run-frequency TEXT HH:MM-HH:MM-freq โ
โ --calendar TEXT Calendar name โ
โ --dependency TEXT Dependency string โ
โ --profile TEXT Profile name โ
โ --help -h Show this message and exit. โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
Inline Mode Examples¶
Update group description by ID¶
Update group trigger times (automatically sorted)¶
Update group by name resolution¶
When you don't know the group ID, use --name to look it up: