Versions Compared

Key

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

Name

Get-JS7AuditLog

SYNOPSIS

Returns Audit Log entries

...

ControllerId

-ControllerId <String>

Required?false
Position?1
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

Folder

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

Required?false
Position?2
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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.

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

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

Required?false
Position?3
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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

Required?false
Position?4
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Category

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

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

Required?false
Position?5
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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: Begin Beginning of the current day as a UTC date

Required?false
Position?6
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 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?7
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 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?8
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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.

Required?false
Position?9
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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.

Required?false
Position?10
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 <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?14
Default value0
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 valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

EXAMPLES

...