Skip to content

docs: sanitize examples #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2025
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
13 changes: 7 additions & 6 deletions docs/documentation/functions/Get-PasswordPolicyDefault.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Default settings for VMware products include:
- VMware SDDC Manager
- VMware ESXi
- VMware vCenter Single Sign-On
- VMware vCenter Server
- VMware vCenter
- VMware NSX Manager
- VMware NSX Edge
- VMware Workspace ONE Access
Expand All @@ -45,19 +45,20 @@ This example returns the default password policy settings for the VMware Cloud F
### Example 2

```powershell
Get-PasswordPolicyDefault -generateJson -jsonFile passwordPolicyConfig.json -version '5.0.0.0'
Get-PasswordPolicyDefault -generateJson -jsonFile <policy_file>.json -version '5.0.0.0'
```

This example creates a JSON file named `passwordPolicyConfig.json` with the default password policy settings for the given version of VMware Cloud Foundation.
This example creates a JSON file with the default password policy settings for the given version of VMware Cloud Foundation.

### Example 3

```powershell
Get-PasswordPolicyDefault -generateJson -jsonFile passwordPolicyConfig.json -version '5.0.0.0' -force
Get-PasswordPolicyDefault -generateJson -jsonFile <policy_file>.json -version '5.0.0.0' -force
```

This example creates a JSON file named `passwordPolicyConfig.json` with the default password policy settings for the given version of VMware Cloud Foundation.
If `passwordPolicyConfig.json` is already present, it is overwritten due to 'force' parameter.
This example creates a JSON file with the default password policy settings for the given version of VMware Cloud Foundation.

If the policy configuration file is already present, it is overwritten due to 'force' parameter.

## Parameters

Expand Down
10 changes: 5 additions & 5 deletions docs/documentation/functions/Invoke-PasswordPolicyManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,39 +27,39 @@ The `Invoke-PasswordPolicyManager` generates a Password Policy Manager Report fo
### Example 1

```powershell
Invoke-PasswordPolicyManager -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1! -sddcRootPass VMw@re1! -reportPath "F:\Reporting" -darkMode -allDomains
Invoke-PasswordPolicyManager -sddcManagerFqdn <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains
```

This example runs a password policy report for all workload domains within an SDDC Manager instance.

### Example 2

```powershell
Invoke-PasswordPolicyManager -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1! -sddcRootPass VMw@re1! -reportPath "F:\Reporting" -darkMode -allDomains -wsaFqdn sfo-wsa01.sfo.rainpole.io -wsaRootPass VMw@re1! -wsaAdminPass VMw@re1!
Invoke-PasswordPolicyManager -sddcManagerFqdn <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains -wsaFqdn <fqdn> -wsaRootPass <root_password> -wsaAdminPass <admin_password>
```

This example runs a password policy report for all workload domains within an SDDC Manager instance and Workspace ONE Access.

### Example 3

```powershell
Invoke-PasswordPolicyManager -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1! -sddcRootPass VMw@re1! -reportPath "F:\Reporting" -darkMode -workloadDomain sfo-w01
Invoke-PasswordPolicyManager -sddcManagerFqdn <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -workloadDomain <workload_domain_name>
```

This example runs a password policy report for a specific workload domain within an SDDC Manager instance.

### Example 4

```powershell
Invoke-PasswordPolicyManager -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1! -sddcRootPass VMw@re1! -reportPath "F:\Reporting" -darkMode -allDomains -drift -policyFile "passwordPolicyConfig.json"
Invoke-PasswordPolicyManager -sddcManagerFqdn <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains -drift -policyFile <policy_file>.json
```

This example runs a password policy report for all workload domains within an SDDC Manager instance and compares the configuration against the JSON provided.

### Example 5

```powershell
Invoke-PasswordPolicyManager -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1! -sddcRootPass VMw@re1! -reportPath "F:\Reporting" -darkMode -allDomains -drift
Invoke-PasswordPolicyManager -sddcManagerFqdn <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains -drift
```

This example runs a password policy report for all workload domains within an SDDC Manager instance and compares the configuration against the product defaults.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ The `Invoke-PasswordRotationManager` generates a Password Rotation Manager Repor
### Example 1

```powershell
Invoke-PasswordRotationManager -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1! -sddcRootPass VMw@re1! -reportPath "F:\Reporting" -darkMode -allDomains
Invoke-PasswordRotationManager -sddcManagerFqdn <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains
```

This example runs a password rotation report for all workload domains within an SDDC Manager instance.

### Example 2

```powershell
Invoke-PasswordRotationManager -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1! -sddcRootPass VMw@re1! -reportPath "F:\Reporting" -darkMode -workloadDomain sfo-w01
Invoke-PasswordRotationManager -sddcManagerFqdn <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -workloadDomain <workload_domain_name>
```

This example runs a password rotation report for a specific Workload Domain within an SDDC Manager instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Publish-AriaLocalUserPasswordPolicy -server <String> -user <String> [-pass <Stri

## Description

The `Publish-AriaLocalUserPasswordPolicy` cmdlet retrieves the requested password policy for all ESXi hosts and converts
The `Publish-AriaLocalUserPasswordPolicy` cmdlet retrieves the requested password policy for all ESX hosts and converts
the output to HTML.

The cmdlet connects to the SDDC Manager using the -server, -user, and -pass values:
Expand All @@ -37,47 +37,47 @@ The cmdlet connects to the SDDC Manager using the -server, -user, and -pass valu
### Example 1

```powershell
Publish-AriaLocalUserPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordExpiration -allDomains
Publish-AriaLocalUserPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -allDomains
```

This example returns password expiration policy for all VMware Aria products for all domains.

### Example 2

```powershell
Publish-AriaLocalUserPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordExpiration -workloadDomain sfo-m01
Publish-AriaLocalUserPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name>
```

This example returns password expiration policy for all VMware Aria products for the management domain.

### Example 3

```powershell
Publish-AriaLocalUserPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordComplexity -allDomains
Publish-AriaLocalUserPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -allDomains
```

This example returns password complexity policy for all VMware Aria products for all domains.

### Example 4

```powershell
Publish-AriaLocalUserPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordComplexity -workloadDomain sfo-m01
Publish-AriaLocalUserPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -workloadDomain <workload_domain_name>
```

This example returns password complexity policy for all VMware Aria products for the management domain.

### Example 5

```powershell
Publish-AriaLocalUserPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy AccountLockout -allDomains
Publish-AriaLocalUserPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -allDomains
```

This example returns password account lockout policy for all VMware Aria products for all domains.

### Example 6

```powershell
Publish-AriaLocalUserPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy AccountLockout -workloadDomain sfo-m01
Publish-AriaLocalUserPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -workloadDomain <workload_domain_name>
```

This example returns password account lockout policy for all VMware Aria products for the management domain.
Expand Down
40 changes: 20 additions & 20 deletions docs/documentation/functions/Publish-EsxiPasswordPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Synopsis

Publishes the password policies for ESXi hosts for a workload domain or all workload domains.
Publishes the password policies for ESX hosts for a workload domain or all workload domains.

## Syntax

Expand All @@ -20,78 +20,78 @@ Publish-EsxiPasswordPolicy -server <String> -user <String> -pass <String> -polic

## Description

The `Publish-EsxiPasswordPolicy` cmdlet retrieves the requested password policy for all ESXi hosts and convert the output to HTML.
The `Publish-EsxiPasswordPolicy` cmdlet retrieves the requested password policy for all ESX hosts and convert the output to HTML.
The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values:

- Validates that network connectivity and authentication is possible to SDDC Manager
- Validates that network connectivity and authentication is possible to vCenter Server
- Retrieves the requested password policy for all ESXi hosts and converts to HTML
- Validates that network connectivity and authentication is possible to vCenter
- Retrieves the requested password policy for all ESX hosts and converts to HTML

## Examples

### Example 1

```powershell
Publish-EsxiPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordExpiration -allDomains
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -allDomains
```

This example returns password expiration policy for all ESXi hosts across all for a workload domain.
This example returns password expiration policy for all ESX hosts across all for a workload domain.

### Example 2

```powershell
Publish-EsxiPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordExpiration -workloadDomain sfo-w01
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name>
```

This example returns password expiration policy for all ESXi hosts for a workload domain.
This example returns password expiration policy for all ESX hosts for a workload domain.

### Example 3

```powershell
Publish-EsxiPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordComplexity -allDomains
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -allDomains
```

This example returns password complexity policy for all ESXi hosts across all for a workload domain.
This example returns password complexity policy for all ESX hosts across all for a workload domain.

### Example 4

```powershell
Publish-EsxiPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordComplexity -workloadDomain sfo-w01
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -workloadDomain <workload_domain_name>
```

This example returns password complexity policy for all ESXi hosts for a workload domain.
This example returns password complexity policy for all ESX hosts for a workload domain.

### Example 5

```powershell
Publish-EsxiPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy AccountLockout -allDomains
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -allDomains
```

This example returns account lockout policy for all ESXi hosts across all for a workload domain.
This example returns account lockout policy for all ESX hosts across all for a workload domain.

### Example 6

```powershell
Publish-EsxiPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy AccountLockout -workloadDomain sfo-w01
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -workloadDomain <workload_domain_name>
```

This example returns account lockout policy for all ESXi hosts for a workload domain.
This example returns account lockout policy for all ESX hosts for a workload domain.

### Example 7

```powershell
Publish-EsxiPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordExpiration -workloadDomain sfo-w01 -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
```

This example returns password expiration policy for all ESXi hosts across all for a workload domain and compares the configuration against the `passwordPolicyConfig.json` file.
This example returns password expiration policy for all ESX hosts across all for a workload domain and compares the configuration against the policy configuration file.

### Example 8

```powershell
Publish-EsxiPasswordPolicy -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -policy PasswordExpiration -workloadDomain sfo-w01 -drift
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name> -drift
```

This example returns password expiration policy for all ESXi hosts across all for a workload domain and compares the configuration against the product defaults.
This example returns password expiration policy for all ESX hosts across all for a workload domain and compares the configuration against the product defaults.

## Parameters

Expand Down
12 changes: 6 additions & 6 deletions docs/documentation/functions/Publish-NsxEdgeAccountLockout.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,39 +24,39 @@ The `Publish-NsxEdgeAccountLockout` cmdlet returns account lockout policy for lo
The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values:

- Validates that network connectivity and authentication is possible to SDDC Manager
- Validates that network connectivity and authentication is possible to vCenter Server
- Validates that network connectivity and authentication is possible to vCenter
- Publishes the account lockout policy for NSX Edge nodes for a workload domain or all workload domains.

## Examples

### Example 1

```powershell
Publish-NsxEdgeAccountLockout -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
Publish-NsxEdgeAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -allDomains
```

This example returns account lockout policy for each NSX Edge nodes for all workload domains.

### Example 2

```powershell
Publish-NsxEdgeAccountLockout -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
Publish-NsxEdgeAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
```

This example returns account lockout policy for each NSX Edge nodes for a workload domain.

### Example 3

```powershell
Publish-NsxEdgeAccountLockout -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01 -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json"
Publish-NsxEdgeAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
```

This example returns account lockout policy for each NSX Edge nodes for a workload domain and compares the configuration against the `passwordPolicyConfig.json` file.
This example returns account lockout policy for each NSX Edge nodes for a workload domain and compares the configuration against the policy configuration file.

### Example 4

```powershell
Publish-NsxEdgeAccountLockout -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01 -drift
Publish-NsxEdgeAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
```

This example returns account lockout policy for each NSX Edge nodes for a workload domain and compares the configuration against the product defaults.
Expand Down
Loading