Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Get-JS7ControllerStatus

SYNOPSIS

Return Returns status information, optionally optional summary and history information for a JS7 Controller

...

DESCRIPTION

Status information, optionally optional summary and history information are returned for a JS7 Controller.

* Status information includes e.g. the start date and JS7 release
* Summary information includes e.g. the number of running orders
* History information includes e.g. an overview of past orders

The following REST Web Service API resources are used:

* /controller
* /controller/p
* /controllers/p

PARAMETERS

DateFrom

-DateFrom <DateTime>
Specifies the date starting from which history items should be returned.
Consider Note that a UTC date has to be provided.

Default: Begin Beginning of the current day as a UTC date

...

-DateTo <DateTime>
Specifies the date until which history items should be returned.
Consider Note that a UTC date has to be provided.

Default: End of the current day as a UTC date

...

-RelativeDateFrom <String>
Specifies a relative date starting from which history items should be returned, e.g.

* -1s, -2s: one second ago, two seconds ago
* -1m, -2m: one minute ago, two minutes ago
* -1h, -2h: one hour ago, two hours ago
* -1d, -2d: one day ago, two days ago
* -1w, -2w: one week ago, two weeks ago
* -1M, -2M: one month ago, two months ago
* -1y, -2y: one year ago, two years ago

Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ, that . This is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

This parameter takes precedence over the -DateFrom parameter.

...

-RelativeDateTo <String>
Specifies a relative date until which history items should be returned, e.g.

* -1s, -2s: one second ago, two seconds ago
* -1m, -2m: one minute ago, two minutes ago
* -1h, -2h: one hour ago, two hours ago
* -1d, -2d: one day ago, two days ago
* -1w, -2w: one week ago, two weeks ago
* -1M, -2M: one month ago, two months ago
* -1y, -2y: one year ago, two years ago

Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ, that . This is calculated by the cmdlet
for the timezone that which is specified with the -Timezone parameter.

This parameter takes precedence over the -DateFrom parameter.

...

-Display <SwitchParameter>
Specifies that formatted output will be displayed, otherwise a status object will be returned that contain contains the respective relevant information.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...