Przemysław Kłys
f7bdaca724
- Revised `Set-GPOZaurrOwner.md` to enhance clarity and detail for parameters and examples. - Updated `Set-GPOZaurrStatus.md` with a new online version link and improved structure. - Refined `Skip-GroupPolicy.md` to clarify usage within script blocks and added examples. - Adjusted `GPOZaurr.psd1` for version updates and improved module dependencies. - Enhanced `GPOZaurr.psm1` for better error handling during function imports. - Modified `Invoke-GPOZaurrSupport.ps1` examples to use `Join-Path` for path construction.
3.8 KiB
external help file, Module Name, online version, schema
| external help file | Module Name | online version | schema |
|---|---|---|---|
| GPOZaurr-help.xml | GPOZaurr | https://github.com/EvotecIT/GPOZaurr | 2.0.0 |
Invoke-GPOZaurrSupport
SYNOPSIS
Invokes GPOZaurrSupport function to retrieve Group Policy information.
SYNTAX
__AllParameterSets
Invoke-GPOZaurrSupport [[-Type] <string>] [[-ComputerName] <string>] [[-UserName] <string>] [[-Path] <string>] [[-Splitter] <string>] [-PreventShow] [-Online] [<CommonParameters>]
DESCRIPTION
This function retrieves Group Policy information using either HTML, XML, or Object format. It can be run locally or on a remote computer.
EXAMPLES
EXAMPLE 1
PS > Invoke-GPOZaurrSupport -Type HTML -ComputerName "RemoteComputer" -UserName "Admin" -Path (Join-Path $env:TEMP 'GPOReport.html')
Retrieves Group Policy information in HTML format from a remote computer and saves it to a specified path.
EXAMPLE 2
PS > Invoke-GPOZaurrSupport -Type XML -Path (Join-Path $env:TEMP 'GPOReport.xml') -Online
Retrieves the latest Group Policy information in XML format and saves it to a specified path.
PARAMETERS
-ComputerName
Specifies the name of the remote computer to retrieve Group Policy information from.
Type: String
Parameter Sets: __AllParameterSets
Aliases: Server
Possible values:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Online
Runs the function online to retrieve the latest Group Policy information.
Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-Path
Specifies the path to save the output file. If not provided, a temporary file will be created.
Type: String
Parameter Sets: __AllParameterSets
Aliases:
Possible values:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-PreventShow
Prevents displaying the output in the console.
Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases:
Possible values:
Required: False
Position: named
Default value: False
Accept pipeline input: False
Accept wildcard characters: True
-Splitter
Specifies the delimiter for splitting output data. Default is a new line.
Type: String
Parameter Sets: __AllParameterSets
Aliases:
Possible values:
Required: False
Position: 4
Default value: [System.Environment]::NewLine
Accept pipeline input: False
Accept wildcard characters: True
-Type
Specifies the type of output format. Valid values are 'NativeHTML', 'HTML', 'XML', or 'Object'. Default is 'HTML'.
Type: String
Parameter Sets: __AllParameterSets
Aliases:
Possible values: NativeHTML, HTML, XML, Object
Required: False
Position: 0
Default value: HTML
Accept pipeline input: False
Accept wildcard characters: True
-UserName
Specifies the username to run the function as on the remote computer.
Type: String
Parameter Sets: __AllParameterSets
Aliases: User
Possible values:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
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
None
OUTPUTS
None
RELATED LINKS
- None