Skip to content

docs: sanitize examples #228

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
4 changes: 2 additions & 2 deletions docs/documentation/functions/Get-PasswordPolicyDefault.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Default settings for VMware products include:
Get-PasswordPolicyDefault -version '5.0.0.0'
```

This example returns the default password policy settings for the VMware Cloud Foundation version 5.0.0.0.
This example returns the default password policy settings for the VMware Cloud Foundation version.

### Example 2

Expand All @@ -58,7 +58,7 @@ Get-PasswordPolicyDefault -generateJson -jsonFile <policy_file>.json -version '5

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.
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 <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains
Invoke-PasswordPolicyManager -sddcManagerFqdn <sddc_manager_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 <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains -wsaFqdn <fqdn> -wsaRootPass <root_password> -wsaAdminPass <admin_password>
Invoke-PasswordPolicyManager -sddcManagerFqdn <sddc_manager_fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains -wsaFqdn <wsa_fqdn> -wsaRootPass <wsa_root_password> -wsaAdminPass <wsa_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 <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -workloadDomain <workload_domain_name>
Invoke-PasswordPolicyManager -sddcManagerFqdn <sddc_manager_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 <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains -drift -policyFile <policy_file>.json
Invoke-PasswordPolicyManager -sddcManagerFqdn <sddc_manager_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 <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains -drift
Invoke-PasswordPolicyManager -sddcManagerFqdn <sddc_manager_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 <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -allDomains
Invoke-PasswordRotationManager -sddcManagerFqdn <sddc_manager_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 <fqdn> -sddcManagerUser <admin_username> -sddcManagerPass <admin_password> -sddcRootPass <root_password> -reportPath <report_path> -darkMode -workloadDomain <workload_domain_name>
Invoke-PasswordRotationManager -sddcManagerFqdn <sddc_manager_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 @@ -37,47 +37,47 @@ The cmdlet connects to the SDDC Manager using the -server, -user, and -pass valu
### Example 1

```powershell
Publish-AriaLocalUserPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -allDomains
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_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 <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name>
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_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 <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -allDomains
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_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 <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -workloadDomain <workload_domain_name>
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_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 <fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -allDomains
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_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 <fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -workloadDomain <workload_domain_name>
Publish-AriaLocalUserPasswordPolicy -server <sddc_manager_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
16 changes: 8 additions & 8 deletions docs/documentation/functions/Publish-EsxiPasswordPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,63 +32,63 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
### Example 1

```powershell
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -allDomains
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -allDomains
```

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

### Example 2

```powershell
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name>
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name>
```

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

### Example 3

```powershell
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -allDomains
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -allDomains
```

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

### Example 4

```powershell
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -workloadDomain <workload_domain_name>
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordComplexity -workloadDomain <workload_domain_name>
```

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

### Example 5

```powershell
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -allDomains
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -allDomains
```

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

### Example 6

```powershell
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -workloadDomain <workload_domain_name>
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy AccountLockout -workloadDomain <workload_domain_name>
```

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

### Example 7

```powershell
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
Publish-EsxiPasswordPolicy -server <sddc_manager_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 ESX hosts across all for a workload domain and compares the configuration against the policy configuration file.

### Example 8

```powershell
Publish-EsxiPasswordPolicy -server <fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name> -drift
Publish-EsxiPasswordPolicy -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -policy PasswordExpiration -workloadDomain <workload_domain_name> -drift
```

This example returns password expiration policy for all ESX hosts across all for a workload domain and compares the configuration against the product defaults.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,31 +32,31 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
### Example 1

```powershell
Publish-NsxEdgeAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -allDomains
Publish-NsxEdgeAccountLockout -server <sddc_manager_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 <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
Publish-NsxEdgeAccountLockout -server <sddc_manager_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 <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
Publish-NsxEdgeAccountLockout -server <sddc_manager_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 policy configuration file.

### Example 4

```powershell
Publish-NsxEdgeAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
Publish-NsxEdgeAccountLockout -server <sddc_manager_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
Original file line number Diff line number Diff line change
Expand Up @@ -32,31 +32,31 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
### Example 1

```powershell
Publish-NsxEdgePasswordComplexity -server <fqdn> -user <admin_username> -pass <admin_password> -allDomains
Publish-NsxEdgePasswordComplexity -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -allDomains
```

This example returns password complexity policy for each local user of NSX Edge nodes for all workload domains.

### Example 2

```powershell
Publish-NsxEdgePasswordComplexity -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
Publish-NsxEdgePasswordComplexity -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
```

This example returns password complexity policy for each local user of NSX Edge nodes for a workload domain.

### Example 3

```powershell
Publish-NsxEdgePasswordComplexity -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
Publish-NsxEdgePasswordComplexity -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
```

This example returns password complexity policy for each local user of NSX Edge nodes for a workload domain and compares the configuration against the policy configuration file.

### Example 4

```powershell
Publish-NsxEdgePasswordComplexity -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
Publish-NsxEdgePasswordComplexity -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
```

This example returns password complexity policy for each local user of NSX Edge nodes for a workload domain and compares the configuration against the product defaults.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,31 +32,31 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
### Example 1

```powershell
Publish-NsxEdgePasswordExpiration -server <fqdn> -user <admin_username> -pass <admin_password> -allDomains
Publish-NsxEdgePasswordExpiration -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -allDomains
```

This example returns password expiration policy for each local user of NSX Edge nodes for all workload domains.

### Example 2

```powershell
Publish-NsxEdgePasswordExpiration -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
Publish-NsxEdgePasswordExpiration -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
```

This example returns password expiration policy for each local user of NSX Edge nodes for a workload domain.

### Example 3

```powershell
Publish-NsxEdgePasswordExpiration -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
Publish-NsxEdgePasswordExpiration -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
```

This example returns password expiration policy for each local user of NSX Edge nodes for a workload domain and compares the configuration against the policy configuration file.

### Example 4

```powershell
Publish-NsxEdgePasswordExpiration -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
Publish-NsxEdgePasswordExpiration -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
```

This example returns password expiration policy for each local user of NSX Edge nodes for a workload domain and compares the configuration against the product defaults.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,31 +32,31 @@ The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` va
### Example 1

```powershell
Publish-NsxManagerAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -allDomains
Publish-NsxManagerAccountLockout -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -allDomains
```

This example returns account lockout policy for each NSX Local Manager for all workload domains.

### Example 2

```powershell
Publish-NsxManagerAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
Publish-NsxManagerAccountLockout -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name>
```

This example returns account lockout policy for each NSX Local Manager for a workload domain.

### Example 3

```powershell
Publish-NsxManagerAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift -reportPath <report_path> -policyFile <policy_file>.json
Publish-NsxManagerAccountLockout -server <sddc_manager_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 Local Manager for a workload domain and compares the configuration against the policy configuration file.

### Example 4

```powershell
Publish-NsxManagerAccountLockout -server <fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
Publish-NsxManagerAccountLockout -server <sddc_manager_fqdn> -user <admin_username> -pass <admin_password> -workloadDomain <workload_domain_name> -drift
```

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