PowerShell CLI 2.0 - Cmdlets - Get-JS7AuditLog

Name

Get-JS7AuditLog

SYNOPSIS

Returns Audit Log entries

SYNTAX

Get-JS7AuditLog [[-ControllerId] <String>] [[-Folder] <String>] [-Recursive] [[-Type] <String[]>] [[-ObjectName] <String>] [[-Category] <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 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

-ControllerId <String>

Folder

-Folder <String>
Optionally specifies the folder that includes objects for which audit log entries should be returned.

Recursive

-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.

Type

-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

ObjectName

-ObjectName <String>
Specifies the name of an object that matches one or more of the object types specified with the -Type parameter.
The object name can include * and ? wildcard characters with

* : match zero or more characters
? : match any single character

Category

-Category <String[]>
Specifies a category that further limits results of audit log entries.

* INVENTORY
* CONTROLLER
* DAILYPLAN
* DEPLOYMENT
* DOCUMENTATIONS
* CERTIFICATES
* IDENTITY

DateFrom

-DateFrom <DateTime>
Specifies the date starting from which audit log entries should be returned.
Consider that a UTC date has to be provided.

Default: Beginning of the current day as a UTC date

DateTo

-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

RelativeDateFrom

-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. 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

-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. 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.

Timezone

-Timezone <TimeZoneInfo>
Specifies the timezone for which dates should be converted to from the history information.
A timezone can e.g. be specified like this:

Get-JS7AuditLog -Timezone (Get-Timezone -Id 'GMT Standard Time')

All dates in JS7 are UTC and can be converted e.g. to the local time zone like this:

Get-JS7AuditLog -Timezone (Get-Timezone)

Default: Dates are returned in UTC.

Account

-Account <String>
Limits results to entries that have been caused by the specified account.

TicketLink

-TicketLink <String>
Limits results to entries that include the specified ticket link.

Reason

-Reason <String>

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.

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.

RELATED LINKS

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > $items = Get-JS7AuditLog

Returns today's audit log entries.

-------------------------- EXAMPLE 2 --------------------------

PS > $items = Get-JS7AuditLog -Category 'DEPLOYMENT'

Returns today's audit log entries for any 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)

Returns today's audit log entries with dates being converted to the local timezone.

-------------------------- EXAMPLE 5 --------------------------

PS > $items = Get-JS7AuditLog -Timezone (Get-Timezone -Id 'GMT Standard Time')

Returns today's audit log entries with dates being converted to the GMT timezone.

-------------------------- EXAMPLE 6 --------------------------

PS > $items = Get-JS7AuditLog -Folder /ProductDemo -Recursive

Returns today's audit log entries for a given folder and any sub-folders.

-------------------------- EXAMPLE 7 --------------------------

PS > $items = Get-JS7AuditLog -DateFrom "2020-08-11 14:00:00Z"

Returns the audit log entries that started after the specified UTC date and time.

-------------------------- EXAMPLE 8 --------------------------

PS > $items = Get-JS7AuditLog -DateFrom (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(-7).ToUniversalTime()

Returns the audit log entries for the last seven days.

-------------------------- EXAMPLE 9 --------------------------

PS > $items = Get-JS7AuditLog -RelativeDateFrom -7d

Returns the audit log for the last seven days. The audit log is reported starting from midnight UTC.

-------------------------- EXAMPLE 10 --------------------------

PS > $items = Get-JS7AuditLog -RelativeDateFrom -7d+01:00

Returns the audit log for the last seven days. The audit log is reported starting from 1 hour after midnight UTC.

-------------------------- EXAMPLE 11 --------------------------

PS > $items = Get-JS7AuditLog -RelativeDateFrom -7d+TZ

Returns the audit log for the last seven days. The audit log is reported starting from midnight in the same timezone that is used with the -Timezone parameter.

-------------------------- EXAMPLE 12 --------------------------

PS > $items = Get-JS7AuditLog -RelativeDateFrom -1w

Returns the audit log entries for the last week.