Export-DSPamAccountAccessReport

2025-02-17

Export-DSPamAccountAccessReport

SYNOPSIS

Generate a report detailing PAM credential access

SYNTAX

VaultID (Default)

Export-DSPamAccountAccessReport -Path <string> [-VaultID <guid>] [-Type <ReportExportType>]
 [-NoClobber] [-PassThru] [-ResolveUserGroups] [-AsLegacyResponse] [<CommonParameters>]

EntryID

Export-DSPamAccountAccessReport -AccountID <guid[]> -Path <string> [-Type <ReportExportType>]
 [-NoClobber] [-PassThru] [-ResolveUserGroups] [-AsLegacyResponse] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Generate a report detailing PAM credential access, available in CSV, HTML, and XML formats. By default, the system will overwrite any existing file. To prevent this, employ the NoClobber switch. Specify the credentials to be included in the report using either the AccountID or FolderID parameters. Use AccountID for individual credentials, and VaultID to include all credentials within a specified vault.

EXAMPLES

EXAMPLE

PS C:> Export-DSPamAccountAccessReport -VaultID '12345678-1234-1234-1234-1234567890AB' -Path 'myName.html' -Type Html

Export an html report named 'myName' in the current directory

PARAMETERS

-AccountID

Pam accounts' ID

Type: System.Guid[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases:
- PamCredentialID
ParameterSets:
- Name: EntryID
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-AsLegacyResponse

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-NoClobber

Prevents the cmdlet from overwriting existing files. If a file with the specified name already exists, the cmdlet will generate an error instead of overwriting the file.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PassThru

Enables the cmdlet to output objects it has processed, useful for further pipeline processing or inspection.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Path

Specifies the path to the output file where the data will be exported. The path can be either absolute or relative. If only a file name is provided, the file will be created in the current directory. If the specified file already exists, it will be overwritten. To prevent overwriting an existing file, use the -NoClobber switch.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ResolveUserGroups

Replace user groups by its members

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Type

Specifies the report type: HTML (default) and CSV

Type: Devolutions.RemoteDesktopManager.ReportExportType
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-VaultID

Pam vault's ID

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases:
- FolderID
ParameterSets:
- Name: VaultID
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

For more information, type "Get-Help Export-DSPamAccountAccessReport -detailed". For technical information, type "Get-Help Export-DSPamAccountAccessReport -full".

RELATED LINKS