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
10 changes: 10 additions & 0 deletions docs/passwordpolicyenforcer/11.1/admin/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"label": "Administration",
"position": 40,
"collapsed": true,
"collapsible": true,
"link": {
"type": "doc",
"id": "administration_overview"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Administration"
description: "Administration"
sidebar_position: 40
---

# Administration

Netwrix Password Policy Enforcer helps secure your network by ensuring users set strong passwords.
When a user enters a password that does not comply with the password policy, Password Policy
Enforcer immediately rejects the password and details why the password was rejected.

![introduction_2](/images/passwordpolicyenforcer/11.1/evaluation/introduction_3.webp)

Unlike password cracking products that check passwords after they are accepted by the operating
system, Password Policy Enforcer checks new passwords immediately to ensure that weak passwords do
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.1/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.

:::
10 changes: 10 additions & 0 deletions docs/passwordpolicyenforcer/11.1/admin/cmdlets/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"label": "PPE cmdlets",
"position": 60,
"collapsed": true,
"collapsible": true,
"link": {
"type": "doc",
"id": "cmdlets"
}
}
37 changes: 37 additions & 0 deletions docs/passwordpolicyenforcer/11.1/admin/cmdlets/cmdconnectppe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "Connect-PPE"
description: "Connect-PPE"
sidebar_position: 10
---

# Connect-PPE

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

**SYNTAX**

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

**PARAMETERS**

**-Domain** `<_string_>`

Name of the domain controller to connect. Can also use **-D** or **-d**.

**-Local** `<_SwitchParameter_>`

Connect to PPE Server installed locally. Can also use **-L** or **-l**.

`<_CommonParameters_>`

This cmdlet supports the common parameters: **Verbose**, **Debug**, **ErrorAction**,
**ErrorVariable**, **WarningAction**, **WarningVariable**, **OutBuffer**, **PipelineVariable**, and
**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**

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

Connection to PPE was established. Connection to Domain "DCNAME1.COMPANY.COM"
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "Copy-PPEPolicy"
description: "Copy-PPEPolicy"
sidebar_position: 20
---

# Copy-PPEPolicy

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

**SYNTAX**

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

**PARAMETERS**

**-SrcPolicyName** `<_string_>`

Source PPE Policy Name. Can also use **-S** or **-s**.

**-DestPolicyName** `<_string_>`

Destination PPE Policy Name. Can also use **-D** or **-d**.

`<_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**

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

The "User Policy" policy was created based on the "Eval Policy".
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "Export-PPEConfig"
description: "Export-PPEConfig"
sidebar_position: 30
---

# Export-PPEConfig

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

**SYNTAX**

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

**PARAMETERS**

**-File** `<_string_>`

Name of the file to create.

`<_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**

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

Configuration export has been successfully completed. The file "c:\ppe\ppe_config" has been created.
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "Export-PPEPolicy"
description: "Export-PPEPolicy"
sidebar_position: 40
---

# Export-PPEPolicy

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
PowerShell with the **Run as Administrator** option.
:::


**SYNTAX**

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

**PARAMETERS**

**-PolicyName** `<_string_>`

Name of the to export.

**-File** `<_string_>`

Name of the file to create.

`<_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**

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

Configuration export has been successfully completed. The file "C:\ppe\EvalPolicy" has been created.
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "Get-PPEBulkPasswordTest"
description: "Get-PPEBulkPasswordTest"
sidebar_position: 50
---

# Get-PPEBulkPasswordTest

The **Get-PPEBulkPasswordTest** cmdlet runs the Password Policy Enforcer bulk password test of the
specified policy.

**SYNTAX**

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

**PARAMETERS**

**-PasswordFile** `<_string_>`

Path and name of the text file containing the passwords to test. Passwords in your test file are 1
per line.

**-Policy** `<_string_>`

The name of the policy to enforce for the test.

**-ResultFolder** `<_string_>`

The folder for the created html report.

`<_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**

PS C:\> Get-PPEBulkPasswordTest -PasswordFile C:\PPE\password.txt -Policy "Eval Policy"
-resultFolder C:\PPE

Bulk test is running...

The report is created: "C:\PPE\password.txt_Result_2209222024122350.html".

![Results of the Get-PPEBulkPasswordTest cmdlet](/images/passwordpolicyenforcer/11.1/administration/cmdletgetppebulkpasswordtest.webp)
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "Get-PPEConfigReport"
description: "Get-PPEConfigReport"
sidebar_position: 60
---

# Get-PPEConfigReport

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
PowerShell with the **Run as Administrator** option.
:::


**SYNTAX**

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

**PARAMETERS**

**-Folder** `<_string_>`

Name of the folder to save the report.

`<_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**

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

The report is created: "C:\PPE\report.html".

![Creates the PPE Configuration report](/images/passwordpolicyenforcer/11.1/administration/cmdletgetppeconfigreport.webp)
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Get-PPEDefaultPolicy"
description: "Get-PPEDefaultPolicy"
sidebar_position: 70
---

# Get-PPEDefaultPolicy

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

**SYNTAX**

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

**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**

PS C:\> Get-PPEDefaultPolicy

**Default policy : Eval Policy**
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Get-PPEEnabled"
description: "Get-PPEEnabled"
sidebar_position: 80
---

# Get-PPEEnabled

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

**SYNTAX**

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

**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**

PS C:\> Get-PPEEnabled

**Status PPE : Enabled**
Loading