Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ not jeopardize network security.
You can also use Password Policy Enforcer to ensure that passwords are compatible with other
systems, and to synchronize passwords with other networks and applications.

**NOTE:** The [Evaluate Password Policy Enforcer](/docs/passwordpolicyenforcer/11.0/evaluation/evaluation_overview.md) contains
:::note
The [Evaluate Password Policy Enforcer](/docs/passwordpolicyenforcer/11.0/evaluation/evaluation_overview.md) contains
step-by-step instructions to help you quickly install, configure, and evaluate Password Policy
Enforcer. Consider using the Evaluation Guide if you are using Password Policy Enforcer for the
first time, prior to installing and deploying on your domains.

:::
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ sidebar_position: 10

The **Connect-PPE** cmdlet establishes a connection to the PPE Server.

SYNTAX
**SYNTAX**

**Connect-PPE** [[__-Local__] `<_SwitchParameter_>`] [[__-Domain__] `<_string_>`]
[`<_CommonParameters_>`]

PARAMETERS
**PARAMETERS**

**-Domain** `<_string_>`

Expand All @@ -30,7 +30,7 @@ This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorActio
**OutVariable**. For more information, see about_CommonParameters
[about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> Connect-PPE -d "DCNAME1.COMPANY.COM"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ sidebar_position: 20

The **CopyPPEPolicy** cmdlet makes a copy of a PPE policy.

SYNTAX
**SYNTAX**

**Copy-PPEPolicy -DestPolicyName** `<_string_>` **-SrcPolicyName** `<_string_>`
[`<_CommonParameters_>`]

PARAMETERS
**PARAMETERS**

**-SrcPolicyName** `<_string_>`

Expand All @@ -29,7 +29,7 @@ This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorActio
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> Copy-PPEPolicy -s "Eval Policy" -d "User Policy"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ sidebar_position: 30

The **Export-PPEConfig** cmdlet exports the Password Policy Enforcer configuration to a file.

SYNTAX
**SYNTAX**

**Export-PPEConfig** [__-File__ `<_string_>`] [`<_CommonParameters_>`]

PARAMETERS
**PARAMETERS**

**-File** `<_string_>`

Expand All @@ -24,7 +24,7 @@ This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorActio
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> Export-PPEConfig -file c:\ppe\ppe_config

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,17 @@ sidebar_position: 40

The **Export-PPEPolicy** exports a Password Policy Enforcer policy to a file.

**NOTE:** This cmdlet calls the **PPE Tool**. You must be an administrator to run this cmdlet. Start
:::note
This cmdlet calls the **PPE Tool**. You must be an administrator to run this cmdlet. Start
PowerShell with the **Run as Administrator** option.
:::

SYNTAX

**SYNTAX**

**Export-PPEPolicy** -PolicyName `<_string_>` [__-File__ `<_string_>`] [`<_CommonParameters_>`]

PARAMETERS
**PARAMETERS**

**-PolicyName** `<_string_>`

Expand All @@ -31,7 +34,7 @@ This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorActio
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> Export-PPEPolicy -PolicyName "Eval Policy" -File C:\ppe\EvalPolicy

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ sidebar_position: 50
The **Get-PPEBulkPasswordTest** cmdlet runs the Password Policy Enforcer bulk password test of the
specified policy.

SYNTAX
**SYNTAX**

**Get-PPEBulkPasswordTest** **-PasswordFile** `<_string_>` **-Policy** `<_string_>`
**-ResultFolder** `<_string_>` [`<_CommonParameters_>`]

PARAMETERS
**PARAMETERS**

**-PasswordFile** `<_string_>`

Expand All @@ -35,7 +35,7 @@ This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorActio
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> Get-PPEBulkPasswordTest -PasswordFile C:\PPE\password.txt -Policy "Eval Policy"
-resultFolder C:\PPE
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,17 @@ sidebar_position: 60

The **Get-PPEConfigReport** cmdlet saves a Password Policy Enforcer configuration report.

**NOTE:** This cmdlet calls the PPE Tool. You must be an administrator to run this cmdlet. Start
:::note
This cmdlet calls the PPE Tool. You must be an administrator to run this cmdlet. Start
PowerShell with the **Run as Administrator** option.
:::

SYNTAX

**SYNTAX**

**Get-PPEConfigReport** **-Folder** `<_string_>`

PARAMETERS
**PARAMETERS**

**-Folder** `<_string_>`

Expand All @@ -27,7 +30,7 @@ This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorActio
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> Get-PPEConfigReport -Folder C:\PPE

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ sidebar_position: 70

The **Get-PPEDefaultPolicy** cmdlet reports the name of the Password Policy Enforcer default Policy.

SYNTAX
**SYNTAX**

**Get-PPEDefaultPolicy** [`<_CommonParameters_>`]

PARAMETERS
**PARAMETERS**

`<_CommonParameters_>`

This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorAction**,
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> Get-PPEDefaultPolicy

Default policy : Eval Policy
**Default policy : Eval Policy**
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ sidebar_position: 80

The **Get-PPEEnabled** cmdlet returns the enabled/disabled status of the PPE Server.

SYNTAX
**SYNTAX**

**Get-PPEEnabled** [`<_CommonParameters_>`]

PARAMETERS
**PARAMETERS**

`<_CommonParameters_>`

This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorAction**,
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> Get-PPEEnabled

Status PPE : Enabled
**Status PPE : Enabled**
20 changes: 10 additions & 10 deletions docs/passwordpolicyenforcer/11.0/admin/cmdlets/cmdgetppehelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ sidebar_position: 90
The **Get-PPEHelp** cmdlet lists the available Password Policy Enforcer cmdlets. If a cmdlet is
specified, returns help for the cmdlet.

SYNTAX
**SYNTAX**

**Get-PPEHelp** [[__-Cmdlet__] `<_string_>`]

PARAMETERS
**PARAMETERS**

**-Cmdlet** `<_string_>`

Expand All @@ -25,36 +25,36 @@ This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorActio
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> get-ppehelp get-ppehelp

NAME
**NAME**

Get-PPEHelp

SYNOPSIS
**SYNOPSIS**

Get a list of the PPE Cmdlet

SYNTAX
**SYNTAX**

Get-PPEHelp [[-Cmdlet] `<string>`] `[<CommonParameters>]`

DESCRIPTION
**DESCRIPTION**

Get a list of the PPE Cmdlet

RELATED LINKS
**RELATED LINKS**

https://www.netwrix.com/password_policy_enforcer.html

REMARKS
**REMARKS**

To see the examples, type: "get-help Get-PPEHelp -examples".

For more information, type: "get-help Get-PPEHelp -detailed".

For technical information, type: "get-help Get-PPEHelp -full".

For online help, type: "get-help Get-PPEHelp -online"
**For online help, type: "get-help Get-PPEHelp -online"**
Original file line number Diff line number Diff line change
Expand Up @@ -8,56 +8,56 @@ sidebar_position: 100

The **Get-PPELicenseInfo** cmdlet returns the Password Policy Enforcer license information.

SYNTAX
**SYNTAX**

**Get-PPELicenseInfo** [`<_CommonParameters_>`]

PARAMETERS
**PARAMETERS**

`<_CommonParameters_>`

This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorAction**,
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

```
PS C:\> Get-PPELicenseInfo

ANIXIS Software License Certificate
**ANIXIS Software License Certificate**

Product: Password Policy Enforcer

License type: Perpetual
**License type: Perpetual**

Licensed to: test

Version: 11
**Version: 11**

Users: 100

<ANIXIS_LICENSE>JrPQdyhsxWrLj7RsuX322Ni8vwIRr6ozC+sY3M16aJba
**<ANIXIS_LICENSE>JrPQdyhsxWrLj7RsuX322Ni8vwIRr6ozC+sY3M16aJba**

XuRXG6VjOjWUMT1XwqO4c3VA0eIB8+z4KyUNEzLjmSZKvtLsHb0kFYi1zRiL

6EBVflEmzxYIsCvAlsg1fNfK1JgjFefOc1gENy2CBikDTbe+HnHf3aVBq6p2
**6EBVflEmzxYIsCvAlsg1fNfK1JgjFefOc1gENy2CBikDTbe+HnHf3aVBq6p2**

Va1eXmMXToi3NDNJCNFzQHy7ZGC5AhQ8GIjQfgK8z9s1sHzpdj2Gn+9BEyQQ

nv833QdoFhjKoAXN/xCecZclkCkP9f1GLuq4kN0Emsh5qqXl686JBJlisA3o
**nv833QdoFhjKoAXN/xCecZclkCkP9f1GLuq4kN0Emsh5qqXl686JBJlisA3o**

XWQrEQ0Me9P3TkSUpb742JCngQaGcjKHvQoufBJ+GIrcwWG2DZJ1i9xrOJMT

g8D5eFDz/OiqXuZyBHFTInbq77V59x/xtIlUffBW7sCUmY8B+ZhLR2XpLdxr
**g8D5eFDz/OiqXuZyBHFTInbq77V59x/xtIlUffBW7sCUmY8B+ZhLR2XpLdxr**

S+4E37Lhf46bScltZxfHZbDQKZuT4hdMKnnzgNHEzkMh8Q3T/40sMvQbAV4O

tDF633YsQMH3Ttbyc+vAvIvbAHJOVhBpNd9TCybfas+j6uQL5fa4qo8dFrx+
**tDF633YsQMH3Ttbyc+vAvIvbAHJOVhBpNd9TCybfas+j6uQL5fa4qo8dFrx+**

+UrPakOmSL/eDR7xB5/zmB37shDXIPfzfG/Vu7I1/EQuH01rZDyafHnzTmmm

1hCMqyi+oVzxZtN8I3sIpAH3FLu+1N37CuHJFrXD97Iu6RjKi+11nG9BmZ2Q
**1hCMqyi+oVzxZtN8I3sIpAH3FLu+1N37CuHJFrXD97Iu6RjKi+11nG9BmZ2Q**

0SX5EYc=</ANIXIS_LICENSE>
```
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ sidebar_position: 110

The **Get-PPEPasswordTest** cmdlet runs the Password Policy Enforcer password test for a user.

SYNTAX
**SYNTAX**

**Get-PPEPasswordTest** **-Password** `<_string_>` **-Username** `<_string_>` [__-OldPassword__
`<_string_>`] [`<_CommonParameters_>`]

PARAMETERS
**PARAMETERS**

**-Password** `<_string_>`

Expand All @@ -33,11 +33,11 @@ This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorActio
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**OutVariable**. For more information, see [about_CommonParameters](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5).

EXAMPLE
**EXAMPLE**

PS C:\> Get-PPEPasswordTest -Password qwerty -User PPETestUser

Assigning default policy "Eval Policy"
**Assigning default policy "Eval Policy"**

Log

Expand Down
Loading
Loading