Get-ePoCommandHelp

NAME Get-ePoCommandHelp



SYNOPSIS

This returns the help for the specified command made available by the API.





SYNTAX

Get-ePoCommandHelp [[-Command] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

This returns the help for the specified command made available by the API. Requires an active connection to the

EpoServer.





PARAMETERS

-Command <String[]>

The command to get help for.



Required? false

Position? 1

Default value All

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Can be used to list available ePoCommands by not specifying any parameters.

Added support for an array of strings being used in the Command parameter.

Added support for Whatif



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-ePoCommandHelp



This will get a list of avaiable commands and their associated commandtext from the API.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-ePoCommandHelp -Command "system.find" | Format-List



Gets the help for the command system.find outputted into the Format-List Cmdlet









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>$DetectedSystemAddHelp = Get-ePoCommandHelp -Command "detectedsystem.add"



$DetectdSystemAddHelp.CommandUse



Gets the help for the command detectedsystem.add and stores it in a variable. Then the property CommandUse is

expanded. The ParameterValues

property returns all of the parameters. Still working on getting the ParameterName to return the paramters that

aren't on the first line.

Any parameter in [] is optional.









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>$ePoCommands | Where {$_.Command -like "*Computer*"} | Get-ePoCommandHelp



This will get the help for each command found with Computer in the command name. Uses the script variable

$ePoCommands that was created

either by Connect-ePoServer or by running this function with the Command parameter set to All.











RELATED LINKS