Name
Get-JS7ControllerStatus
SYNOPSIS
Returns status information, optional summary and history information for a JS7 Controller
SYNTAX
Get-JS7ControllerStatus [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [-History] [-Summary] [-Display] [<CommonParameters>]
DESCRIPTION
Status information, 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.
Note that a UTC date has to be provided.
Default: Beginning of the current day as a UTC date
| Required? | false |
| Position? | 1 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DateTo
-DateTo <DateTime>
Specifies the date until which history items should be returned.
Note that a UTC date has to be provided.
Default: End of the current day as a UTC date
| Required? | false |
| Position? | 2 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(1).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RelativeDateFrom
-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. This is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.
This parameter takes precedence over the -DateFrom parameter.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RelativeDateTo
-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. This is calculated by the cmdlet
for the timezone which is specified with the -Timezone parameter.
This parameter takes precedence over the -DateFrom parameter.
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
History
-History <SwitchParameter>
Specifies that history information about orders and tasks should be returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Summary
-Summary <SwitchParameter>
Specifies that summary information about orders and tasks should be returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Display
-Display <SwitchParameter>
Specifies that formatted output will be displayed, otherwise a status object will be returned that contains the relevant information.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Get-JS7ControllerStatus
Returns status information about the JS7 Controller.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JS7ControllerStatus -Summary -Display
Returns status information and summary information about orders and jobs. Formatted output is displayed.
-------------------------- EXAMPLE 3 --------------------------
PS > $status = Get-JS7ControllerStatus -Summary
Returns an object including status information and summary information.
Overview
Content Tools