Page History
...
Get-JS7AuditLog
SYNOPSIS
Returns the Audit Log entries
SYNTAX
Get-JS7AuditLog [[-OrderIdControllerId] <String>] [[-JobFolder] <String>] [[-WorkflowPath] <String>Recursive] [[-CalendarPath] <String>Type] <String[]>] [[-FolderObjectName] <String>] [[-RecursiveCategory] [<String[-RegularExpression] <String>>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-Account] <String>] [[-TicketLink] <String>] [[-Reason] <String>] [[-Limit] <Int32>] [-Detailed] [<CommonParameters>]
DESCRIPTION
Audit log information is returned from a JOC Cockpit instance.
Audit log entries can be selected by workflow path, order Order ID, folder etc.
The audit log information returned includes point in time, request, object etc. of a change.
The following REST Web Service API resources are used:
* /audit_log
* /audit_log/details
PARAMETERS
...
ControllerId
-OrderId ControllerId <String>
Optionally specifies the identifier of an order for which audit log entries should be returned.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
...
Folder
-Job Folder <String>
Optionally specifies the name of a job folder that includes objects for which audit log entries should be returned.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
...
Recursive
-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which audit log information should be returned.
...
CalendarPath
-CalendarPath <String>Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up when used with the -Folder parameter.
By default no sub-folders will be looked up for workflow paths.
| Required? | false |
| Position? | 4named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Type
-Folder <String>
Optionally specifies the folder that includes workflows Type <String[]>
Specifies the object types for which audit log entries should be returned. Multiple values can be specified by
use of commas, for example -Type WORKFLOW,SCHEDULE
* WORKFLOW
* JOBRESOURCE
* LOCK
* FILEORDERSOURCE
* NOTICEBOARD
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR
* SCHEDULE
* INCLUDESCRIPT
* JOBTEMPLATE
* REPORT
* DOCUMENTATION
* ORDER
| Required? | false | |
| Position? | 53 | |
| Default value | / | |
| Accept pipeline input? | true (ByPropertyName) | |
| Accept wildcard characters? | false |
...
ObjectName
-Recursive <SwitchParameter>ObjectName <String>
Specifies that any sub-folders should be looked up when used the name of an object that matches one or more of the object types specified with the -Folder parameter.
By default no sub-folders will be looked up for workflow paths. Type parameter.
The object name can include * and ? wildcard characters with
* : match zero or more characters
? : match any single character
| Required? | false | |
| Position? | named4 | |
| Default value | False | |
| Accept pipeline input? | true (ByPropertyName) | |
| Accept wildcard characters? | false |
...
Category
-RegularExpression <String>Category <String[]>
Specifies a regular expression that filters category that further limits results of audit log entries to be returned.
The regular expression is applied to the order ID or job.
* INVENTORY
* CONTROLLER
* DAILYPLAN
* DEPLOYMENT
* DOCUMENTATIONS
* CERTIFICATES
* IDENTITY
| Required? | false |
| Position? | 65 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-DateFrom <DateTime>
Specifies the date starting from which audit log entries should be returned.
Consider that a UTC date has to be provided.
Default: Begin Beginning of the current day as a UTC date
| Required? | false |
| Position? | 76 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-DateTo <DateTime>
Specifies the date until which audit log entries should be returned.
Consider that a UTC date has to be provided.
Default: End of the current day as a UTC date
| Required? | false |
| Position? | 87 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(1).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-RelativeDateFrom <String>
Specifies a relative date starting from which audit log entries 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.
| Required? | false |
| Position? | 98 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-RelativeDateTo <String>
Specifies a relative date until which audit log entries 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 is . This will be 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? | 109 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-Timezone <TimeZoneInfo>
Specifies the timezone to for which dates should be converted to from the history information.
A timezone can e.g. be specified like this:
Get-JS7OrderHistory JS7AuditLog -Timezone (Get-Timezone -Id 'GMT Standard Time')
All dates in JobScheduler JS7 are UTC and can be converted e.g. to the local time zone like this:
Get-JS7OrderHistory JS7AuditLog -Timezone (Get-Timezone)
Default: Dates are returned in UTC.
| Required? | false |
| Position? | 1110 |
| Default value | (Get-Timezone -Id 'UTC') |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Account
-Account <String>
Limits results to entries that have been caused by the specified account.
| Required? | false |
| Position? | 11 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
TicketLink
-TicketLink <String>
Limits results to entries that include the specified ticket link.
| Required? | false |
| Position? | 12 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Reason
-Reason <String>
| Required? | false |
| Position? | 13 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Limit
-Limit <Int32>
Specifies the max. number of audit log entries to be returned.
The default value is 10000, for an unlimited number of items the value -1 can be specified.
| Required? | false |
| Position? | 1214 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Detailed
-Detailed <SwitchParameter>
Specifies that the original request should be returned that caused the change related to the respective audit log entry.
Note that the -Detailed parameter can return large amounts of data and will slow down processing.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
PS > $items = Get-JS7AuditLog -RegularExpression "sos$Category 'DEPLOYMENT'
Returns today's audit log entries for any order IDs, workflow paths or job names end with the string "sos"deployment related changes.
-------------------------- EXAMPLE 3 --------------------------
PS > $items = Get-JS7AuditLog -Category 'DEPLOYMENT' -Detailed
Returns today's audit log entries for any deployment related changes including details about each object.
-------------------------- EXAMPLE 4 --------------------------
PS > $items = Get-JS7AuditLog -Timezone (Get-Timezone)
...
-------------------------- EXAMPLE 4 5 --------------------------
...
-------------------------- EXAMPLE 5 6 --------------------------
PS > $items = Get-JS7AuditLog -WorkflowPath /some_path/some_workflowFolder /ProductDemo -Recursive
Returns today's audit log entries for a given workflowfolder and any sub-folders.
-------------------------- EXAMPLE 6 7 --------------------------
...
-------------------------- EXAMPLE 7 8 --------------------------
...
-------------------------- EXAMPLE 8 9 --------------------------
...
-------------------------- EXAMPLE 9 10 --------------------------
...
-------------------------- EXAMPLE 10 11 --------------------------
...
-------------------------- EXAMPLE 11 12 --------------------------
...
Overview
Content Tools