API Reference
Command
Show-ADXFileSid
Generates an HTML report for file SID scans.
Examples
Example 1: Run scan and generate report.
Show-ADXFileSid -Path "\\\\FS1\\Data"
Example 2: Reuse existing data.
Show-ADXFileSid -InputObject $result
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Show-ADXFileSid [-Author <string>] [-Description <string>] [-FooterText <string>] [-HeaderText <string>] [-InputObject <FileSidScanResult>] [-LogoAltText <string>] [-LogoPath <string>] [-OpenInBrowser] [-PassThru] [-ReportPath <string>] [-Subtitle <string>] [-Title <string>] [<CommonParameters>]#Parameter set:
By InputObjectParameters
- Author string
- Override the report author.
- Description string
- Override the report description.
- FooterText string
- Footer text (optional).
- HeaderText string
- Header text (optional).
- InputObject FileSidScanResult
- File SID scan results (pipeline).
- LogoAltText string
- Logo alt text (optional).
- LogoPath string
- Logo path for report branding (optional).
- OpenInBrowser SwitchParameter
- Open the report in a browser after generation.
- PassThru SwitchParameter
- Return the input object after generating the report.
- ReportPath string
- Optional report output path (file or directory).
- Subtitle string
- Override the report subtitle.
- Title string
- Override the report title.
Outputs
ADPlayground.Acl.FileSidScanResult
Show-ADXFileSid [-AllowList <string[]>] [-Author <string>] [-DeadPrefixFile <string>] [-Depth <int>] [-Description <string>] [-FollowReparse] [-FooterText <string>] [-HeaderText <string>] [-LogoAltText <string>] [-LogoPath <string>] [-NoResolve] [-NoSidHistory] [-NoTrusts] [-OpenInBrowser] [-Parallelism <int>] [-PassThru] [-Path <string[]>] [-ReportPath <string>] [-Subtitle <string>] [-Title <string>] [<CommonParameters>]#Parameter set:
By AllowList + DeadPrefixFileParameters
- AllowList string[]
- Additional SID strings to allow.
- Author string
- Override the report author.
- DeadPrefixFile string
- Path to a file containing dead/defunct domain SID prefixes (one per line).
- Depth int
- Maximum recursion depth; omit for unlimited.
- Description string
- Override the report description.
- FollowReparse SwitchParameter
- Follow reparse points (junctions/symlinks).
- FooterText string
- Footer text (optional).
- HeaderText string
- Header text (optional).
- LogoAltText string
- Logo alt text (optional).
- LogoPath string
- Logo path for report branding (optional).
- NoResolve SwitchParameter
- Skip SID-to-name resolution.
- NoSidHistory SwitchParameter
- Skip SIDHistory correlation lookups.
- NoTrusts SwitchParameter
- Exclude trusted forests/domains from the internal catalog.
- OpenInBrowser SwitchParameter
- Open the report in a browser after generation.
- Parallelism int
- Max degree of parallelism for ACL reads.
- PassThru SwitchParameter
- Return the input object after generating the report.
- Path string[]
- Root paths to scan (local or UNC).
- ReportPath string
- Optional report output path (file or directory).
- Subtitle string
- Override the report subtitle.
- Title string
- Override the report title.
Outputs
ADPlayground.Acl.FileSidScanResult