Export-TssReport
SYNOPSIS
Export results of a Report to CSV format.
SYNTAX
Export-TssReport [-TssSession] <Session> [-ReportId <Int32>] [-ReportName <String>] [-Parameters <Hashtable>]
[-Delimiter <String>] [-Format <String>] [<CommonParameters>]
DESCRIPTION
Export results of a Report to CSV format.
EXAMPLES
EXAMPLE 1
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Export-TssReport -TssSession $session -ReportName GroupMembershipReportByGroup -Parameters @{Group = 1}
Exports report GroupMembershipReportByGroup returning CSV formatted result for Everyone group (1)
EXAMPLE 2
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Export-TssReport -TssSession $session -ReportName 'Filter Name' -Parameters @{customtext = 'ada.jupiter.com\brittney.poole - 4073'}
Exports report "Filter Name" returning CSV formatted result, based on custom text filter
EXAMPLE 3
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Export-TssReport -TssSession $session -ReportId 60 -Delimiter '|'
| Exports report 60 (Changed90DaysReportName) in CSV format, delimited by pipe character (" | ") |
PARAMETERS
-TssSession
TssSession object created by New-TssSession for authentication
Type: Session
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-ReportId
Report Id
Type: Int32
Parameter Sets: (All)
Aliases: Id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ReportName
Name of Report
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Parameters
Report Parameters provided as hash format of @{<Parameter Name>,<Param Value>} (see examples)
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Delimiter
Delimiter for CSV data, defaults to comma
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: ,
Accept pipeline input: False
Accept wildcard characters: False
-Format
Format of export, CSV only supported option at this time
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Csv
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
System.String
NOTES
Requires TssSession object returned by New-TssSession
RELATED LINKS
https://thycotic-ps.github.io/thycotic.secretserver/commands/reports/Export-TssReport