You must import the PowerShell snap-in for use with Universal Policy Administrator. To import, execute the cmdlet from a PowerShell prompt as in the following snippet:
add-pssnapin HAPI.ProviderPowershellSnapin
After you load the PowerShell snap-in, to view the list of supported cmdlets you must execute the cmdlet from a PowerShell prompt as in the following snippet:
get-command -module HAPI.ProviderPowershellSnapin
The outputs provides a complete list of cmdlets that Universal Policy Administrator supports. For more information, see Supported PowerShell Cmdlets
You can view a sample cmdlet detail from a PowerShell prompt as in the following command:
get-help Get-UniversalPolicy -detailed
NAME
Get-UniversalPolicy
SYNTAX
Get-UniversalPolicy [-AllDetails <SwitchParameter>] [-BranchName <string>] [-Domain <string>] [-LoadGPOId
<string>] [-PolicyId <string>] [-PreviousVersion <bool>] [-SectionId <string>] [-SpecificVersion <int>] [-UPId
<string>] [<CommonParameters>]
DESCRIPTION
The Get-UniversalPolicy cmdlet gets the properties for a specified Universal Policy, or all Universal Policies.
PARAMETERS
-LoadGPOId <string>
Obsolete. Use New-UniversalPolicy + Import-UniversalPolicy instead. (optional) Specifies the Guid of a GPO to
import into a new UP.
-load <string>
Obsolete. Use New-UniversalPolicy + Import-UniversalPolicy instead. (optional) Specifies the Guid of a GPO to
import into a new UP.
This is an alias of the LoadGPOId parameter.
-UPId <string>
Id of the UP to retrieve. If not specified, all UPs will be retrieved.
-PolicyId <string>
If specified, Policy within the UP to retrieve.
-SectionId <string>
If specified, Section within the UP to retrieve.
-AllDetails <SwitchParameter>
If this flag is set, the results will include the Policies, Sections, and Settings within the UP. Otherwise,
only the UP properties will be returned.
-PreviousVersion <bool>
True to retrieve a previous version of the UP.
-SpecificVersion <int>
If specified, Version of the UP to retrieve.
-BranchName <string>
(Optional) The branch where the Universal Policy is retrieved from.
-Domain <string>
(Optional) The name of the domain where the Universal Policy is retrieved from.
<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).
---------- EXAMPLE 1 ----------
This example opens a HAPI session, and then retrieves all Universal Policies from the domain
'mydomain.com'Get-Credential | Get-HAPIConnection -url "https://dev.hapidevelopment.com"