How to View Detailed Help Information About the PowerShell Commands

There are a number of ways you can find help information for the available PowerShell commands. Simply launch a PowerShell console, import the STProtect module and then type any of the following commands. Full localized help documentation is included as part of the Security Controls installation.

View the complete list of available commands

PS C:\> (Get-Module -Name STProtect).ExportedCommands

The available commands are:

  • Add-MachineGroup: Adds a new machine group with the specified name, description and path.
  • Add-MachineGroupItem: Adds or updates a set of resolvable machine names to a machine group. The option to specify explicit credentials and set the include/exclude status is supported.
  • Add-PatchGroup: Adds a new patch group.
  • Add-PatchGroupItem: Adds patches to an existing patch group.
  • Add-STCredential: Adds a credential to the current user's credential store for use in patch and deploy operations.
  • Format-PatchDeployTable: Formats a patch deploy result as a table with top level operation information as well as machine summary statistics.
  • Format-PatchScanTable: Formats a patch scan result as a table with top level operation information as well as machine summary statistics.
  • Get-MachineGroup: If a name is provided, a machine group is retrieved by name. Otherwise, all defined machine groups are returned.
  • Get-PatchDeploy: Interrogates the data store to retrieve recorded patch deploy information, including individual machine deploy states. Partial information is retrieved if the patch deploy is in progress.
  • Get-PatchGroup: Gets patch group information.
  • Get-PatchScan: Interrogates the data store to retrieve recorded patch scan information, including individual machine summary statistics. Partial information is retrieved if the patch scan is in progress.
  • Get-PatchScanTemplate: If a name is provided, a patch scan template is retrieved by name. Otherwise, all defined patch scan templates are returned.
  • Get-STCredential: Gets one or more credential references from the current user's credential store given the criteria. If no criteria are specified, all credential references are returned.
  • Get-VendorFamilyProductHierarchy: Retrieves the name id pairs for including/excluding vendors, families and products using New-VendorFamilyProduct.
  • Invoke-DownloadMissingPatches: Downloads all missing patches detected in a patch scan. If a patch has already been downloaded into the patch store location, no action is taken on that patch.
  • Invoke-PowerStateDeploy: Executes a power management task against the specified machine targets. A combination of explicitly-defined endpoint names and/or pre-defined machine groups may be used to specify the targets.
  • Invoke-WakeOnLan: Initiates a new Wake-On-LAN operation against the specified machine targets. The targets specified must have been scanned with a hardware asset scan to identify the MAC address.
  • New-PatchFilter: Creates a new patch filter. Filters created with this command are used as input to New-PatchScanTemplate or Set-PatchScanTemplate.
  • New-PatchPropertyFilter: Creates a patch detection filter based on patch properties. Filters created with this command are used as input to New-PatchFilter.
  • New-PatchScanTemplate: Creates a new patch scan template.
  • New-VendorFamilyProductFilter: Creates a new Vendor Family Product filter.
  • Remove-MachineGroup: Removes a machine group and all child items.
  • Remove-MachineGroupItem: Removes a set of resolvable machine names from a machine group.
  • Remove-PatchGroup: Delete the patch group information.
  • Remove-PatchGroupItem: Removes patches from an existing patch group.
  • Remove-PatchScanTemplate: Removes the patch scan template with the specified name.
  • Remove-STCredential: Removes a credential from the credential store. Only credentials owned by the current user can be removed.
  • Set-MachineGroupCredential: Sets or removes a top-level machine group credential to be used as the default credential for all machines defined in a machine group. This credential is used only in cases where no machine or endpoint specific credential has been specified.
  • Set-PatchScanTemplate: Updates a patch scan template.
  • Start-PatchDeploy: Queues a new patch operation to deploy all of the patches identified in a patch scan.
  • Start-PatchScan: Queues a new patch scan operation against the specified machine targets. A combination of explicitly defined endpoint names and/or pre-defined machine groups may be used to specify the targets.
  • Stop-PatchDeploy: Cancels an active patch deploy operation.
  • Stop-PatchScan: Cancels an active patch scan operation.
  • Update-STCredential: Updates a credential in the current user's credential store for use in patch and deployment operations.
  • ValidateElementsNotNullOrWhiteSpace:
  • ValidateNotNullOrWhiteSpace:
  • ValidatePSCustomObjectType:
  • Wait-PatchDeploy: Waits for an active patch deployment operation to complete.
  • Wait-PatchScan: Waits for an active patch scan operation to complete.
  • Watch-PatchDeploy: Monitors an active patch deployment operation, periodically reporting progress and status until it completes. The patch deploy operation, status, percentage complete and elapsed time are all reported as progress.
  • Watch-PatchScan: Monitors an active patch scan operation, periodically reporting progress and status until it completes. The patch scan operation, status, percentage complete and elapsed time are all reported as progress.

View detailed help for an individual command

PS C:\> Get-Help <command> -detailed

View complete help for all commands

PS C:\> (Get-Module STProtect).ExportedCommands.Values | ForEach-Object { $_ | Get-Help –Full}

To pipe the output to a text file:

PS C:\> (Get-Module STProtect).ExportedCommands.Values | ForEach-Object { $_ | Get-Help –Full} | Out-File “C:\SampleDirectory\HelpOutputFull.txt”