Export-RDMPasswordAnalyzerReport

    2024-10-28

    Export-RDMPasswordAnalyzerReport

    SYNOPSIS

    Export an entry security analyzer report of the current data source

    SYNTAX

    __AllParameterSets

    Export-RDMPasswordAnalyzerReport [-ReportType] <string> [-ExportType] <string> [-Path] <string>
     [[-Status] <ConnectionStatusFilter>] [-Private] [-ShowAllEntries] [-ShowPwnedPassword]
     [-ShowVPNAnalysis] [-Theme <Theme>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]
    

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Export an entry security analyzer report of the current data source to the specfied path. The user must have access to the reports to use the command.

    EXAMPLES

    EXAMPLE 1

    PS C:> Export-RDMPasswordAnalyzerReport -ExportType Html -Path C:\mypath\filename.html -Status Expired -Verbose

    Export the Password Analyzer report in a html format at the location C:\mypath\filename.html. Only the connections with expired password will be include in the report. If the report does not contain an entry, a verbose message will indicates that the report is empty. In that case, the report will not be generated.

    EXAMPLE 2

    PS C:> Get-RDMDataSource -Name ADataSource | Set-RDMCurrentDataSource; Export-RDMPasswordAnalyzerReport -ExportType Html -Path C:\mypath\filename.html -ShowAllEntries -ShowVPNAnalysis -ShowPwnedPassword -Private

    Change the current data source to ADataSource and export the Password Analyzer report in a html format at the location C:\mypath\filenmae.html. The report will contain all connections, even those without a password, the VPN analysis, and will identified the compromised passwords.

    EXAMPLE 3

    PS C:> $original = Get-RDMCurrentDataSource; $ds = Get-RDMDataSource; $ds.ForEach({Set-RDMCurrentDataSource -DataSource $; Export-RDMPasswordAnalyzerReport -ExportType Html -Path C:\mypath$($.Name).html -ShowPwnedPassword -Private}); Set-RDMCurrentDataSource -DataSource $original

    For all the data sources, export the Password Analyzer report of the private vault in a html format in the directory C:\mypath\ where the file name will be the same as the data source name. The initial current data source will be set again as the current one.

    PARAMETERS

    -ExportType

    Specify the file type of the export. CSV, HTML and XLM are supported.

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

    -ForcePromptAnswer

    Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

    • Yes: Accept the prompt. Cover the OK and Automatic value.
    • No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No.
    • Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.
    Type: System.Windows.Forms.DialogResult[]
    DefaultValue: ''
    SupportsWildcards: false
    ParameterValue: []
    Aliases: []
    ParameterSets:
    - Name: (All)
      Position: Named
      IsRequired: false
      ValueFromPipeline: false
      ValueFromPipelineByPropertyName: false
      ValueFromRemainingArguments: false
    DontShow: false
    AcceptedValues: []
    HelpMessage: ''
    

    -Path

    Path where the file will be the saved. Must end with:

    "CSV: .csv", "HTML: .html", "XML: .xml"

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

    -Private

    The report will cover the list of available sessions from the user private vault.

    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: ''
    

    -ReportType

    Specify the report type to export. Only PasswordAnalyzer (Entry Security Analyzer) is supported for now.

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

    -ShowAllEntries

    Show also the entries without a password

    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: ''
    

    -ShowPwnedPassword

    Show the compromised (pwned) passwords

    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: ''
    

    -ShowVPNAnalysis

    Show the VPN analysis

    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: ''
    

    -Status

    Filter the connections based on their status. The filter "Default" keeps the connections whose status is not specified.

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

    -Theme

    Specify the theme of the report. If not specified, the RDM theme will be used.

    Type: System.Nullable`1[Devolutions.RemoteDesktopManager.Theme]
    DefaultValue: ''
    SupportsWildcards: false
    ParameterValue: []
    Aliases: []
    ParameterSets:
    - Name: (All)
      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-RDMPasswordAnalyzerReport -detailed". For technical information, type "Get-Help Export-RDMPasswordAnalyzerReport -full".