UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip insights machines

Syntax and options for `uip insights machines`, which queries Insights machine monitoring data such as runtime mix, machine details, availability, failures, and utilization.

uip insights machines queries UiPath Insights machine monitoring data for a time window: the unattended and attended runtime mix, per-machine details, availability intervals, the machines with the most faulted jobs, and job runtime per machine.

Synopsis​

uip insights machines runtime-mix           <time range> [filters]
uip insights machines details               <time range> [filters] [-l <n>] [-o <n>]
uip insights machines availability-timeline <time range> [filters] [-l <n>] [-o <n>]
uip insights machines top-failures          <time range> [filters] [-l <n>] [-o <n>]
uip insights machines utilization           <time range> [filters] [-l <n>] [-o <n>]
uip insights machines runtime-mix           <time range> [filters]
uip insights machines details               <time range> [filters] [-l <n>] [-o <n>]
uip insights machines availability-timeline <time range> [filters] [-l <n>] [-o <n>]
uip insights machines top-failures          <time range> [filters] [-l <n>] [-o <n>]
uip insights machines utilization           <time range> [filters] [-l <n>] [-o <n>]

These commands honor the global options and the standard exit codes. They use the tenant selected during uip login and reject --tenant. On a deployment that does not serve the machine routes, the commands fail with Result: "ConfigError" and ErrorCode: "configuration_error".

Shared options​

A time range is required: pass --time-range, or both --started-after and --started-before.

FlagDescription
--time-range <minutes>Relative window in minutes, ending now, for example 1440 for the last day. The server caps it at 30 days.
--started-after <epoch-ms>Absolute window start, as Unix epoch milliseconds. Requires --started-before. A bound that is a full 31 days old is moved to the 30-day boundary.
--started-before <epoch-ms>Absolute window end, as Unix epoch milliseconds. Requires --started-after. A bound that is a full 31 days old is moved to the 30-day boundary.
--machine-name <names...>Restrict to these machine names. Discover them with uip insights filter-machines list.
--host-machine-name <names...>Restrict to these host machine names. Read them from the HostMachineName column of machines details. Serverless machines report N/A, which only availability-timeline can filter on.
--machine-type <types...>Restrict to these machine type labels: Standard Machine, Elastic Robot Pool, Cloud Robot - VM, Cloud Robot - Serverless, or Machine Template.
-l, --limit <number>Maximum rows to return. Defaults to 50. Not on runtime-mix.
-o, --offset <number>Rows to skip before returning results. Not on runtime-mix.

An empty result means no machine matched the filters in the window. It is not proof that a machine does not exist. Check the machine names with uip insights filter-machines list before reporting it as a finding.

uip insights machines runtime-mix​

Get unattended and attended job runtime for a window. Returns two fixed rows, Unattended first and Attended second.

uip insights machines runtime-mix --time-range 1440
uip insights machines runtime-mix --time-range 1440

The command returns Code: "InsightsMachinesRuntimeMix". Each row has these fields:

FieldDescription
ExecutionTypeUnattended or Attended.
JobDurationMsTotal job runtime, in milliseconds, for that execution type.
AverageUtilizationMsJobDurationMs divided by the window's distinct robot count, counted across both execution types. Milliseconds, not a percentage.

The server reports zero for both values when no job runtime matches, so a zero pair does not confirm an idle machine.

uip insights machines details​

List per-machine and per-host status, current process, fault count, runtime, and slot inventory. Rows are sorted by MachineName, then HostMachineName.

uip insights machines details --time-range 1440 --machine-type "Standard Machine"
uip insights machines details --time-range 1440 --machine-type "Standard Machine"

The command returns Code: "InsightsMachinesDetails". Each row has these fields:

FieldDescription
MachineName, HostMachineNameThe machine and host. The pair is not a unique row identity.
StatusMachine status, read from the machine sessions of the last 30 days. Read Status to tell whether a job is running now.
CurrentProcessProcess named on the most recent job event for the machine and host, whatever state that job ended in.
FaultedJobsFaulted jobs inside the window.
UtilizationMsJob runtime, in milliseconds.
MachineTypeMachine type label.
RuntimeCountSum of the slot counts below.
InUseCountRuntimes in use.
NonProductionSlots, HeadlessSlots, AutomationCloudSlots, UnattendedSlots, TestAutomationSlots, AutomationCloudTestAutomationSlots, DevelopmentSlotsSlot counts by runtime type.

uip insights machines availability-timeline​

List availability intervals per machine and host, reconstructed from machine session and job events. Rows keep the backend's order.

uip insights machines availability-timeline --time-range 1440 --machine-name RPA-VM-01
uip insights machines availability-timeline --time-range 1440 --machine-name RPA-VM-01

The command returns Code: "InsightsMachinesAvailabilityTimeline". Each row has these fields:

FieldDescription
MachineName, HostMachineName, MachineKeyThe machine, host, and machine key. One machine has one row per state change, so MachineKey is not a row identity.
StatusSession state, such as Available, Unresponsive, or Disconnected, or the interval markers Job Start and Job End.
StartTime, EndTimeInterval bounds, as formatted GMT strings. A StartTime that carried into the window is clamped to the window start.
RunningJobsConcurrent in-progress jobs for the interval. A negative value means unknown concurrency.
EventTimeThe transition instant, not clamped to the window. Present when the deployment returns it.

A machine that stays Unresponsive or Disconnected for the whole window returns no rows, so an empty result does not prove availability.

uip insights machines top-failures​

List the machines with the most faulted jobs in a window, ranked by the server.

uip insights machines top-failures --time-range 10080
uip insights machines top-failures --time-range 10080

The command returns Code: "InsightsMachinesTopFailures". Each row has MachineName, HostMachineName, and FaultedJobs. A machine absent from this list is not proof that it had no faults. To drill into a machine's failures, run uip insights jobs failures-by-reason --machine-name <name>.

uip insights machines utilization​

List job runtime minutes per machine and host for a window, ranked by minutes, descending.

uip insights machines utilization --time-range 1440
uip insights machines utilization --time-range 1440

The command returns Code: "InsightsMachinesUtilization". Each row has MachineName, HostMachineName, and UtilizationMinutes. UtilizationMinutes is job runtime in minutes inside the window, rounded to two decimals. It is not a percentage. A machine with no running interval is omitted, so a missing machine is not a zero-minute machine.

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated