uip tm schedules

Syntax and options for `uip tm schedules`, which creates, lists, updates, switches on and off, and deletes recurring test set schedules, and reports when each one runs next.

uip tm schedules manages test set schedules in a Test Manager project. A schedule runs a test set on a cadence defined by a cron expression with a seconds field, read in an IANA time zone, together with a JSON recurrence detail. Each scheduled run produces a test set execution that you inspect with uip tm executions.

There is no get verb. list is the only read, and the place to recover the fields that update needs passed back. StartTime and DisableTime are wall-clock times in the schedule's Timezone; NextRun from next-runs is a UTC instant.

Writing a schedule needs the Test Manager automated-execution permission. Selecting schedules by name, selecting several, or passing --all also reads the schedule list, which needs TestSet.Read.

Sinopsis

uip tm schedules list [--project-key <key> | --project-id <id>] [--enabled | --disabled] [--recurrence <type>] [--search <text>] [--sort-by <expression>] [--test-set-key <key> | --test-set-id <uuid>] [--limit <number>] [--offset <number>]
uip tm schedules create (--test-set-key <key> | --test-set-id <uuid>) --name <text> --cron <expression> --cron-details <json> --timezone <tz> --start-time <wall-clock> [--project-key <key> | --project-id <id>] [--description <text>] [--disable-time <wall-clock>] [--recurrence <type>] [--disabled]
uip tm schedules update --schedule-id <uuid> (--test-set-key <key> | --test-set-id <uuid>) --name <text> --cron <expression> --cron-details <json> --timezone <tz> --start-time <wall-clock> [--project-key <key> | --project-id <id>] [--description <text>] [--disable-time <wall-clock>] [--recurrence <type>]
uip tm schedules enable (--project-key <key> | --project-id <id>) (--schedule-ids <uuid...> | --all --yes)
uip tm schedules disable (--project-key <key> | --project-id <id>) (--schedule-ids <uuid...> | --all --yes)
uip tm schedules delete (--project-key <key> | --project-id <id>) (--schedule-ids <uuid...> | --all) --yes
uip tm schedules next-runs (--project-key <key> | --project-id <id>) --schedule-ids <id-or-name...>

Todos los verbos respetan las opciones globales y los códigos de salida estándar.

uip tm schedules list

List the test set schedules in a project. The server has no test set filter, so --test-set-key and --test-set-id narrow the returned page after paging.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Test Manager project key. One of --project-key or --project-id is required unless --test-set-key is given, whose prefix supplies the project. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--enabled	Only schedules that are switched on. Mutually exclusive with --disabled.
--disabled	Only schedules that are switched off.
--recurrence <type>	Only schedules of this recurrence kind: single, recurrence, or advance.
--search <text>	Prefix match on the schedule name or description. nightly does not match Run nightly regression.
--sort-by <expression>	Sort as <field> asc or <field> desc. Fields: name, description, cronExpression, recurrenceType, timezone, startTime, disableTime, isEnabled, created, updated. Without it the server pages an unordered query, so --offset can repeat or skip rows; pass a sort when paging.
--test-set-key <key>	Keep only schedules for this test set, by key (for example, DEMO:42). Preferred over --test-set-id. Applied to the returned page, so widen --limit if a match is missing. Mutually exclusive with --test-set-id.
--test-set-id <uuid>	Keep only schedules for this test set, by UUID. Applied to the returned page, so widen --limit if a match is missing.
--limit <number>	Results per page. Defaults to 50.
--offset <number>	Resultados para omitir. El valor predeterminado es 0.

Ejemplo

uip tm schedules list \
  --project-key DEMO \
  --disabled \
  --recurrence single \
  --sort-by "created desc" \
  --limit 10

Forma de datos

{
  "Code": "ScheduleList",
  "Data": [
    {
      "Id": "b2c3d4e5-0000-0000-0000-000000000001",
      "ProjectId": "00000000-0000-0000-0000-000000000abc",
      "Name": "Nightly regression",
      "Description": "",
      "TestSetId": "a1b2c3d4-0000-0000-0000-000000000010",
      "CronExpression": "0 0 2 1/1 * ? *",
      "CronDetails": "{\"type\":4,\"daily\":{\"atHour\":2,\"atMinute\":0,\"frequencyIndays\":1}}",
      "RecurrenceType": "Recurrence",
      "Timezone": "Europe/Bucharest",
      "StartTime": "2030-01-01T00:00",
      "DisableTime": null,
      "IsEnabled": true,
      "TestSetName": "Regression pack",
      "BackgroundTaskScheduleId": "c3d4e5f6-0000-0000-0000-000000000099"
    }
  ]
}

Campos clave:

• Id: the schedule ID that update, enable, disable, delete, and next-runs take.
• StartTime, DisableTime: wall-clock times read in Timezone. DisableTime is null when the schedule has no end.
• BackgroundTaskScheduleId: a separate ID that Test Manager's scheduler uses. null when the schedule has no scheduler task. The verbs on this page do not accept it as a schedule ID.

uip tm schedules create

Schedule a test set to run on a cadence. The cadence is the --cron expression read in --timezone, with --cron-details carrying the matching recurrence JSON. The CLI checks the shape of the flag values below before it sends the request.

Argumentos

Nada.

Opciones

Marca	Descripción
--test-set-key <key>	Test set object key to run (for example, DEMO:42). Preferred over --test-set-id; its prefix also supplies the project, so --project-key and --project-id are optional. Exactly one of --test-set-key or --test-set-id is required.
--test-set-id <uuid>	Test set UUID to run. Needs --project-key or --project-id.
--name <text>	Required. Schedule name, up to 255 characters. A blank name is refused.
--cron <expression>	Required. Cron expression for the cadence: 6 or 7 space-separated fields starting with seconds, with ? in exactly one of day-of-month (field 4) or day-of-week (field 6). Daily at 02:00 is '0 0 2 1/1 * ? *'. A 5-field Unix expression is refused.
--cron-details <json>	Required. Recurrence detail as a JSON object of up to 255 characters, for example '{"type":4,"daily":{"atHour":15,"atMinute":0,"frequencyIndays":1}}'. Required for every recurrence type. With --recurrence recurrence and "type":4, daily.frequencyIndays must be 1.
--timezone <tz>	Required. IANA time zone the cron expression and the wall-clock times are read in (for example, Europe/Bucharest).
--start-time <wall-clock>	Required. When the schedule becomes active, as YYYY-MM-DDTHH:mm read in --timezone, with no seconds and no offset. Must be a real calendar date. Test Manager refuses a start time in the past, once --timezone is applied.
--disable-time <wall-clock>	When the schedule stops, in the same format as --start-time. Must not be before --start-time.
--description <text>	Schedule description, up to 4000 characters.
--recurrence <type>	Recurrence kind: single, recurrence, or advance. Defaults to recurrence.
--project-key <key>	Test Manager project key. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--disabled	Create the schedule switched off.

Ejemplo

uip tm schedules create \
  --test-set-key DEMO:42 \
  --name "Nightly regression" \
  --cron '0 0 2 1/1 * ? *' \
  --cron-details '{"type":4,"daily":{"atHour":2,"atMinute":0,"frequencyIndays":1}}' \
  --timezone Europe/Bucharest \
  --start-time 2030-01-01T00:00

Forma de datos

{
  "Code": "ScheduleCreate",
  "Data": {
    "Id": "b2c3d4e5-0000-0000-0000-000000000001",
    "ProjectId": "00000000-0000-0000-0000-000000000abc",
    "Name": "Nightly regression",
    "Description": "",
    "TestSetId": "a1b2c3d4-0000-0000-0000-000000000010",
    "CronExpression": "0 0 2 1/1 * ? *",
    "CronDetails": "{\"type\":4,\"daily\":{\"atHour\":2,\"atMinute\":0,\"frequencyIndays\":1}}",
    "RecurrenceType": "Recurrence",
    "Timezone": "Europe/Bucharest",
    "StartTime": "2030-01-01T00:00",
    "DisableTime": null,
    "IsEnabled": true,
    "Action": "Created"
  }
}

uip tm schedules update

Replace a schedule's definition. The request carries the whole schedule, so pass every flag you want kept: anything you omit reverts to its default. The enabled state is the exception. Test Manager keeps the stored state, and enable and disable switch it. Read the current values with list. The flag checks match create.

Argumentos

Nada.

Opciones

Marca	Descripción
--schedule-id <uuid>	Required. Schedule UUID to update.
--test-set-key <key>	Test set object key to run (for example, DEMO:42). Preferred over --test-set-id; its prefix also supplies the project, so --project-key and --project-id are optional. Exactly one of --test-set-key or --test-set-id is required.
--test-set-id <uuid>	Test set UUID to run. Needs --project-key or --project-id.
--name <text>	Required. Schedule name, up to 255 characters. A blank name is refused.
--cron <expression>	Required. Cron expression for the cadence: 6 or 7 space-separated fields starting with seconds, with ? in exactly one of day-of-month (field 4) or day-of-week (field 6). Daily at 02:00 is '0 0 2 1/1 * ? *'. A 5-field Unix expression is refused.
--cron-details <json>	Required. Recurrence detail as a JSON object of up to 255 characters. Required for every recurrence type. With --recurrence recurrence and "type":4, daily.frequencyIndays must be 1.
--timezone <tz>	Required. IANA time zone the cron expression and the wall-clock times are read in (for example, Europe/Bucharest).
--start-time <wall-clock>	Required. When the schedule becomes active, as YYYY-MM-DDTHH:mm read in --timezone, with no seconds and no offset. Must be a real calendar date.
--disable-time <wall-clock>	When the schedule stops, in the same format as --start-time. Must not be before --start-time.
--description <text>	Schedule description, up to 4000 characters.
--recurrence <type>	Recurrence kind: single, recurrence, or advance. Defaults to recurrence.
--project-key <key>	Test Manager project key. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.

Ejemplo

uip tm schedules update \
  --schedule-id b2c3d4e5-0000-0000-0000-000000000001 \
  --test-set-key DEMO:42 \
  --name "Nightly regression" \
  --description "Full regression suite" \
  --cron '0 0 3 1/1 * ? *' \
  --cron-details '{"type":4,"daily":{"atHour":3,"atMinute":0,"frequencyIndays":1}}' \
  --recurrence recurrence \
  --timezone Europe/Bucharest \
  --start-time 2030-01-01T00:00 \
  --disable-time 2030-12-31T00:00

Forma de datos

{
  "Code": "ScheduleUpdate",
  "Data": {
    "Id": "b2c3d4e5-0000-0000-0000-000000000001",
    "Name": "Nightly regression",
    "Description": "Full regression suite",
    "CronExpression": "0 0 3 1/1 * ? *",
    "Timezone": "Europe/Bucharest",
    "StartTime": "2030-01-01T00:00",
    "DisableTime": "2030-12-31T00:00",
    "IsEnabled": true,
    "Action": "Updated"
  }
}

Data carries the same schedule fields as create, with Action set to Updated.

uip tm schedules enable

Switch on one or more schedules. Name them with --schedule-ids, or pass --all --yes for every schedule in the project. A single schedule UUID goes straight to Test Manager, which reports an unknown ID itself. Names, and lists of more than one schedule, are first resolved against the project's schedule list; an unknown or ambiguous selector is refused and nothing changes. A schedule that is already on is left alone.

When several schedules are switched, the CLI reads the list again afterwards. If any schedule did not change, for example because it was deleted in between, the command fails with ErrorCode not_found and names those schedules.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Test Manager project key. One of --project-key or --project-id is required. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--schedule-ids <uuid...>	Schedule names or UUIDs to switch on, space-separated. A name that more than one schedule carries is refused. Repeats are dropped. One of --schedule-ids or --all is required; they are mutually exclusive.
--all	Every schedule in the project. Requires --yes, since the count is not known until the command runs.
-y, --yes	Confirms --all. Not needed with --schedule-ids. With --all and without --yes, the command returns Result: "Failure" and exits 1.

Ejemplo

uip tm schedules enable \
  --project-key DEMO \
  --schedule-ids b2c3d4e5-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000002

Forma de datos

{
  "Code": "ScheduleSetEnabled",
  "Data": {
    "ScheduleIds": [
      "b2c3d4e5-0000-0000-0000-000000000001",
      "b2c3d4e5-0000-0000-0000-000000000002"
    ],
    "Count": 2,
    "IsEnabled": true,
    "Action": "Enabled"
  }
}

With --all in a project that has no schedules, ScheduleIds is empty, Count is 0, and Action is NoSchedules.

uip tm schedules disable

Switch off one or more schedules and keep their definitions. Selection, resolution, and the follow-up check work as for enable. A schedule that is already off is left alone.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Test Manager project key. One of --project-key or --project-id is required. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--schedule-ids <uuid...>	Schedule names or UUIDs to switch off, space-separated. A name that more than one schedule carries is refused. Repeats are dropped. One of --schedule-ids or --all is required; they are mutually exclusive.
--all	Every schedule in the project. Requires --yes, since the count is not known until the command runs.
-y, --yes	Confirms --all. Not needed with --schedule-ids. With --all and without --yes, the command returns Result: "Failure" and exits 1.

Ejemplo

uip tm schedules disable \
  --project-key DEMO \
  --all \
  --yes

Forma de datos

{
  "Code": "ScheduleSetEnabled",
  "Data": {
    "ScheduleIds": ["b2c3d4e5-0000-0000-0000-000000000001"],
    "Count": 1,
    "IsEnabled": false,
    "Action": "Disabled"
  }
}

uip tm schedules delete

Delete one or more schedules. Selection, resolution, and the follow-up check work as for enable. Deleting a test set already removes its schedules; use this verb to drop a cadence and keep the test set.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Test Manager project key. One of --project-key or --project-id is required. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--schedule-ids <uuid...>	Schedule UUIDs to delete, space-separated. Schedule names are resolved too; a name that more than one schedule carries is refused. Repeats are dropped. One of --schedule-ids or --all is required; they are mutually exclusive.
--all	Every schedule in the project.
-y, --yes	Required. Confirms the irreversible operation. The CLI never prompts; without --yes the command returns Result: "Failure" and exits 1.

Ejemplo

uip tm schedules delete \
  --project-key DEMO \
  --schedule-ids b2c3d4e5-0000-0000-0000-000000000001 \
  --yes

Forma de datos

{
  "Code": "ScheduleDelete",
  "Data": {
    "ScheduleIds": ["b2c3d4e5-0000-0000-0000-000000000001"],
    "Count": 1,
    "Action": "Deleted"
  }
}

With --all in a project that has no schedules, Action is NoSchedules.

uip tm schedules next-runs

Report when each schedule fires next. Pass the schedule names or IDs that list prints, not BackgroundTaskScheduleId values. The command resolves each one through the schedule list, so it needs TestSet.Read. NextRun is a UTC instant, unlike StartTime and DisableTime, which are read in the schedule's Timezone.

Outcome	Significado
Scheduled	NextRun is set.
NoNextRun	The schedule exists but has no upcoming run: it is disabled, expired, or not yet set up by the scheduler.
NotFound	No schedule in this project has that ID or name.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Test Manager project key. One of --project-key or --project-id is required. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--schedule-ids <id-or-name...>	Required. Schedules to report on, by name or UUID, space-separated, at most 100. A name that more than one schedule carries is refused; pass its UUID instead.

Ejemplo

uip tm schedules next-runs \
  --project-key DEMO \
  --schedule-ids b2c3d4e5-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000002

Forma de datos

{
  "Code": "ScheduleNextRuns",
  "Data": [
    {
      "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
      "BackgroundTaskScheduleId": "c3d4e5f6-0000-0000-0000-000000000099",
      "NextRun": "2030-01-02T00:00:00.000Z",
      "Outcome": "Scheduled"
    },
    {
      "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000002",
      "BackgroundTaskScheduleId": null,
      "NextRun": null,
      "Outcome": "NotFound"
    }
  ]
}

ScheduleId is the schedule's UUID, also when you passed its name. For a NotFound entry it echoes the value you passed.

Relacionado

• testsets: the test sets that schedules run, and testsets run for a one-off run.
• executions: the executions that scheduled runs produce.

Ver también

• Descripción general de Test Manager